51
edits
Changes
Jump to navigation
Jump to search
=== Dita Sources ===At the moment, the distribution supports three maps of command topics:
A * The full DITA rendering of the ConTeXt command interface is tracked here:set* User-facing commands* System commands
https://github.com/pmazaitis/context_command_reference..each drawing on the same pool of command topics to build the final product.
These files are generated by a Python script from the Maps could also be made to support command interface files distributed with ConTeXtglossaries for manuals, etc. The Script is available here:
https://github.com/pmazaitis/context-interface2dita
...with a noted lack ==== Keeping Track of documentation as of yet.What Needs To Be Worked On ====
Reorganization of feature list, features added
https://github.com/pmazaitis/context_command_reference_prototype
This is meant to be a small scale, easily digestible prototype to show how DITA might be used to develop a comprehensive documentation set.
=== Output Products ===
From the hand-built prototype, The DITA Open Toolkit (dita-ot) can generate lots of different formats out of the box, and use plugins for others. Here are some examples, all generated from the above DITA document set.
==== HTML5 ====
`dita-ot` can generate an HTML version of the documentation set:
`dita --input=context_command_reference.ditamap --format=html5`
...as hosted here:
https://paul.mazaitis.org/ctx_comref/prototype-html5/
This is without any CSS, etc. - just the structure.
==== XSL-FO PDF ====
`dita-ot` can generate an XSL-FO version of the documentation set:
dita --input=context_command_reference.ditamap --format=pdf
...as hosted here:
https://paul.mazaitis.org/ctx_comref/prototype-pdf/context_command_reference.pdf
This is pretty straightforward FO. (I imagine ConTeXt could do a nicer job...)
==== Normalized XML ====
`dita-ot` can generate a normalized version of the documentation set:
dita --input=context_command_reference.ditamap --format=dita
...as available here:
https://paul.mazaitis.org/ctx_comref/prototype-normalized-topics/
This transformation does all of the processing work on individual topics (coping content, resolving lints, etc.) but keeps the content as XML files for further processing.
==== Web Help ====
I also use the Oxygen XML Editor, which comes with several other transformations. One transformation of the documentation set that might be interesting as an example of what is possible is their Web Help implementation, hosted here:
https://paul.mazaitis.org/ctx_comref/prototype-webhelp-responsive/
==== Other Available Transformations ====
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 tracked here:
https://github.com/pmazaitis/context_command_reference
These files are generated by a Python script from the command interface files distributed with ConTeXt. The Script is available here:
https://github.com/pmazaitis/context-interface2dita
...with a noted lack of documentation as of yet.
This documentation set is tested to build to PDF, HTML5 and Normalized DITA.
=== Topic Level Features ===
This is a simple two column table that describes commands (column one) and the commands related to that command (column two).
== Output Products == From the hand-built prototype, The DITA Open Toolkit (dita-ot) can generate lots of different formats out of the box, and use plugins Multiple Maps for others. Here are some examples, all generated from the above DITA document set. === HTML5 === `dita-ot` can generate an HTML version of the documentation set: `dita --input=context_command_reference.ditamap --format=html5` ...as hosted here: https://paul.mazaitis.org/ctx_comref/prototype-html5/ This is without any CSS, etc. - just the structure. === XSL-FO PDF === `dita-ot` can generate an XSL-FO version of the documentation set: dita --input=context_command_reference.ditamap --format=pdf ...as hosted here: https://paul.mazaitis.org/ctx_comref/prototype-pdf/context_command_reference.pdf This is pretty straightforward FO. (I imagine ConTeXt could do a nicer job...) === Normalized XML === `dita-ot` can generate a normalized version of the documentation set: dita --input=context_command_reference.ditamap --format=dita ...as available here: https://paul.mazaitis.org/ctx_comref/prototype-normalized-topics/ This transformation does all of the processing work on individual topics (coping content, resolving lints, etc.) but keeps the content as XML files for further processing. === Web Help === I also use the Oxygen XML Editor, which comes with several other transformations. One transformation of the documentation set that might be interesting as an example of what is possible is their Web Help implementation, hosted here: https://paul.mazaitis.org/ctx_comref/prototype-webhelp-responsive/ === Other Available Transformations === There are many other transformations available, and it is possible to create new ones. Multiple Products == A Full Command Set ==
Several elements in the topics now have the `rev` attribute. This documentation can be used to keep track of what elements in the command set is tested to build to PDF, HTML5 and Normalized DITAare still boilerplate by incrementing the attribute value after edit.
=== Output Products ===
