Publication Guidelines

From DocWiki

Jump to: navigation, search
Important yellow.pngThis page is unchecked !!!

This DocWiki first describes a document management system that allows:

  • Multiple author support
  • Authors to document in a single, canonical form
  • Collaboration support
  • Mixing-and-matching of content from multiple pages and articles to re-purpose for different documents, and
  • Excellent version/revision control

Which then allows a publication system that supports:

  • Single source publishing: publish in multiple formats (HTML, PDF, doc, csv, RTF?),and
  • Separate theming of output products for different users, preferably using CSS.

Furthermore, all of this is to be done using set structures and templates and within the MIKE2.0 organizational framework. This will bring efficiency and consistency to the CIS documentation.

Contents

Basic Workflow

Workflow.png

Export as XHTML

To be provided.

Conversion of XHTML

The conversion script of the exported XHTML does a number of essential tasks:

  1. It removes any tables of content, if such exist
  2. It removes the [Edit] commands at section heads, if such exist
  3. It allows a new root URL to be determined, for use in the new target site
  4. It makes some clean up and corrections to image conversions
  5. It lists out images that may need to be separately uploaded to the new target site.

Further Info to be Organized

Mediawiki API

  • Clean XHTML can be generated directly from the Mediawiki API. This can be done directly via URL with the action=render command. For example:

Wikitext Converters

PHP

Others

Use of Mediawiki

HTML to DocBook

  • From http://wiki.docbook.org/topic/Html2DocBook:
    1. Convert all of your HTML to XHTML using Tidy. Enable 'enclose-block-text' in the configfile, else any unenclosed text (where this is allowed under XHTML Transitional but not under XHTML Strict) will vanish.
    2. Use the XSL stylesheet (below) to convert the XHTML into DocBook (There's no way to merge the multiple XHTML files into a single document, so the stylesheet converts each HTML page into a <section>). Be sure to pass in the filename (minus the extension) as a parameter. This will become the section id.
    3. Combine the multiple DocBook <section> files into a single file, and re-arrange the sections into the proper order
    4. Correct any validity errors. (At this point, there are likely to be a few, depending on how good the original HTML was.)
    5. Peruse the now valid DocBook document, and look for the following:
      • Broken links
      • <xref> elements that should be <link>s
      • Missing headers (the heading logic isn't perfect. You'll lose at most 1 header per page, though, and most pages come through with all headers intact.)
      • Overuse of <emphasis> and <emphasis role="bold">
    • also see XSLT example
  • http://code.google.com/p/gwtwiki/wiki/Mediawiki2Docbook

Stylesheets (CSS)

Retrieved from "http://docwiki.citizen-dan.org/index.php/Publication_Guidelines"
Personal tools