internal-ant-properties.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <!DOCTYPE html
  2. SYSTEM "about:legacy-compat">
  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2019"><meta name="DC.rights.owner" content="(C) Copyright 2019"><meta name="DC.type" content="reference"><meta name="description" content="Reference list of Ant properties used by DITA-OT internally."><meta name="DC.subject" content=", role, args.rellinks, PDF, related links, HTML5"><meta name="keywords" content=", role, args.rellinks, PDF, related links, HTML5"><meta name="DC.relation" scheme="URI" content="../parameters/configuration-properties.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="ant-properties"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Internal Ant properties</title></head><body id="ant-properties"><header role="banner"><div class="header">
  4. <p>DITA Open Toolkit</p>
  5. <hr>
  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a><ul><li><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a><ul><li><a href="../parameters/local-properties-file.html">local.properties</a></li><li><a href="../parameters/plugin-properties-file.html">plugin.properties</a></li><li><a href="../parameters/configuration-properties-file.html">configuration.properties</a></li><li class="active"><a href="../parameters/internal-ant-properties.html">Internal Ant properties</a></li></ul></li></ul></li><li><a href="../topics/customizing.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
  7. <h1 class="title topictitle1" id="ariaid-title1">Internal Ant properties</h1>
  8. <div class="body refbody"><p class="shortdesc">Reference list of Ant properties used by DITA-OT internally.</p>
  9. <section class="section">
  10. <dl class="dl parml">
  11. <dt class="dt pt dlterm"><code class="ph codeph">include.rellinks</code></dt>
  12. <dd class="dd pd">A space-separated list of link roles to be output; the <code class="ph codeph">#default</code> value token represents
  13. links without an explicit role (those for which no <code class="keyword markupname xmlatt">@role</code> attribute is defined). Defined by
  14. <code class="ph codeph">args.rellinks</code>, but may be overridden directly. Valid roles include: <ul class="ul">
  15. <li class="li">parent </li>
  16. <li class="li">child </li>
  17. <li class="li">sibling </li>
  18. <li class="li">friend </li>
  19. <li class="li">next </li>
  20. <li class="li">previous </li>
  21. <li class="li">cousin </li>
  22. <li class="li">ancestor </li>
  23. <li class="li">descendant </li>
  24. <li class="li">sample </li>
  25. <li class="li">external </li>
  26. <li class="li">other</li>
  27. </ul></dd>
  28. <dt class="dt pt dlterm"><code class="ph codeph">temp.output.dir.name</code></dt>
  29. <dd class="dd pd">An internal property for use with custom transform types; this property can be used to place all output
  30. in an internal directory, so that a final step in the transform type can do some form of post-processing
  31. before the files are placed in the specified output directory.
  32. <p class="p">For example, if a custom HTML5 transform sets the property to <code class="ph codeph">zip_dir</code>, all output
  33. files (including HTML, images, and CSS) will be placed within the directory <span class="ph filepath">zip_dir</span>
  34. in the temporary processing directory. A final step can then be used to add more files, zip the directory,
  35. and return that zip to the designated output directory.</p></dd>
  36. </dl>
  37. </section>
  38. </div>
  39. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/configuration-properties.html" title="DITA-OT uses .properties files and internal properties that store configuration settings for the toolkit and its plug-ins. Configuration properties are available to both Ant and Java processes, but unlike argument properties, they cannot be set at run time.">Configuration properties</a></div></div></nav></article></main></body></html>