Converting to DocBook XML

From The_Open_Source_Way

Revision as of 00:20, 1 February 2010 by Quaid (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is the procedure we follow when converting content from the wiki in to the DocBook XML, Publican-based guide in git.

  1. Go to each chapter's wiki page.
  2. Use the 'history' tab to bring up the changelog list for the page.
  3. Select the previous conversion point and the last change as the two boundaries for viewing a diff of the changes.
  4. Edit the changes revealed by the diff in to the XML.
    • Note where the XML uses a different construct in how information is structured; some wiki tricks (using separate sections) doesn't translate as well to XML.
    • If mistakes in the wiki are noticed, commit the fix to the wiki at the same time, noting in both changelogs that the fix is in both locations.
  5. Test the build, fix any XML errors.
  6. Commit changes to git, noting the updates come from the upstream wiki.
  7. Build HTML (chunked and single page) and PDF; upload new versions to canonical location
Personal tools