Diff for parameters-to-the-DITA-OT-transform

Tue, 2009-05-12 15:12 by robanderTue, 2009-05-12 15:51 by robander
< previous diffnext diff >
Changes to Body
Line 4Line 4
 
</p>
 
</p>
 
<p>
 
<p>
-
(As you can see at this point, this item is just a starter page, with more information coming soon.)
+
(As you can see at this point, this item is just a starter page, with more information coming soon.)
 
</p>
 
</p>
-
<h2>XHTML output</h2>
+
<p>
  +
For each parameter below, the Ant parameter is listed first, followed by valid values (if any), followed by a description. If applicable, a corresponding XSLT parameter is listed at the end.
  +
</p>
  +
<h2>General processing parameters</h2>
  +
<ul>
  +
<li> ${args.draft} - &quot;no&quot; or &quot;yes&quot;, default is &quot;no&quot;. Indicates whether draft-comment and required-cleanup elements are included in the generated file. Corresponds to XSLT parameter DRAFT.</li>
  +
<li>${dita.ext} - any value, defaults to &quot;.xml&quot;. Specifies an extension to use for DITA topics; all DITA topics will use this single extension in the temp directory. Corresponds to XSLT parameter DITAEXT.</li>
  +
<li>${dita.input.valfile} - any value. Specifies the DITAVAL file used for processing. Corresponds to XSLT parameter FILTERFILE. </li>
  +
</ul>
  +
<h2>XHTML specific parameters<br />
  +
</h2>
  +
<ul>
  +
<li>${args.artlbl} -&quot;no&quot; or &quot;yes&quot;, defaults to &quot;no&quot;. Indicates whether the filename of each image will appear alongside the image, typically for review purposes. Corresponds to the XSLT parameter ARTLBL.</li>
  +
<li>${args.css.file} - any value. Specifies a CSS file, expected without path. Corresponds to XSLT parameter CSS.</li>
  +
<li>${args.hdf} - any value. Specfies a file that contains an XHTML fragment to be inserted into the &lt;head&gt; of every generated XHTML file. NOTE: the fragment must be valid XML, with a single root element; if you need to add two peer elements, place them in a &lt;div&gt;, and the build will discard that wrapper. Corresponds to the XSLT parameter HDF. </li>
  +
<li>${args.hdr} - any value. Specfies a file that contains an XHTML fragment to be
  +
inserted at the top of the body in each generated XHTML file. NOTE: the
  +
fragment must be valid XML, with a single root element; common practice is to place all contents into &lt;div&gt;. Corresponds to the XSLT parameter HDR.</li>
  +
<li>${args.indexshow} - &quot;no&quot; or &quot;yes&quot;, defaults to &quot;no&quot;. When set to yes, index terms will appear inline in brackets, typically for review purposes. Corresponds to the XSLT parameter INDEXSHOW. </li>
  +
<li>${args.ftr} - any value. Specfies a file that contains an XHTML
  +
fragment to be
  +
inserted at the bottom of the body in each generated XHTML file. NOTE: the
  +
fragment must be valid XML, with a single root element; common practice
  +
is to place all contents into &lt;div&gt;. Corresponds to the XSLT
  +
parameter FTR.</li>
  +
<li>${out.ext} - any value, defaults to &quot;.html&quot;. Specifies an output
  +
extension for XHTML topics. Corresponds to XSLT parameter OUTEXT.</li>
  +
<li>${user.csspath} - any value, default is the root map's directory. Specifies a path for CSS links added to XHTML output (default and user files). Corresponds to XSLT parameter CSSPATH.</li>
  +
</ul>
  +
The following parameters are currently part of the core XHTML XSLT program, but need full definition and corresponding Ant parameters:<br />
  +
<ul>
  +
<li>PRESERVE-DITA-CLASS</li>
  +
<li>NOPARENTLINK</li>
  +
<li>BREADCRUMBS</li>
  +
<li>DBG</li>
  +
<li>genDefMeta</li>
  +
</ul>
 
<ul>
 
<ul>
-
<li> <em>item</em></li>
  
 
</ul>
 
</ul>
-
<h2>PDF output</h2>
+
<h2>PDF specific parameters<br />
  +
</h2>
 
<ul>
 
<ul>
 
<li><em>item</em> </li>
 
<li><em>item</em> </li>
Revision of Tue, 2009-05-12 15:51:

parameters-to-the-DITA-OT-transform

Ant and XSLT Parameters to the DITA Open Toolkit

This page is a collection point for parameters in the core DITA-OT that can be set by tools or individual users running a build. Most of this information would be more usable in a tabular format, but this wiki does not appear to support tables. Note: the main landing page for information about the toolkit is here: http://dita.xml.org/wiki/the-dita-open-toolkit

(As you can see at this point, this item is just a starter page, with more information coming soon.)

For each parameter below, the Ant parameter is listed first, followed by valid values (if any), followed by a description. If applicable, a corresponding XSLT parameter is listed at the end.

General processing parameters

  •  ${args.draft} - "no" or "yes", default is "no". Indicates whether draft-comment and required-cleanup elements are included in the generated file. Corresponds to XSLT parameter DRAFT.
  • ${dita.ext} - any value, defaults to ".xml". Specifies an extension to use for DITA topics; all DITA topics will use this single extension in the temp directory. Corresponds to XSLT parameter DITAEXT.
  • ${dita.input.valfile} - any value. Specifies the DITAVAL file used for processing. Corresponds to XSLT parameter FILTERFILE.

XHTML specific parameters

  • ${args.artlbl} -"no" or "yes", defaults to "no". Indicates whether the filename of each image will appear alongside the image, typically for review purposes. Corresponds to the XSLT parameter ARTLBL.
  • ${args.css.file} - any value. Specifies a CSS file, expected without path. Corresponds to XSLT parameter CSS.
  • ${args.hdf} - any value. Specfies a file that contains an XHTML fragment to be inserted into the <head> of every generated XHTML file. NOTE: the fragment must be valid XML, with a single root element; if you need to add two peer elements, place them in a <div>, and the build will discard that wrapper. Corresponds to the XSLT parameter HDF.
  • ${args.hdr} - any value. Specfies a file that contains an XHTML fragment to be inserted at the top of the body in each generated XHTML file. NOTE: the fragment must be valid XML, with a single root element; common practice is to place all contents into <div>. Corresponds to the XSLT parameter HDR.
  • ${args.indexshow} - "no" or "yes", defaults to "no". When set to yes, index terms will appear inline in brackets, typically for review purposes. Corresponds to the XSLT parameter INDEXSHOW.
  • ${args.ftr} - any value. Specfies a file that contains an XHTML fragment to be inserted at the bottom of the body in each generated XHTML file. NOTE: the fragment must be valid XML, with a single root element; common practice is to place all contents into <div>. Corresponds to the XSLT parameter FTR.
  • ${out.ext} - any value, defaults to ".html". Specifies an output extension for XHTML topics. Corresponds to XSLT parameter OUTEXT.
  • ${user.csspath} - any value, default is the root map's directory. Specifies a path for CSS links added to XHTML output (default and user files). Corresponds to XSLT parameter CSSPATH.
The following parameters are currently part of the core XHTML XSLT program, but need full definition and corresponding Ant parameters:
  • PRESERVE-DITA-CLASS
  • NOPARENTLINK
  • BREADCRUMBS
  • DBG
  • genDefMeta

PDF specific parameters

  • item

 

XML.org Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | XML.org | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I

dita-bird_0.jpg

Hosted by:

OASIS

Sponsored by:

adobe-systems-incorporated_0_0_0.png

ibm.gif

Sponsored links:

Adobe DITA CCMS