internal-ant-properties.dita 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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. <refbody>
  8. <section>
  9. <parml>
  10. <plentry>
  11. <pt><codeph>include.rellinks</codeph></pt>
  12. <pd>A space-separated list of link roles to be output; the <codeph>#default</codeph> value token represents
  13. links without an explicit role (those for which no <xmlatt>role</xmlatt> attribute is defined). Defined by
  14. <codeph>args.rellinks</codeph>, but may be overridden directly. Valid roles include: <ul>
  15. <li>parent </li>
  16. <li>child </li>
  17. <li>sibling </li>
  18. <li>friend </li>
  19. <li>next </li>
  20. <li>previous </li>
  21. <li>cousin </li>
  22. <li>ancestor </li>
  23. <li>descendant </li>
  24. <li>sample </li>
  25. <li>external </li>
  26. <li>other</li>
  27. </ul></pd>
  28. </plentry>
  29. <plentry>
  30. <pt><codeph>temp.output.dir.name</codeph></pt>
  31. <pd>An internal property for use with custom transform types; this property can be used to place all output
  32. in an internal directory, so that a final step in the transform type can do some form of post-processing
  33. before the files are placed in the specified output directory.
  34. <p>For example, if a custom HTML5 transform sets the property to <codeph>zip_dir</codeph>, all output
  35. files (including HTML, images, and CSS) will be placed within the directory <filepath>zip_dir</filepath>
  36. in the temporary processing directory. A final step can then be used to add more files, zip the directory,
  37. and return that zip to the designated output directory.</p></pd>
  38. </plentry>
  39. </parml>
  40. </section>
  41. </refbody>
  42. </reference>