51
edits
Changes
Jump to navigation
Jump to search
My current work is putting together a programmatic solution for transforming the current XML interface files into a base DITA document set of partially filled topics for every context command.
Release of the full(ish) command set, with HTML5, PDF, and Normalized DITA products
There are many other transformations available, and it is possible to create new ones.
== A Full Command Set ==
=== Dita Sources ===
A full DITA rendering of the ConTeXt command interface is available here:
https://github.com/pmazaitis/context_command_reference
...generated by a fairly scary Python script from the command interface files distributed with ConTeXt.
This documentation set builds cleanly into HTML5, PDF, and Normalized DITA.
There are caveats!
This documentation set badly needs to be edited; there are places in spot-checking the commands where the script made wildly incorrect interpretations of the interface.
It turns out that chains of inheritance play badly; all of the inheritance in this documentation set has been flattened. (For example, instead of a command inheriting settings from `\blank` which in turn inherits from `\vspacing`, the command inherits from `\vspacing`.)
There are some quirks! For example commands were listed as inheriting options (single keywords) from `\setuppapersize`, but `\setuppapersize` only had settings (key/value pairs). I did the best I could to untangle those.
=== Output Products ===
I've prepared three formats for the entire command set: HTML, PDF, and Normalized Dita.
The HTML5 version is hosted here:
https://paul.mazaitis.org/ctx_comref/full-html5/index.html
...for interactive exploration.
The PDF (XSL-FO version is here:
https://paul.mazaitis.org/ctx_comref/full-pdf/context_command_reference.pdf
...and it's worth noting that this behemoth requires upping the Java memory limit to 3GB (!) to finish compiling, and the resulting output is function, but could be more pleasant.
Which brings us to the Normalized DITA:
https://paul.mazaitis.org/ctx_comref/full-normalized_dita.zip
...presented as a zip file (to browse though a smaller example, the prototype is still available online).
This one is interesting to me, in that it might be useful as a basis for inclusion and formatting in both ConTeXt documents (through the XML interface) and/or the Wiki (if current methods could be adopted.
=== Much Yet to Do ===
The documentation still needs to be completed and edited, etc., but I think this could be a viable way to systematically document more of the interface's depth and detail.
== Pros and Cons ==
== Current Work: Transforming the Current Interface Files ==
Working out a way to manage ''variants'' in the documentation set.
== Future Work ==
