wiki2doc
Generates HTML formated document from a wiki formatted document, including metavariables, to create a wiki website.
wiki2doc [-html|-xml|-pdf] [-toc] [-navbar] [-o outputfile] inputfile
This command interprets a wiki formatted document and converts it to HTML, XML, or a PDF [not supported yet] document. Metavariables are used to provide title, page hierarchy, and special functions for generating content, e.g. table of contents, importing content, etc.
By default, the outputfile will be the same filename as the inputfile except with the .html extension instead of .wiki.
If the file wiki2doc.ini is present in the same folder as the inputfile, it will be read to provide defaults, such as home page, index page, navigatin bar enablement, etc. (see INI Properties below).
Option |
Description |
-html |
Generate HTML output; replace the .wiki file extension with .html. All links will reference the title with a .html extension. |
-xml |
Generate XML output; replace the .wiki file extension with .xml. Note that the XML generated here is by the Document class in the MAE ecosystem. |
Not implemented yet. Generate PDF output; replace the .wiki file extension with .pdf. All links will reference the title with a .pdf extension. | |
-toc |
Add a table of contents at the top of the document. The table of contents is constructed from all the headers in the content of the file. |
-navbar |
Add a navigation bar at the top of the document. It will include the home page (if defined in INI Properties), the index page (if defined in INI Properties), and the hierarchy of pages that lead down to this page. Page hierarchy is specified via ${parent title} metavariables in this wiki document and each parent wiki document, in succession. |
-o outputfile |
Instead of outputting to inputfile.html, output will instead be redirected to outputfile. |
inputfile |
This is the .wiki file that is read and converted. The content is expected to be in wiki format. |
If a wiki2doc.ini file is present in the current directory, it is read for configuration properties:
Property |
Value |
homepage |
Specifies the title of the home page. If non provided, a Home link is not listed in the Navigation Bar. |
indexpage |
Specifies the title of the index page. If non provided, an Index link is not listed in the Navigation Bar. |
navbar |
True or False. Specifies whether a document should include a navigation bar at the top or not. See -navbar, above. |