| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477 |
- # ============================================================================ #
- #
- # GENERATED PROPERTIES FILE FOR USE WITH THE DITA COMMAND
- #
- # Lines in this file that start with a number sign '#' are comments.
- #
- # To set a build parameter, remove the commenting '#' at the start of the line
- # and specify the value for the parameter after the '=' sign, for example,
- #
- # args.filter = my-filter.ditaval
- #
- # Use the `dita` command with the `--propertyfile` option to use the build
- # parameters specified in a properties file, for example:
- #
- # dita --input=my.ditamap --format=html5 --propertyfile=my.properties
- #
- # Build parameters in this file are grouped by transformation type.
- # Supported parameter values are listed in brackets [] after each description,
- # with an asterisk (*) indicating the default value where appropriate.
- #
- # ============================================================================ #
- # ============================================================================ #
- # COMMON
- # ============================================================================ #
- # args.draft = no
- # Specifies whether the content of <draft-comment> and
- # <required-cleanup> elements is included in the output.
- # [ no ]*
- # [ yes ]
- # args.figurelink.style = NUMBER
- # Specifies how cross references to figures are styled in
- # output.
- # [ NUMBER ]
- # [ NUMTITLE ]
- # [ TITLE ]
- # args.filter =
- # Specifies a filter file to be used to include, exclude, or
- # flag content.
- # args.gen.task.lbl = YES
- # Specifies whether to generate headings for sections within
- # task topics.
- # [ NO ]
- # [ YES ]
- # args.grammar.cache = yes
- # Specifies whether the grammar-caching feature of the XML
- # parser is used.
- # [ no ]
- # [ yes ]*
- # args.input.dir =
- # Specifies the base directory for your documentation project.
- # args.output.base =
- # Specifies the name of the output file without file
- # extension.
- # args.rellinks = none
- # Specifies which links to include in the output.
- # [ all ] - All links are included.
- # [ nofamily ] - Parent, child, next, and previous links are
- # not included.
- # [ none ] - No links are included.
- # [ noparent ] - Parent links are not included.
- # args.tablelink.style = NUMBER
- # Specifies how cross references to tables are styled.
- # [ NUMBER ]
- # [ NUMTITLE ]
- # [ TITLE ]
- # clean.temp = yes
- # Specifies whether DITA-OT deletes the files in the temporary
- # directory after it finishes a build.
- # [ no ]
- # [ yes ]*
- # conserve-memory = false
- # Conserve memory at the expense of processing speed
- # [ false ]*
- # [ true ]
- # default.language =
- # Specifies the default language for source documents.
- # dita.dir =
- # Specifies where DITA-OT is installed.
- # dita.temp.dir =
- # Specifies the location of the temporary directory.
- # filter-stage = early
- # Specifies whether filtering is done before all other
- # processing, or after key and conref processing.
- # [ early ]*
- # [ late ]
- # force-unique = false
- # Generate copy-to attributes to duplicate topicref elements.
- # [ false ]*
- # [ true ]
- # generate-debug-attributes = true
- # Specifies whether the @xtrf and @xtrc debugging attributes
- # are generated in the temporary files.
- # [ false ] - Disables generation of debugging attributes
- # [ true ]* - Enables generation of debugging attributes
- # generate.copy.outer = 1
- # Specifies whether to generate output files for content that
- # is not located in or beneath the directory containing the
- # DITA map file.
- # [ 1 ]* - Do not generate output for content that is located
- # outside the DITA map directory.
- # [ 3 ] - Shift the output directory so that it contains all
- # output for the publication.
- # link-crawl = topic
- # Specifies whether to crawl only those topic links found in
- # maps, or all discovered topic links.
- # [ map ]
- # [ topic ]*
- # onlytopic.in.map = false
- # Specifies whether files that are linked to, or referenced
- # with a @conref attribute, generate output.
- # [ false ]*
- # [ true ]
- # outer.control = warn
- # Specifies how DITA-OT handles content files that are not
- # located in or below the directory containing the master DITA
- # map.
- # [ fail ] - Fail quickly if files are going to be generated
- # or copied outside of the directory.
- # [ quiet ] - Quietly finish without generating warnings or
- # errors.
- # [ warn ]* - Complete the operation if files will be
- # generated or copied outside of the directory, but log a
- # warning.
- # output.dir =
- # Specifies the name and location of the output directory.
- # processing-mode = lax
- # Specifies how DITA-OT handles errors and error recovery.
- # [ lax ]* - When an error is encountered, DITA-OT attempts to
- # recover from it
- # [ skip ] - When an error is encountered, DITA-OT continues
- # processing but does not attempt error recovery
- # [ strict ] - When an error is encountered, DITA-OT stops
- # processing
- # remove-broken-links = false
- # Remove broken related links.
- # [ false ]*
- # [ true ]
- # root-chunk-override =
- # Override for map chunk attribute value.
- # validate = true
- # Specifies whether DITA-OT validates the content.
- # [ false ]
- # [ true ]*
- # ============================================================================ #
- # ECLIPSE HELP
- # ============================================================================ #
- # args.eclipse.provider = DITA
- # Specifies the name of the person or organization that
- # provides the Eclipse help. Default value: DITA.
- # args.eclipse.symbolic.name = org.sample.help.doc
- # Specifies the symbolic name (aka plugin ID) in the output
- # for an Eclipse Help project. Default value:
- # org.sample.help.doc.
- # args.eclipse.version = 0.0.0
- # Specifies the version number to include in the output.
- # Default value: 0.0.0.
- # args.eclipsehelp.country =
- # Specifies the region for the language that is specified by
- # the args.
- # args.eclipsehelp.jar.name =
- # Specifies that the output should be zipped and returned
- # using this name.
- # args.eclipsehelp.language =
- # Specifies the base language for translated content, such as
- # en for English.
- # ============================================================================ #
- # HTML-BASED OUTPUT
- # ============================================================================ #
- # args.artlbl = no
- # Specifies whether to generate a label for each image; the
- # label will contain the image file name.
- # [ no ]*
- # [ yes ]
- # args.copycss = no
- # Specifies whether to copy the custom .css file to the output
- # directory.
- # [ no ]*
- # [ yes ]
- # args.css =
- # Specifies the name of a custom .css file.
- # args.csspath =
- # Specifies the location of a copied .css file relative to the
- # output directory.
- # args.cssroot =
- # Specifies the directory that contains the custom .css file.
- # args.dita.locale =
- # Specifies the language locale file to use for sorting index
- # entries.
- # args.ftr =
- # Specifies an XML file that contains content for a running
- # footer.
- # args.gen.default.meta = no
- # Specifies whether to generate extra metadata that targets
- # parental control scanners, meta elements with
- # name="security" and name="Robots".
- # [ no ]*
- # [ yes ]
- # args.hdf =
- # Specifies an XML file that contains content to be placed in
- # the document head.
- # args.hdr =
- # Specifies an XML file that contains content for a running
- # header.
- # args.hide.parent.link = no
- # Specifies whether to hide links to parent topics in the HTML
- # or XHTML output.
- # [ no ]*
- # [ yes ]
- # args.indexshow = no
- # Specifies whether the content of <indexterm> elements are
- # rendered in the output.
- # [ no ]*
- # [ yes ]
- # args.outext = html
- # Specifies the file extension for HTML or XHTML output.
- # Default value: html.
- # args.xhtml.classattr = yes
- # Specifies whether to include the DITA class ancestry inside
- # the XHTML elements.
- # [ no ]
- # [ yes ]*
- # args.xsl =
- # Specifies a custom XSL file to be used instead of the
- # default XSL transformation.
- # ============================================================================ #
- # HTML5
- # ============================================================================ #
- # args.artlbl = no
- # Specifies whether to generate a label for each image; the
- # label will contain the image file name.
- # [ no ]*
- # [ yes ]
- # args.copycss = no
- # Specifies whether to copy the custom .css file to the output
- # directory.
- # [ no ]*
- # [ yes ]
- # args.css =
- # Specifies the name of a custom .css file.
- # args.csspath =
- # Specifies the location of a copied .css file relative to the
- # output directory.
- # args.cssroot =
- # Specifies the directory that contains the custom .css file.
- # args.dita.locale =
- # Specifies the language locale file to use for sorting index
- # entries.
- # args.ftr =
- # Specifies an XML file that contains content for a running
- # footer.
- # args.gen.default.meta = no
- # Specifies whether to generate extra metadata that targets
- # parental control scanners, meta elements with
- # name="security" and name="Robots".
- # [ no ]*
- # [ yes ]
- # args.hdf =
- # Specifies an XML file that contains content to be placed in
- # the document head.
- # args.hdr =
- # Specifies an XML file that contains content for a running
- # header.
- # args.hide.parent.link = no
- # Specifies whether to hide links to parent topics in the
- # HTML5 output.
- # [ no ]*
- # [ yes ]
- # args.html5.classattr = yes
- # Specifies whether to include the DITA class ancestry inside
- # the HTML5 elements.
- # [ no ]
- # [ yes ]*
- # args.html5.contenttarget = contentwin
- # Specifies the value of the @target attribute on the <base>
- # element in the TOC file. Default value: contentwin.
- # args.html5.toc = index
- # Specifies the base name of the TOC file. Default value:
- # index.
- # args.html5.toc.class =
- # Specifies the value of the @class attribute on the <body>
- # element in the TOC file.
- # args.html5.toc.xsl =
- # Specifies a custom XSL file to be used for TOC generation.
- # args.indexshow = no
- # Specifies whether the content of <indexterm> elements are
- # rendered in the output.
- # [ no ]*
- # [ yes ]
- # args.outext = html
- # Specifies the file extension for HTML5 output. Default
- # value: html.
- # args.xsl =
- # Specifies a custom XSL file to be used instead of the
- # default XSL transformation.
- # nav-toc = none
- # Specifies whether to generate a navigation TOC in topic
- # pages.
- # [ full ] - Full TOC
- # [ none ]* - No TOC
- # [ partial ] - Partial TOC that shows the current topic
- # ============================================================================ #
- # MICROSOFT COMPILED HTML HELP
- # ============================================================================ #
- # args.htmlhelp.includefile =
- # Specifies the name of a file that you want included in the
- # HTML Help.
- # ============================================================================ #
- # PDF
- # ============================================================================ #
- # args.artlbl = no
- # Specifies whether to generate a label for each image; the
- # label will contain the image file name.
- # [ no ]*
- # [ yes ]
- # args.bookmap-order = discard
- # Specifies if the frontmatter and backmatter content order is
- # retained in bookmap.
- # [ discard ]*
- # [ retain ]
- # args.bookmark.style = EXPANDED
- # Specifies whether PDF bookmarks are by default expanded or
- # collapsed.
- # [ COLLAPSE ]
- # [ EXPANDED ]
- # args.chapter.layout = MINITOC
- # Specifies whether chapter level TOCs are generated.
- # [ BASIC ]
- # [ MINITOC ]*
- # args.fo.userconfig =
- # Specifies the user configuration file for FOP.
- # args.xsl.pdf =
- # Specifies an XSL file that is used to override the default
- # XSL transformation.
- # axf.cmd =
- # Specifies the path to the Antenna House Formatter
- # executable.
- # axf.opt =
- # Specifies the user configuration file for Antenna House
- # Formatter.
- # custom.xep.config =
- # Specifies the user configuration file for RenderX.
- # customization.dir =
- # Specifies the customization directory.
- # maxJavaMemory =
- # Specifies the amount of memory allocated to the RenderX
- # process.
- # org.dita.pdf2.chunk.enabled = false
- # Enables chunk attribute processing.
- # [ false ]* - Disables chunk processing
- # [ true ] - Enables chunk processing
- # org.dita.pdf2.i18n.enabled = true
- # Enables I18N font processing.
- # [ false ] - Disables I18N processing
- # [ true ]* - Enables I18N processing
- # outputFile.base =
- # Specifies the base file name of the generated PDF file.
- # pdf.formatter = fop
- # Specifies the XSL processor.
- # [ ah ] - Antenna House Formatter
- # [ fop ]* - Apache FOP
- # [ xep ] - RenderX XEP Engine
- # publish.required.cleanup = yes
- # Specifies whether draft-comment and required-cleanup
- # elements are included in the output.
- # [ no ]
- # [ yes ]
- # ============================================================================ #
- # XHTML
- # ============================================================================ #
- # args.xhtml.contenttarget = contentwin
- # Specifies the value of the @target attribute on the <base>
- # element in the TOC file. Default value: contentwin.
- # args.xhtml.toc = index
- # Specifies the base name of the TOC file. Default value:
- # index.
- # args.xhtml.toc.class =
- # Specifies the value of the @class attribute on the <body>
- # element in the TOC file.
- # args.xhtml.toc.xsl =
- # Specifies a custom XSL file to be used for TOC generation.
|