internal-ant-properties.dita 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <reference id="ant-properties">
  5. <title>Internal Ant properties</title>
  6. <shortdesc>Reference list of Ant properties used by DITA-OT internally.</shortdesc>
  7. <prolog>
  8. <metadata>
  9. <keywords>
  10. <indexterm><xmlatt>role</xmlatt></indexterm>
  11. <indexterm>args.rellinks</indexterm>
  12. <indexterm>PDF<indexterm>related links</indexterm><indexterm>args.rellinks</indexterm></indexterm>
  13. <indexterm>HTML5<indexterm>related links</indexterm><indexterm>args.rellinks</indexterm></indexterm>
  14. </keywords>
  15. </metadata>
  16. </prolog>
  17. <refbody>
  18. <section>
  19. <parml>
  20. <plentry>
  21. <pt><codeph>include.rellinks</codeph></pt>
  22. <pd>A space-separated list of link roles to be output; the <codeph>#default</codeph> value token represents
  23. links without an explicit role (those for which no <xmlatt>role</xmlatt> attribute is defined). Defined by
  24. <codeph>args.rellinks</codeph>, but may be overridden directly. Valid roles include: <ul>
  25. <li>parent </li>
  26. <li>child </li>
  27. <li>sibling </li>
  28. <li>friend </li>
  29. <li>next </li>
  30. <li>previous </li>
  31. <li>cousin </li>
  32. <li>ancestor </li>
  33. <li>descendant </li>
  34. <li>sample </li>
  35. <li>external </li>
  36. <li>other</li>
  37. </ul></pd>
  38. </plentry>
  39. <plentry>
  40. <pt><codeph>temp.output.dir.name</codeph></pt>
  41. <pd>An internal property for use with custom transform types; this property can be used to place all output
  42. in an internal directory, so that a final step in the transform type can do some form of post-processing
  43. before the files are placed in the specified output directory.
  44. <p>For example, if a custom HTML5 transform sets the property to <codeph>zip_dir</codeph>, all output
  45. files (including HTML, images, and CSS) will be placed within the directory <filepath>zip_dir</filepath>
  46. in the temporary processing directory. A final step can then be used to add more files, zip the directory,
  47. and return that zip to the designated output directory.</p></pd>
  48. </plentry>
  49. </parml>
  50. </section>
  51. </refbody>
  52. </reference>