Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

PDF and DOCX generation configuration



Specific command-line and configuration properties allow to configure the way the pdf or docx generation is performed.

Command line properties

  • "fileName": the name of the file to generate. The file will be generated in the output directory. Note that if the "docFile" property is defined, the "fileName" property will not be used
  • "docFile": the path of the file to generate
  • "tocLevel": the maximum level of the table of contents (default is 2)
  • "defaultChapter": the name of the default chapter, used for articles which belong in no category. The default name is the localized content for miscellanous
  • "hasGlossary": true if the glossary should be generated, if there is one in the wiki (default is true)
  • "chaptersContent": the path of the XML file defining the Document content. By default a default content will be generated

Specific DOCX Command line properties

  • "hasTOC": true if there is a table of contents (default is true)
  • "title": the title of the document. The default title is "Wiki"
  • "author": the author of the document. The default is "author"
  • "nominalFontSize": the font size for the regular text
  • "treeAsList": true if trees are presented as lists (default is true)
  • "docxTemplate": the template to use for creating the DOCX document. If you don't specify it, a default DOCX template will be used
  • "docxTemplateProperties": the headings names to use for the titles in the DOCX document. You may have to set them if you have specified a specific docxTemplate
Note that if you define some of these properties in the command-line, they will be parsed only if you define them after specifying the docx output type. For example, this will not work:
      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -hasTOC=false -outputType=docx
But this will work:
      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -outputType=docx -hasTOC=false

treeAsList property

If the treeAsList property is set to false, the docx generation will show tree items in boxes. By default they will be shown as lists.

For the moment, when tree items are shown as boxes, the positions of the boxes are not always correct.

Configuration properties

The properties have the same names as for the Command line, but without the leading "-". For example: "tocLevel", "docFile", etc...

For example:
   docxTemplate=templateCustom.docx
   hasTOC=false

See also


Categories: configuration | docx | pdf

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.