# readme - XmlDocuGeneration

Inhalt

Topic:.readme_DocuGenerationViaXML.

pStyle=std tableStyle=stdTable

What contains DocuGenerationViaXml

A generation of documentation using XML may have sources from XML-given data, at example from UML (using XMI). But source may be codes of programming languages of other textual documents too. The possibility of selecting and mixing contents from all these sources suitably may be important.

The documentation generation which is presented here is described (in german language) in www.vishia.org/XmlDocu. The principles are:

- A textual given control file which controls the sources and the content of documentation is given. The example here is `docuSrc/_Zbnf_en.docuGctr.bat` This is a batch file (Windows) and a control file too.

- The control file will be parsed via Zbnf2XML, a temporary `.../tmp/_Zbnf_en.docuGctr.bat.xml` is created after parsing. The syntax therefore is given in `zbnfjax/XmlDocu_xsl/DocuGenCtrl.zbnf`.

- The control file is transformed via XSLT. The result files are:

- `.../tmp/_antcmdDocuGctr.xml`: A control file for ANT. The XSLT-Script to produce it is given in `zbnfjax/XmlDocu_xsl/DocuGenCtrl2Ant.xslp`.

- `ZbnfMain_en.genctrl.xsl;;: A XSLT-file to build the document from XSL-Sources. The XSLT-Script to produce it is given in` zbnfjax/XmlDocu_xsl/DocuGenCtrl2Xsl.xslp`.`

- Note: The extension `.xslp` denotes an enhancement of XSL, see Preprozessor_XSLP.

- Note: The `...tmp/`-directory will be created for this example in a parallel dir to the root ZBNF from this download. It is parametrized in the `docuSrc/_Zbnf_en.docuGctr.bat`.

Than ANT will be started. At result of the content in the docu-generation-control-file some XML-preparations may be done. In this example a conversion of text topics to XML is called, see TextTopics.

This example contains the generation of the documentation for ZBNF in this download. The example is used immediately for the www.vishia.org-Page.

Parts of the documentation here are written in pure text files with qualifications of text parts adequate to the writing style in wikipedia. The format is described in WikiFormat. An advantage of this is: The texts are better comparable in versions. Another advantage: Writing is faster (for me, ... I won't use the mouse sometimes). A simple application of DocuGenerationViaXML converts such plain texts in HTML.

Another possible output is word.xml for Windows-Word. See file `zbnfjax/XmlDocu_xsl/Pre2Word.xsl`.