bn
/
se


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536
							<!DOCTYPE html
  SYSTEM "about:legacy-compat">
<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 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="reference"><meta name="description" content="Certain parameters apply to all the HTML-based transformation types: Eclipse help, HTML Help, JavaHelp, TocJS, HTML5, and XHTML."><meta name="DC.Relation" scheme="URI" content="../parameters/parameters_intro.html"><meta name="DC.Relation" scheme="URI" content="../parameters/generate-copy-outer.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-eclipsecontent.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-eclipsehelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-htmlhelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-javahelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-common-html.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-eclipsecontent.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-eclipsehelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-htmlhelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-javahelp.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters-common-html.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="base-html"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML-based output parameters</title></head><body id="base-html"><header role="banner"><div class="header">
  <p>DITA Open Toolkit</p>
  <hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</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><ul><li><a href="../parameters/parameters-base.html">Common</a></li><li class="active"><a href="../parameters/parameters-base-html.html">HTML-based output</a></li><li><a href="../parameters/parameters-common-html.html">HTML5 and XHTML</a></li><li><a href="../parameters/parameters-html5.html">HTML5</a></li><li><a href="../parameters/parameters-eclipsecontent.html">Eclipse content</a></li><li><a href="../parameters/parameters-eclipsehelp.html">Eclipse Help</a></li><li><a href="../parameters/parameters-htmlhelp.html">HTMLHelp</a></li><li><a href="../parameters/parameters-javahelp.html">JavaHelp</a></li><li><a href="../parameters/parameters-odt.html">Open Document Format</a></li><li><a href="../parameters/parameters-other.html">Other</a></li><li><a href="../parameters/parameters-pdf.html">PDF</a></li></ul></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../dev_ref/index.html">Developer Reference</a></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 generated" id="ariaid-title1">HTML-based output parameters</h1><div class="body refbody"><p class="shortdesc">Certain parameters apply
      to all the HTML-based transformation types: Eclipse help, HTML Help, JavaHelp, TocJS, HTML5, and XHTML. </p><section class="section"><dl class="dl parml"><dt class="dt pt dlterm" id="base-html__args.artlbl"><span class="keyword parmname">args.artlbl</span></dt><dd class="dd pd" id="base-html__args.artlbl.desc">Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base-html__args.breadcrumbs"><span class="keyword parmname">args.breadcrumbs</span></dt><dd class="dd pd" id="base-html__args.breadcrumbs.desc">Specifies whether to generate breadcrumb links. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">Corresponds to the XSLT parameter
                <span class="keyword parmname">BREADCRUMBS</span>.</dd><dt class="dt pt dlterm" id="base-html__args.copycss"><span class="keyword parmname">args.copycss</span></dt><dd class="dd pd" id="base-html__args.copycss.desc">Specifies whether to copy the custom .css file to the output directory. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base-html__args.css"><span class="keyword parmname">args.css</span></dt><dd class="dd pd" id="base-html__args.css.desc">Specifies the name of a custom .css file.</dd><dt class="dt pt dlterm" id="base-html__args.csspath"><span class="keyword parmname">args.csspath</span></dt><dd class="dd pd" id="base-html__args.csspath.desc">Specifies the location of a copied .css file relative to the output directory.</dd><dd class="dd pd ddexpand">Corresponds to the XSLT parameter
                <span class="keyword parmname">CSSPATH</span>. DITA-OT will copy the file to this location.</dd><dt class="dt pt dlterm" id="base-html__args.cssroot"><span class="keyword parmname">args.cssroot</span></dt><dd class="dd pd" id="base-html__args.cssroot.desc">Specifies the directory that contains the custom .css file.</dd><dd class="dd pd ddexpand">DITA-OT will copy the file from this location.</dd><dt class="dt pt dlterm" id="base-html__args.dita.locale"><span class="keyword parmname">args.dita.locale</span></dt><dd class="dd pd" id="base-html__args.dita.locale.desc">Specifies the language locale file to use for sorting index entries.</dd><dd class="dd pd ddexpand">
              <div class="note note note_note"><span class="note__title notetitle">Note:</span> This parameter is not available for the XHTML transformation.</div>
            </dd><dt class="dt pt dlterm" id="base-html__args.ftr"><span class="keyword parmname">args.ftr</span></dt><dd class="dd pd" id="base-html__args.ftr.desc">Specifies an XML file that contains content for a running footer.</dd><dd class="dd pd ddexpand">
              <span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">FTR</span>.</span>
              <div class="note note note_note"><span class="note__title notetitle">Note:</span> The footer file should be specified using an absolute path and must contain valid XML. A common
                practice is to place all content into a <code class="keyword markupname xmlelement">&lt;div&gt;</code> element.</div>
            </dd><dt class="dt pt dlterm" id="base-html__args.gen.default.meta"><span class="keyword parmname">args.gen.default.meta</span></dt><dd class="dd pd" id="base-html__args.gen.default.meta.desc">Specifies whether to generate extra metadata that targets parental control scanners, meta elements with name="security" and name="Robots". The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">Corresponds to the XSLT parameter
                <span class="keyword parmname">genDefMeta</span>.</dd><dt class="dt pt dlterm" id="base-html__args.hdf"><span class="keyword parmname">args.hdf</span></dt><dd class="dd pd" id="base-html__args.hdf.desc">Specifies an XML file that contains content to be placed in the document head.</dd><dd class="dd pd ddexpand">
              <p class="p">The contents of the header file will be inserted in the <code class="keyword markupname xmlelement">&lt;head&gt;</code> element of the
                generated HTML files.</p>
              <div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> The header file should be specified using an absolute path and must contain valid XML. If
                you need to insert more than one element into the HTML page head, wrap the content in a
                  <code class="keyword markupname xmlelement">&lt;div&gt;</code> element. The division wrapper in the header file will be discarded when
                generating HTML files, and the contents will be inserted into each page head.</div></dd><dt class="dt pt dlterm" id="base-html__args.hdr"><span class="keyword parmname">args.hdr</span></dt><dd class="dd pd" id="base-html__args.hdr.desc">Specifies an XML file that contains content for a running header.</dd><dd class="dd pd ddexpand">
              <span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">HDR</span>.</span>
              <div class="note note note_note"><span class="note__title notetitle">Note:</span> The header file should be specified using an absolute path and must contain valid XML. A common
                practice is to place all content into a <code class="keyword markupname xmlelement">&lt;div&gt;</code> element.</div>
            </dd><dt class="dt pt dlterm" id="base-html__args.hide.parent.link"><span class="keyword parmname">args.hide.parent.link</span></dt><dd class="dd pd" id="base-html__args.hide.parent.link.desc">Specifies whether to hide links to parent topics in the HTML or XHTML output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dd class="dd pd ddexpand">
              <span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">NOPARENTLINK</span>.</span>
              <div class="note note note_note"><span class="note__title notetitle">Note:</span> This parameter is deprecated in favor of the <span class="keyword parmname">args.rellinks</span>
                parameter.</div>
            </dd><dt class="dt pt dlterm" id="base-html__args.indexshow"><span class="keyword parmname">args.indexshow</span></dt><dd class="dd pd" id="base-html__args.indexshow.desc">Specifies whether the content of &lt;indexterm&gt; elements are rendered in the output. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">no</span>.</dd><dt class="dt pt dlterm" id="base-html__args.outext"><span class="keyword parmname">args.outext</span></dt><dd class="dd pd" id="base-html__args.outext.desc">Specifies the file extension for HTML or XHTML output.</dd><dd class="dd pd ddexpand">
              <span class="ph">Corresponds to the XSLT parameter <span class="keyword parmname">OUTEXT</span>.</span>
            </dd><dt class="dt pt dlterm" id="base-html__args.xhtml.classattr"><span class="keyword parmname">args.xhtml.classattr</span></dt><dd class="dd pd" id="base-html__args.xhtml.classattr.desc">Specifies whether to include the DITA class ancestry inside the XHTML elements. The allowed values are <span class="keyword option">yes</span> and <span class="keyword option">no</span>; the default value is <span class="keyword option">yes</span>.</dd><dd class="dd pd ddexpand">For example, the <code class="keyword markupname xmlelement">&lt;prereq&gt;</code> element (which is specialized
              from <code class="keyword markupname xmlelement">&lt;section&gt;</code>) would generate <code class="ph codeph">class="section prereq"</code>. <span class="ph">Corresponds to the XSLT parameter
                <span class="keyword parmname">PRESERVE-DITA-CLASS</span>.</span><div class="note note note_note"><span class="note__title notetitle">Note:</span> Beginning with DITA OT release 1.5.2, the default
                value is <span class="keyword option">yes</span>. For release 1.5 and 1.5.1, the default value was <span class="keyword option">no</span>.
              </div></dd><dt class="dt pt dlterm" id="base-html__args.xsl"><span class="keyword parmname">args.xsl</span></dt><dd class="dd pd" id="base-html__args.xsl.desc">Specifies a custom XSL file to be used instead of the default XSL transformation.</dd><dd class="dd pd ddexpand">The parameter must specify a fully qualified file name.</dd></dl></section></div><nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../parameters/generate-copy-outer.html">generate.copy.outer parameter</a></strong><br>Elaboration on how the <span class="keyword parmname">generate.copy.outer</span> parameter functions.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/parameters_intro.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Some parameters apply only to specific transformation types. These parameters can be passed as options to the dita command using the -Dparameter-name=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div></div><div class="linklist linklist relinfo relref"><strong>Related reference</strong><br><div><a class="link" href="../parameters/parameters-eclipsecontent.html" title="Certain parameters are specific to the Eclipse content transformation.">Eclipse content parameters</a></div><div><a class="link" href="../parameters/parameters-eclipsehelp.html" title="Certain parameters are specific to the Eclipse help transformation.">Eclipse Help parameters</a></div><div><a class="link" href="../parameters/parameters-htmlhelp.html" title="Certain parameters are specific to the HTML Help transformation.">HTMLHelp parameters</a></div><div><a class="link" href="../parameters/parameters-javahelp.html" title="Certain parameters are specific to the JavaHelp transformation.">JavaHelp parameters</a></div><div><a class="link" href="../parameters/parameters-common-html.html" title="Certain parameters are specific to the HTML5 and XHTML transformations.">HTML5 and XHTML parameters</a></div></div></nav></article></main></body></html>