I’d written the API documentation for the BT Library in DocBook. This was in 2004, so it seemed a good choice at the time. Now, it seems less good. I decided I wanted to use a more lightweight documentation format. There’s plenty to choose from. However, after (very little) diligent research, I choose to move to AsciiDoc.

Migration Path

  1. Converted DocBook to AsciiDoc using pandoc:

    pandoc -wrap=none -f docbook -t asciidoc bt.xml >btlib.adoc

    This handled the bulk of the conversion, but it’s not perfect.

  2. Wrote an awk script to fix the API function call specifications. See below.

  3. Another list item.