Home Verkennen Help
Inloggen
bn
/
se
2
0
Vork 0
Bestanden Issues 0 Pull-aanvragen 0 Wiki
Boom: c8927bb461
Aftakkingen Labels
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.5
/
doc
/
topics
/
project-files-xml.html

project-files-xml.html 12 KB
Geschiedenis Ruwe

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  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 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="concept"><meta name="description" content="DITA-OT includes sample XML project files that can be used to define a publication project. The XML format can be validated with a RELAX NG schema provided in the resources folder of the DITA-OT installation (project.rnc)."><meta name="DC.subject" content="XML project files, project files, XML"><meta name="keywords" content="XML project files, project files, XML"><meta name="DC.relation" scheme="URI" content="../topics/using-project-files.html"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="ID"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Sample XML project files</title></head><body id="ID"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.5</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/building-output.html">Building output</a><ul><li><a href="../topics/build-using-dita-command.html">Using the dita command</a><ul><li><a href="../topics/using-dita-properties-file.html">Using a properties file</a></li><li><a href="../topics/migrating-ant-to-dita.html">Migrating Ant builds</a></li><li><a href="../topics/using-project-files.html">Using a project file</a><ul><li class="active"><a href="../topics/project-files-xml.html">XML project files</a></li><li><a href="../topics/project-files-json.html">JSON project files</a></li><li><a href="../topics/project-files-yaml.html">YAML project files</a></li></ul></li></ul></li><li><a href="../topics/using-docker-images.html">Using Docker images</a></li><li><a href="../topics/publishing-with-ant.html">Using Ant</a></li><li><a href="../reference/java-api.html">Using the Java API</a></li></ul></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</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. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Sample XML project files</h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10.   
    11. 

  11.   <div class="body conbody"><p class="shortdesc">DITA-OT includes sample XML project files that can be used to define a publication project. The XML format
    12. 

  12.     can be validated with a RELAX NG schema provided in the <span class="ph filepath">resources</span> folder of the DITA-OT
    13. 

  13.     installation (<span class="ph filepath">project.rnc</span>).</p>
    14. 

  14.     <p class="p">Project files can be designed in a modular fashion to create reusable configuration structures that allow you to
    15. 

  15.       define settings in one file and refer to them in other projects to publish multiple deliverables at once.</p>
    16. 

  16.     <p class="p">For example, <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/project-files/html.xml</span> defines
    17. 

  17.       a single HTML deliverable.</p>
    18. 

  18.     <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Sample project file for HTML output</figcaption>
    19. 

  19.       
    20. 

  20.       <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    21. 

  21. &lt;?xml-model href="../../../resources/project.rnc" type="application/relax-ng-compact-syntax"?&gt;
    22. 

  22. &lt;project xmlns="https://www.dita-ot.org/project"&gt;
    23. 

  23.   &lt;include href="common.xml"/&gt;
    24. 

  24.   &lt;deliverable name="HTML5" id="html"&gt;
    25. 

  25.     &lt;context idref="html"/&gt;
    26. 

  26.     &lt;output href="."/&gt;
    27. 

  27.     &lt;publication transtype="html5"&gt;
    28. 

  28.       &lt;param name="args.copycss" value="yes"/&gt;
    29. 

  29.       &lt;param name="args.css" value="dita-ot-doc.css"/&gt;
    30. 

  30.       &lt;param name="args.csspath" value="css"/&gt;
    31. 

  31.       &lt;param name="args.cssroot" path="../../resources"/&gt;
    32. 

  32.       &lt;param name="args.gen.task.lbl" value="YES"/&gt;
    33. 

  33.       &lt;param name="args.hdr" href="../../resources/header.xml"/&gt;
    34. 

  34.       &lt;param name="html5.toc.generate" value="no"/&gt;
    35. 

  35.       &lt;param name="nav-toc" value="partial"/&gt;
    36. 

  36.       &lt;param name="processing-mode" value="strict"/&gt;
    37. 

  37.     &lt;/publication&gt;
    38. 

  38.   &lt;/deliverable&gt;
    39. 

  39. &lt;/project&gt;</code></pre>
    40. 

  40.     </figure>
    41. 

  41.     <p class="p">This file can be used to generate the HTML version of the DITA-OT documentation by running the following command
    42. 

  42.       from the <span class="ph filepath">docsrc</span> folder of the DITA-OT installation directory:</p>
    43. 

  43.     <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--project</span>=<var class="keyword varname">samples/project-files/html.xml</var></code></pre>
    44. 

  44.     <p class="p">The project file for HTML output imports the common <code class="ph codeph">html</code> context from a shared project context
    45. 

  45.       defined in the <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/project-files/common.xml</span> file,
    46. 

  46.       which includes the input map file and the DITAVAL file used to filter the output.</p>
    47. 

  47.     <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Sample shared context for HTML-based output</figcaption>
    48. 

  48.       
    49. 

  49.       <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    50. 

  50. &lt;?xml-model href="../../../resources/project.rnc" type="application/relax-ng-compact-syntax"?&gt;
    51. 

  51. &lt;project xmlns="https://www.dita-ot.org/project"&gt;
    52. 

  52.   &lt;context id="html"&gt;
    53. 

  53.     &lt;input href="../../userguide.ditamap"/&gt;
    54. 

  54.     &lt;profile&gt;
    55. 

  55.       &lt;ditaval href="../../resources/html.ditaval"/&gt;
    56. 

  56.     &lt;/profile&gt;
    57. 

  57.   &lt;/context&gt;
    58. 

  58. &lt;/project&gt;</code></pre>
    59. 

  59.     </figure>
    60. 

  60.     <p class="p">The same common <code class="ph codeph">html</code> context is also referenced in the project file for HTMLHelp output, as
    61. 

  61.       illustrated in <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/project-files/htmlhelp.xml</span>.</p>
    62. 

  62.     <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 3. </span>Sample project file for HTMLHelp output</figcaption>
    63. 

  63.       
    64. 

  64.       <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    65. 

  65. &lt;?xml-model href="../../../resources/project.rnc" type="application/relax-ng-compact-syntax"?&gt;
    66. 

  66. &lt;project xmlns="https://www.dita-ot.org/project"&gt;
    67. 

  67.   &lt;deliverable name="HTMLHelp" id="htmlhelp"&gt;
    68. 

  68.     &lt;context idref="html"/&gt;
    69. 

  69.     &lt;output href="htmlhelp"/&gt;
    70. 

  70.     &lt;publication transtype="htmlhelp"&gt;
    71. 

  71.       &lt;param name="args.copycss" value="yes"/&gt;
    72. 

  72.       &lt;param name="args.css" value="dita-ot-doc.css"/&gt;
    73. 

  73.       &lt;param name="args.csspath" value="css"/&gt;
    74. 

  74.       &lt;param name="args.cssroot" path="../../resources"/&gt;
    75. 

  75.       &lt;param name="args.gen.task.lbl" value="YES"/&gt;
    76. 

  76.       &lt;param name="processing-mode" value="strict"/&gt;
    77. 

  77.     &lt;/publication&gt;
    78. 

  78.   &lt;/deliverable&gt;
    79. 

  79. &lt;/project&gt;</code></pre>
    80. 

  80.     </figure>
    81. 

  81.     <p class="p">The <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/project-files/pdf.xml</span> file defines a
    82. 

  82.       single PDF deliverable.</p>
    83. 

  83.     <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 4. </span>Sample project file for PDF output</figcaption>
    84. 

  84.       
    85. 

  85.       <pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
    86. 

  86. &lt;?xml-model href="../../../resources/project.rnc" type="application/relax-ng-compact-syntax"?&gt;
    87. 

  87. &lt;project xmlns="https://www.dita-ot.org/project"&gt;
    88. 

  88.   &lt;deliverable id="pdf"&gt;
    89. 

  89.     &lt;context&gt;
    90. 

  90.       &lt;input href="../../userguide-book.ditamap"/&gt;
    91. 

  91.     &lt;/context&gt;
    92. 

  92.     &lt;output href="."/&gt;
    93. 

  93.     &lt;publication transtype="pdf2"&gt;
    94. 

  94.       &lt;param name="args.chapter.layout" value="BASIC"/&gt;
    95. 

  95.       &lt;param name="args.gen.task.lbl" value="YES"/&gt;
    96. 

  96.       &lt;param name="include.rellinks" value="friend"/&gt;
    97. 

  97.       &lt;param name="outputFile.base" value="userguide"/&gt;
    98. 

  98.       &lt;param name="processing-mode" value="strict"/&gt;
    99. 

  99.     &lt;/publication&gt;
    100. 

  100.   &lt;/deliverable&gt;
    101. 

  101. &lt;/project&gt;</code></pre>
    102. 

  102.     </figure>
    103. 

  103.     <p class="p">This file can be used to generate the PDF version of the DITA-OT documentation by running the following command
    104. 

  104.       from the <span class="ph filepath">docsrc</span> folder of the DITA-OT installation directory:</p>
    105. 

  105.     <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--project</span>=<var class="keyword varname">samples/project-files/pdf.xml</var></code></pre>
    106. 

  106.     <p class="p">The <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/project-files/distribution-docs.xml</span> file
    107. 

  107.       includes both the HTML and PDF projects as follows:</p>
    108. 

  108.     <pre class="pre codeblock language-xml normalize-space show-whitespace"><code>&lt;project xmlns="https://www.dita-ot.org/project"&gt;
    109. 

  109.   &lt;include href="html.xml"/&gt;
    110. 

  110.   &lt;include href="pdf.xml"/&gt;
    111. 

  111. &lt;/project&gt;</code></pre>
    112. 

  112.     <p class="p">To build both the HTML and PDF versions of the documentation as included in the distribution package, run the
    113. 

  113.       following command from the <span class="ph filepath">docsrc</span> folder of the DITA-OT installation directory:</p>
    114. 

  114.     <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--project</span>=<var class="keyword varname">samples/project-files/distribution-docs.xml</var></code></pre>
    115. 

  115.     <p class="p">The <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var>/docsrc/samples</span><span class="ph filepath">/project-files/all.xml</span> file includes all
    116. 

  116.       three project deliverables as follows:</p>
    117. 

  117.     <pre class="pre codeblock language-xml normalize-space show-whitespace"><code>&lt;project xmlns="https://www.dita-ot.org/project"&gt;
    118. 

  118.   &lt;include href="html.xml"/&gt;
    119. 

  119.   &lt;include href="htmlhelp.xml"/&gt;
    120. 

  120.   &lt;include href="pdf.xml"/&gt;
    121. 

  121. &lt;/project&gt;</code></pre>
    122. 

  122.   </div>
    123. 

  123. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/using-project-files.html" title="DITA-OT 3.4 introduces new project files to define publication projects with multiple deliverables. Projects specify a context, output folder, and publication for each deliverable. A re-usable context groups source files and filters, and a publication defines an output format with transformation parameters. You can pass a project file to the dita command to publish multiple deliverables at once.">Publishing with project files</a></div></div></nav></article></main></body></html>
    124.