html-customization-properties-file.dita 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <task id="custom-html-properties-file">
  5. <title>Customizing HTML with a <filepath>.properties</filepath> file</title>
  6. <titlealts>
  7. <navtitle>Using a properties file</navtitle>
  8. </titlealts>
  9. <shortdesc>You can also use a <filepath>.properties</filepath> file to reference a set of build parameters when
  10. building output with the <cmdname>dita</cmdname> command. The DITA-OT documentation uses a
  11. <filepath>.properties</filepath> file to include custom CSS, header branding, and table-of-contents navigation in
  12. the HTML5 output.</shortdesc>
  13. <taskbody>
  14. <steps>
  15. <step>
  16. <cmd>Create a <filepath>.properties</filepath> file to store the parameter settings for your
  17. customization.</cmd>
  18. <info>
  19. <note type="tip">You can use the <filepath>.properties</filepath> for the DITA-OT documentation as a starting
  20. point for your own customizations. This file is available in the installation folder under
  21. <filepath>docsrc/samples/properties/docs-build-html5.properties</filepath>.</note>
  22. </info>
  23. <stepxmp>For example: <fig>
  24. <title>The <filepath>docsrc/samples/properties/docs-build-html5.properties</filepath> file</title>
  25. <codeblock><coderef href="../samples/properties/docs-build-html5.properties"/></codeblock>
  26. </fig>
  27. </stepxmp>
  28. </step>
  29. <step>
  30. <cmd>Reference your <filepath>.properties</filepath> file with the <cmdname>dita</cmdname> command when building
  31. your output.</cmd>
  32. <stepxmp>
  33. <codeblock><cmdname>dita</cmdname> <parmname>--input</parmname>=<varname>my.ditamap</varname> <parmname>--format</parmname>=<option>html5</option> <parmname>--propertyfile</parmname>=<varname>my.properties</varname></codeblock>
  34. </stepxmp>
  35. <info/>
  36. </step>
  37. </steps>
  38. <result>
  39. <note>For an example of HTML output generated using this method, see the HTML5 version of the DITA-OT
  40. documentation included in the installation folder under <filepath>doc/index.html</filepath>.</note>
  41. </result>
  42. </taskbody>
  43. </task>