template.properties 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494
  1. # ============================================================================ #
  2. #
  3. # GENERATED PROPERTIES FILE FOR USE WITH THE DITA COMMAND
  4. #
  5. # Lines in this file that start with a number sign '#' are comments.
  6. #
  7. # To set a build parameter, remove the commenting '#' at the start of the line
  8. # and specify the value for the parameter after the '=' sign, for example,
  9. #
  10. # args.filter = my-filter.ditaval
  11. #
  12. # Use the `dita` command with the `--propertyfile` option to use the build
  13. # parameters specified in a properties file, for example:
  14. #
  15. # dita --input=my.ditamap --format=html5 --propertyfile=my.properties
  16. #
  17. # Build parameters in this file are grouped by transformation type.
  18. # Supported parameter values are listed in brackets [] after each description,
  19. # with an asterisk (*) indicating the default value where appropriate.
  20. #
  21. # ============================================================================ #
  22. # ============================================================================ #
  23. # COMMON
  24. # ============================================================================ #
  25. # args.draft = no
  26. # Specifies whether the content of <draft-comment> and
  27. # <required-cleanup> elements is included in the output.
  28. # [ no ]*
  29. # [ yes ]
  30. # args.figurelink.style = NUMBER
  31. # Specifies how cross references to figures are styled in
  32. # output.
  33. # [ NUMBER ]
  34. # [ NUMTITLE ]
  35. # [ TITLE ]
  36. # args.filter =
  37. # Specifies a filter file to be used to include, exclude, or
  38. # flag content.
  39. # args.gen.task.lbl = YES
  40. # Specifies whether to generate headings for sections within
  41. # task topics.
  42. # [ NO ]
  43. # [ YES ]
  44. # args.grammar.cache = yes
  45. # Specifies whether the grammar-caching feature of the XML
  46. # parser is used.
  47. # [ no ]
  48. # [ yes ]*
  49. # args.input.dir =
  50. # Specifies the base directory for your documentation project.
  51. # args.output.base =
  52. # Specifies the name of the output file without file
  53. # extension.
  54. # args.rellinks = none
  55. # Specifies which links to include in the output.
  56. # [ all ] - All links are included.
  57. # [ nofamily ] - Parent, child, next, and previous links are
  58. # not included.
  59. # [ none ] - No links are included.
  60. # [ noparent ] - Parent links are not included.
  61. # args.resources =
  62. # Specifies resource files.
  63. # args.tablelink.style = NUMBER
  64. # Specifies how cross references to tables are styled.
  65. # [ NUMBER ]
  66. # [ NUMTITLE ]
  67. # [ TITLE ]
  68. # clean.temp = yes
  69. # Specifies whether DITA-OT deletes the files in the temporary
  70. # directory after it finishes a build.
  71. # [ no ]
  72. # [ yes ]*
  73. # conserve-memory = false
  74. # Conserve memory at the expense of processing speed.
  75. # [ false ]*
  76. # [ true ]
  77. # default.language =
  78. # Specifies the default language for source documents.
  79. # dita.dir =
  80. # Specifies where DITA-OT is installed.
  81. # dita.temp.dir =
  82. # Specifies the location of the temporary directory.
  83. # filter-stage = early
  84. # Specifies whether filtering is done before all other
  85. # processing, or after key and conref processing.
  86. # [ early ]*
  87. # [ late ]
  88. # force-unique = false
  89. # Generate copy-to attributes to duplicate topicref elements.
  90. # [ false ]*
  91. # [ true ]
  92. # generate-debug-attributes = true
  93. # Specifies whether the @xtrf and @xtrc debugging attributes
  94. # are generated in the temporary files.
  95. # [ false ] - Disables generation of debugging attributes
  96. # [ true ]* - Enables generation of debugging attributes
  97. # generate.copy.outer = 1
  98. # Adjust how output is generated for content that is located
  99. # outside the directory containing the DITA map.
  100. # [ 1 ]* - Do not generate output for content that is located
  101. # outside the DITA map directory.
  102. # [ 3 ] - Shift the output directory so that it contains all
  103. # output for the publication.
  104. # link-crawl = topic
  105. # Specifies whether to crawl only those topic links found in
  106. # maps, or all discovered topic links.
  107. # [ map ]
  108. # [ topic ]*
  109. # onlytopic.in.map = false
  110. # Specifies whether files that are linked to, or referenced
  111. # with a @conref attribute, generate output.
  112. # [ false ]*
  113. # [ true ]
  114. # outer.control = warn
  115. # Specifies whether to warn or fail if content is located
  116. # outside the directory containing the DITA map.
  117. # [ fail ] - Fail quickly if files are going to be generated
  118. # or copied outside of the directory.
  119. # [ quiet ] - Quietly finish without generating warnings or
  120. # errors.
  121. # [ warn ]* - Complete the operation if files will be
  122. # generated or copied outside of the directory, but log a
  123. # warning.
  124. # output.dir =
  125. # Specifies the name and location of the output directory.
  126. # processing-mode = lax
  127. # Specifies how DITA-OT handles errors and error recovery.
  128. # [ lax ]* - When an error is encountered, DITA-OT attempts to
  129. # recover from it
  130. # [ skip ] - When an error is encountered, DITA-OT continues
  131. # processing but does not attempt error recovery
  132. # [ strict ] - When an error is encountered, DITA-OT stops
  133. # processing
  134. # remove-broken-links = false
  135. # Remove broken related links.
  136. # [ false ]*
  137. # [ true ]
  138. # result.rewrite-rule.class =
  139. # Specifies the name of the Java class used to rewrite
  140. # filenames.
  141. # result.rewrite-rule.xsl =
  142. # Specifies the name of the XSLT file used to rewrite
  143. # filenames.
  144. # root-chunk-override =
  145. # Override for map chunk attribute value.
  146. # validate = true
  147. # Specifies whether DITA-OT validates the content.
  148. # [ false ]
  149. # [ true ]*
  150. # ============================================================================ #
  151. # ECLIPSE HELP
  152. # ============================================================================ #
  153. # args.eclipse.provider = DITA
  154. # Specifies the name of the person or organization that
  155. # provides the Eclipse help. Default value: DITA.
  156. # args.eclipse.symbolic.name = org.sample.help.doc
  157. # Specifies the symbolic name (aka plugin ID) in the output
  158. # for an Eclipse Help project. Default value:
  159. # org.sample.help.doc.
  160. # args.eclipse.version = 0.0.0
  161. # Specifies the version number to include in the output.
  162. # Default value: 0.0.0.
  163. # args.eclipsehelp.country =
  164. # Specifies the region for the language that is specified by
  165. # the args.
  166. # args.eclipsehelp.jar.name =
  167. # Specifies that the output should be zipped and returned
  168. # using this name.
  169. # args.eclipsehelp.language =
  170. # Specifies the base language for translated content, such as
  171. # en for English.
  172. # ============================================================================ #
  173. # HTML-BASED OUTPUT
  174. # ============================================================================ #
  175. # args.artlbl = no
  176. # Specifies whether to generate a label for each image; the
  177. # label will contain the image file name.
  178. # [ no ]*
  179. # [ yes ]
  180. # args.copycss = no
  181. # Specifies whether to copy the custom .css file to the output
  182. # directory.
  183. # [ no ]*
  184. # [ yes ]
  185. # args.css =
  186. # Specifies the name of a custom .css file.
  187. # args.csspath =
  188. # Specifies the location of a copied .css file relative to the
  189. # output directory.
  190. # args.cssroot =
  191. # Specifies the directory that contains the custom .css file.
  192. # args.dita.locale =
  193. # Specifies the language locale file to use for sorting index
  194. # entries.
  195. # args.ftr =
  196. # Specifies an XML file that contains content for a running
  197. # footer.
  198. # args.gen.default.meta = no
  199. # Generate metadata for parental control scanners, meta
  200. # elements with name="security" and name="Robots".
  201. # [ no ]*
  202. # [ yes ]
  203. # args.hdf =
  204. # Specifies an XML file that contains content to be placed in
  205. # the document head.
  206. # args.hdr =
  207. # Specifies an XML file that contains content for a running
  208. # header.
  209. # args.hide.parent.link = no
  210. # Specifies whether to hide links to parent topics in the HTML
  211. # or XHTML output.
  212. # [ no ]*
  213. # [ yes ]
  214. # args.indexshow = no
  215. # Specifies whether the content of <indexterm> elements are
  216. # rendered in the output.
  217. # [ no ]*
  218. # [ yes ]
  219. # args.outext = html
  220. # Specifies the file extension for HTML or XHTML output.
  221. # Default value: html.
  222. # args.xhtml.classattr = yes
  223. # Specifies whether to include the DITA class ancestry inside
  224. # the XHTML elements.
  225. # [ no ]
  226. # [ yes ]*
  227. # args.xsl =
  228. # Specifies a custom XSL file to be used instead of the
  229. # default XSL transformation.
  230. # ============================================================================ #
  231. # HTML5
  232. # ============================================================================ #
  233. # args.artlbl = no
  234. # Specifies whether to generate a label for each image; the
  235. # label will contain the image file name.
  236. # [ no ]*
  237. # [ yes ]
  238. # args.copycss = no
  239. # Specifies whether to copy the custom .css file to the output
  240. # directory.
  241. # [ no ]*
  242. # [ yes ]
  243. # args.css =
  244. # Specifies the name of a custom .css file.
  245. # args.csspath =
  246. # Specifies the location of a copied .css file relative to the
  247. # output directory.
  248. # args.cssroot =
  249. # Specifies the directory that contains the custom .css file.
  250. # args.dita.locale =
  251. # Specifies the language locale file to use for sorting index
  252. # entries.
  253. # args.ftr =
  254. # Specifies an XML file that contains content for a running
  255. # footer.
  256. # args.gen.default.meta = no
  257. # Generate metadata for parental control scanners, meta
  258. # elements with name="security" and name="Robots".
  259. # [ no ]*
  260. # [ yes ]
  261. # args.hdf =
  262. # Specifies an XML file that contains content to be placed in
  263. # the document head.
  264. # args.hdr =
  265. # Specifies an XML file that contains content for a running
  266. # header.
  267. # args.hide.parent.link = no
  268. # Specifies whether to hide links to parent topics in the
  269. # HTML5 output.
  270. # [ no ]*
  271. # [ yes ]
  272. # args.html5.classattr = yes
  273. # Specifies whether to include the DITA class ancestry inside
  274. # the HTML5 elements.
  275. # [ no ]
  276. # [ yes ]*
  277. # args.html5.contenttarget = contentwin
  278. # Specifies the value of the @target attribute on the <base>
  279. # element in the TOC file. Default value: contentwin.
  280. # args.html5.toc = index
  281. # Specifies the base name of the TOC file. Default value:
  282. # index.
  283. # args.html5.toc.class =
  284. # Specifies the value of the @class attribute on the <body>
  285. # element in the TOC file.
  286. # args.html5.toc.xsl =
  287. # Specifies a custom XSL file to be used for TOC generation.
  288. # args.indexshow = no
  289. # Specifies whether the content of <indexterm> elements are
  290. # rendered in the output.
  291. # [ no ]*
  292. # [ yes ]
  293. # args.outext = html
  294. # Specifies the file extension for HTML5 output. Default
  295. # value: html.
  296. # args.xsl =
  297. # Specifies a custom XSL file to be used instead of the
  298. # default XSL transformation.
  299. # html5.toc.generate = yes
  300. # Generate TOC file from the DITA map.
  301. # [ no ]
  302. # [ yes ]*
  303. # nav-toc = none
  304. # Specifies whether to generate a navigation TOC in topic
  305. # pages.
  306. # [ full ] - Full TOC
  307. # [ none ]* - No TOC
  308. # [ partial ] - Partial TOC that shows the current topic
  309. # ============================================================================ #
  310. # MICROSOFT COMPILED HTML HELP
  311. # ============================================================================ #
  312. # args.htmlhelp.includefile =
  313. # Specifies the name of a file that you want included in the
  314. # HTML Help.
  315. # ============================================================================ #
  316. # PDF
  317. # ============================================================================ #
  318. # args.artlbl = no
  319. # Specifies whether to generate a label for each image; the
  320. # label will contain the image file name.
  321. # [ no ]*
  322. # [ yes ]
  323. # args.bookmap-order = discard
  324. # Specifies if the frontmatter and backmatter content order is
  325. # retained in bookmap.
  326. # [ discard ]*
  327. # [ retain ]
  328. # args.bookmark.style = EXPANDED
  329. # Specifies whether PDF bookmarks are by default expanded or
  330. # collapsed.
  331. # [ COLLAPSE ]
  332. # [ EXPANDED ]
  333. # args.chapter.layout = MINITOC
  334. # Specifies whether chapter level TOCs are generated.
  335. # [ BASIC ]
  336. # [ MINITOC ]*
  337. # args.fo.userconfig =
  338. # Specifies the user configuration file for FOP.
  339. # args.xsl.pdf =
  340. # Specifies an XSL file that is used to override the default
  341. # XSL transformation.
  342. # axf.cmd =
  343. # Specifies the path to the Antenna House Formatter
  344. # executable.
  345. # axf.opt =
  346. # Specifies the user configuration file for Antenna House
  347. # Formatter.
  348. # custom.xep.config =
  349. # Specifies the user configuration file for RenderX.
  350. # customization.dir =
  351. # Specifies the customization directory.
  352. # maxJavaMemory =
  353. # Specifies the amount of memory allocated to the RenderX
  354. # process.
  355. # org.dita.pdf2.chunk.enabled = false
  356. # Enables chunk attribute processing.
  357. # [ false ]* - Disables chunk processing
  358. # [ true ] - Enables chunk processing
  359. # org.dita.pdf2.i18n.enabled = true
  360. # Enables I18N font processing.
  361. # [ false ] - Disables I18N processing
  362. # [ true ]* - Enables I18N processing
  363. # outputFile.base =
  364. # Specifies the base file name of the generated PDF file.
  365. # pdf.formatter = fop
  366. # Specifies the XSL processor.
  367. # [ ah ] - Antenna House Formatter
  368. # [ fop ]* - Apache FOP
  369. # [ xep ] - RenderX XEP Engine
  370. # pdf2.index.skip = no
  371. # Disable built-in index processing.
  372. # [ no ]*
  373. # [ yes ]
  374. # publish.required.cleanup = yes
  375. # Specifies whether draft-comment and required-cleanup
  376. # elements are included in the output.
  377. # [ no ]
  378. # [ yes ]
  379. # ============================================================================ #
  380. # XHTML
  381. # ============================================================================ #
  382. # args.xhtml.contenttarget = contentwin
  383. # Specifies the value of the @target attribute on the <base>
  384. # element in the TOC file. Default value: contentwin.
  385. # args.xhtml.toc = index
  386. # Specifies the base name of the TOC file. Default value:
  387. # index.
  388. # args.xhtml.toc.class =
  389. # Specifies the value of the @class attribute on the <body>
  390. # element in the TOC file.
  391. # args.xhtml.toc.xsl =
  392. # Specifies a custom XSL file to be used for TOC generation.