apb/code-srv-test
apb/code-srv-test
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

from code-server

Browse source
This commit is contained in:
Andy Bunce 2021-03-23 22:38:58 +00:00
parent eda5c02fe9
commit 5ef8bdba47
2652 changed files with 528235 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
dita-ot-3.6/doc/reference/architecture.html Normal file
View file

File diff suppressed because one or more lines are too long

46
dita-ot-3.6/doc/reference/books.html Normal file
View file

@ -0,0 +1,46 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Several DITA-related publications include information on configuring and customizing DITA Open Toolkit with detailed examples on creating custom plug-ins for PDF output."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Books</title></head><body id="books"><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 3.6</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></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">
<h1 class="title topictitle1" id="ariaid-title1">Books</h1>
<div class="body"><p class="shortdesc">Several DITA-related publications include information on configuring and customizing DITA Open Toolkit
with detailed examples on creating custom plug-ins for PDF output.</p>
<section class="section"><h2 class="title sectiontitle"><cite class="cite">DITA for Print: A DITA Open Toolkit Workbook</cite> (Second Edition, 2017)</h2>
<p class="p">Authored by Leigh W. White, DITA Specialist at IXIASOFT, and published by XML Press, <cite class="cite">DITA for
Print</cite> walks readers through developing a PDF customization from scratch. </p>
<p class="p">Here is an excerpt from the back cover:</p>
<blockquote class="lq"><cite class="cite">DITA for Print</cite> is for anyone who wants to learn how to create PDFs using the DITA Open Toolkit
without learning everything there is to know about XSL-FO, XSLT, or XPath, or even about the DITA Open Toolkit
itself. <cite class="cite">DITA for Print</cite> is written for non-programmers, by a non-programmer, and although it is
written for people who have a good understanding of the DITA standard, you don’t need a technical background to
get custom PDFs up and running quickly.</blockquote>
<p class="p">This is an excellent, long-needed resource that was initially developed in 2013 for DITA-OT 1.8.</p>
<p class="p">The second edition has been revised to cover DITA Open Toolkit Version 2, including customizing the DITA 1.3
troubleshooting topic type, localization strings, bookmarks, and the new back-cover functionality.</p>
<div class="note important note_important"><span class="note__title">Important:</span>
<p class="p">The first edition of <cite class="cite">DITA for Print</cite> recommended copying entire files from the PDF2 plug-in to
your custom plug-in. The DITA-OT project — and the second edition of the book — do not recommend this
practice.</p>
<p class="p">Instead, you should copy only the specific attribute sets and templates that you want to override. Following
this practice will more cleanly isolate your customizations from the DITA-OT code, which will make it easier
for you to update your plug-ins to work with future versions of DITA-OT.</p></div>
</section>
<section class="section"><h2 class="title sectiontitle"><cite class="cite">DITA for Practitioners: Volume 1, Architecture and Technology</cite> (2012)</h2>
<p class="p">Authored by Eliot Kimber and published by XML Press, this seminal resource contains a chapter dedicated to DITA
Open Toolkit: “Running, Configuring, and Customizing the Open Toolkit”. In addition to a robust overview of
DITA-OT customization and extension, the chapter contains a detailed example of customizing a PDF plug-in to
specify 7" × 10" paper size and custom fonts for body text and headers.</p>
<p class="p">The DITA-OT chapter in <cite class="cite">DITA for Practitioners: Volume 1</cite> was written for DITA-OT 1.5.4, which was
the latest stable version at the time it was written.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/dita-and-dita-ot-resources.html" title="Are you new to the DITA-OT? Come and get an overview of what it is, how it works, its history, and the people involved. This will be an excellent start to DITA-OT day for novices.">Overview of the DITA Open Toolkit</a></div></div></nav></article></main></body></html>

30
dita-ot-3.6/doc/reference/common-html-processing.html Normal file
View file

@ -0,0 +1,30 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="After the pre-processing operation runs, HTML-based builds each run a common series of Ant targets to generate HTML file. Navigation may be created before or after this set of common routines."><meta name="keywords" content=", chunk, HTML-based processing, DITAVAL, HTML-based formats, HTML, common processing, CSS, HTML transforms"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Common HTML-based processing</title></head><body id="common-html-processing"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li class="active"><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Common HTML-based processing</h1>
<div class="body conbody"><p class="shortdesc">After the pre-processing operation runs, HTML-based builds each run a common series of Ant targets to
generate HTML file. Navigation may be created before or after this set of common routines.</p>
<p class="p">After the pre-processing is completed, the following targets are run for all of the HTML-based builds:</p>
<div class="p">
<ul class="ul">
<li class="li">If the <span class="keyword parmname">args.css</span> parameter is passed to the build to add a CSS file, the
<code class="ph codeph">copy-css</code> target copies the CSS file from its source location to the relative location in
the output directory.</li>
<li class="li">If a DITAVAL file is used, the <code class="ph codeph">copy-revflag</code> target copies the default start- and
end-revision flags into the output directory.</li>
<li class="li">The DITA topics are converted to HTML files. Unless the <code class="keyword markupname xmlatt">@chunk</code> attribute was specified, each
DITA topic in the temporary directory now corresponds to one HTML file. The
<code class="ph codeph">dita.inner.topics.xhtml</code> target is used to process documents that are in the map directory
(or subdirectories of the map directory). The <code class="ph codeph">dita.outer.topics.xhtml</code> target is used to
process documents that are outside of the scope of the map, and thus might end up outside of the designated
output directory. Various DITA-OT parameters control how documents processed by the
<code class="ph codeph">dita.outer.topics.xhtml</code> target are handled.</li>
</ul>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

12
dita-ot-3.6/doc/reference/dita-spec-support.html Normal file
View file

@ -0,0 +1,12 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3."><meta name="keywords" content="authoring formats, DITA, DITA 1.0, DITA 1.1"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA specification support</title></head><body id="dita-spec-support"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li class="active"><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">DITA specification support</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit <span class="keyword">3.6</span> supports all versions of the OASIS DITA specification,
including 1.0, 1.1, 1.2, and 1.3.</p></div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></strong><br>DITA Open Toolkit <span class="keyword">3.6</span> supports the DITA 1.2 specification. While 1.2 is no longer the latest version of DITA, the grammar files (DTD and XML Schema) are still included with DITA-OT and content explicitly created for 1.2 continues to work as intended.</li><li class="link ulchildlink"><strong><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></strong><br><span class="ph">DITA Open Toolkit <span class="keyword">3.6</span> provides processing support for the OASIS DITA 1.3 specification. Initial preview support for this specification was added in version 2.0 of the toolkit; version 2.2 extended this foundation to support key scopes and branch filtering along with additional DITA 1.3 features.</span></li><li class="link ulchildlink"><strong><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview support</a></strong><br>DITA Open Toolkit <span class="keyword">3.6</span> provides a preview of features for the upcoming OASIS DITA 2.0 specification. This preliminary processing support is provided on the basis of the latest DRAFT versions of the DITA 2.0 DTD and RELAX&nbsp;NG grammar files from OASIS (as of October 2020).</li><li class="link ulchildlink"><strong><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></strong><br>For certain features, the DITA specification allows conforming processors to choose between different implementation alternatives. In these cases, there may be differences in behavior when DITA content is handled by different processors. DITA-OT supports implementation-specific features by applying one or more of the permissible processing approaches.</li><li class="link ulchildlink"><strong><a href="../reference/extended-functionality.html">Extended codeblock processing</a></strong><br>DITA-OT provides additional processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for code references, normalize indendation, add line numbers or display whitespace characters in code blocks.</li><li class="link ulchildlink"><strong><a href="../reference/docs-dita-features.html">DITA features in the documentation</a></strong><br>DITA Open Toolkit uses various recent DITA features in the project documentation.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a></div></div></nav></article></main></body></html>

37
dita-ot-3.6/doc/reference/dita-v1-2-support.html Normal file
View file

@ -0,0 +1,37 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 supports the DITA 1.2 specification. While 1.2 is no longer the latest version of DITA, the grammar files (DTD and XML Schema) are still included with DITA-OT and content explicitly created for 1.2 continues to work as intended."><meta name="keywords" content=", abbreviated-form, keyref, processing-role, , conref, support, filters, subject scheme, DITA, specializations, DTD, schema, DITA 1.2, grammar files, SCORM"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA 1.2 support</title></head><body id="dita1.2specification"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li class="active"><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">DITA 1.2 support</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit <span class="keyword">3.6</span> supports the DITA 1.2 specification. While 1.2 is no longer
the latest version of DITA, the grammar files (DTD and XML Schema) are still included with DITA-OT and content
explicitly created for 1.2 continues to work as intended.</p>
<div class="p">Highlights of DITA 1.2 support in the toolkit include:
<ul class="ul">
<li class="li">Processing support for all new elements and attributes</li>
<li class="li">Link redirection and text replacement using <code class="keyword markupname xmlatt">@keyref</code></li>
<li class="li">New <code class="keyword markupname xmlatt">@processing-role</code> attribute in maps to allow references to topics that will not produce
output artifacts</li>
<li class="li">New content reference extensions, including the ability to reference a range of elements, to push content
into another topic, and to use keys for resolving a <code class="keyword markupname xmlatt">@conref</code> attribute.</li>
<li class="li">The ability to filter content with controlled values and taxonomies using Subject Scheme Maps</li>
<li class="li">Processing support for both default versions of task (original, limited task, and the general task with
fewer constraints on element order)</li>
<li class="li">Acronym and abbreviation support with the new <code class="keyword markupname xmlelement">&lt;abbreviated-form&gt;</code> element</li>
<li class="li">New link grouping abilities available with headers in relationship tables</li>
<li class="li">OASIS Subcommittee specializations from the learning and machine industry domains (note that the core
toolkit contains only basic processing support for these, but can be extended to produce related artifacts
such as SCORM modules)</li>
</ul></div>
<p class="p">To find detailed information about any of these features, see the specification documents at OASIS. The DITA
Adoption Technical Committee has also produced several papers to describe individual new features. In general, the
white papers are geared more towards DITA users and authors, while the specification is geared more towards tool
implementors, though both may be useful for either audience. The DITA Adoption papers can be found from that
committee’s main web page.</p>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2014/dita-ot_day.html#SCORM_wrapper_for_DITA_to_SCORM" target="_blank" rel="external noopener" title="Hal Trent of Comtech will present a SCORM wrapper developed for learning and training output, which could be potentially donated to the DITA-OT. The wrapper incorporates the current DITA to SCORM output and adds a layer of JavaScript with the SCORM API to integrate the output generated from the DITA-OT into an LMS. The wrapper passes test completion status to and from the LMS and provides a much needed output for the learning and training implementation.">SCORM Wrapper for DITA to SCORM</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.html" target="_blank" rel="external noopener">DITA 1.2 Specification (XHTML)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.pdf" target="_blank" rel="external noopener">DITA 1.2 Specification (PDF)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.zip" target="_blank" rel="external noopener">DITA 1.2 Specification (DITA source)</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita" target="_blank" rel="external noopener">OASIS DITA Technical Committee</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita-adoption" target="_blank" rel="external noopener">OASIS DITA Adoption Technical Committee</a></li></ul></div></nav>
</article></main></body></html>

53
dita-ot-3.6/doc/reference/dita-v1-3-support.html Normal file
View file

@ -0,0 +1,53 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 provides processing support for the OASIS DITA 1.3 specification. Initial preview support for this specification was added in version 2.0 of the toolkit; version 2.2 extended this foundation to support key scopes and branch filtering along with additional DITA 1.3 features."><meta name="keywords" content=", ditavalref, xmlelement, xmlatt, line-through, overline, object, , div, support, keyscope, deliveryTarget, orient, keyref, cascade, profiling, filters, branch filters, DTD, schema, DITA 1.3, grammar files, DITA 1.3, specification support, catalog, grammar file resolution"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA 1.3 support</title></head><body id="dita-13-spec-support"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li class="active"><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">DITA 1.3 support</h1>
<div class="body conbody"><p class="shortdesc"><span class="ph" id="dita-13-spec-support__shortdesc-ph">DITA Open Toolkit <span class="keyword">3.6</span> provides processing support for the
OASIS DITA 1.3 specification. Initial preview support for this specification was added in version 2.0 of the
toolkit; version 2.2 extended this foundation to support key scopes and branch filtering along with additional
DITA 1.3 features.</span></p>
<p class="p" id="dita-13-spec-support__p">Because DITA 1.3 is fully backwards compatible with previous DITA DTDs and schemas, DITA-OT provides the
1.3 materials as the default grammar files for processing. The XML Catalog resolution maps any references for
unversioned DITA document types to the 1.3 versions. All processing ordinarily dependent on the 1.0, 1.1, or 1.2
definitions continues to work as usual, and any documents that make use of the newer DITA 1.3 elements or
attributes will be supported with specific new processing.</p>
<section class="section"><h2 class="title sectiontitle">Major features of DITA 1.3</h2>
<p class="p">The following DITA 1.3 features are supported in DITA Open Toolkit.</p>
<ul class="ul">
<li class="li">
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/keyScopes.html" target="_blank" rel="external noopener">Scoped keys</a> supported using DITA 1.3 <code class="keyword markupname xmlatt">@keyscope</code>
attribute</li>
<li class="li">
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/branch-filtering.html" target="_blank" rel="external noopener">Branch filtering</a> using <code class="keyword markupname xmlelement">&lt;ditavalref&gt;</code>
elements in a map</li>
<li class="li">Support formatting based on new XML Mention elements, such as adding angle brackets around elements tagged
with <code class="keyword markupname xmlelement">&lt;xmlelement&gt;</code> and adding <code class="ph codeph">@</code> before attributes tagged with
<code class="keyword markupname xmlelement">&lt;xmlatt&gt;</code></li>
<li class="li">New highlighting elements <code class="keyword markupname xmlelement">&lt;line-through&gt;</code> and <code class="keyword markupname xmlelement">&lt;overline&gt;</code></li>
<li class="li">Support for profiling based on <code class="keyword markupname xmlatt">@deliveryTarget</code> attribute</li>
<li class="li">Support for the new <code class="keyword markupname xmlatt">@orient</code> attribute for rotating tables</li>
<li class="li">Profile (filter or flag) based on
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/usage-of-conditional-processing-attributes.html" target="_blank" rel="external noopener">groups within profiling attributes</a></li>
<li class="li"><code class="keyword markupname xmlatt">@keyref</code> and related key referencing attributes supported on
<code class="keyword markupname xmlelement">&lt;object&gt;</code></li>
<li class="li">New in-topic link syntax using <code class="ph codeph">.</code> in place of the topic ID: <code class="ph codeph">#./figure</code></li>
<li class="li">Support for additional new elements, such as the <code class="keyword markupname xmlelement">&lt;div&gt;</code> element for grouping</li>
<li class="li">Support <code class="keyword markupname xmlatt">@cascade</code> attribute in maps (processing defaults to the value <code class="ph codeph">merge</code>,
which is the
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/example-how-cascade-att-functions.html" target="_blank" rel="external noopener">default cascade operation</a> described by the DITA
specification)</li>
</ul>
<div class="note note note_note"><span class="note__title">Note:</span> For the latest status information on DITA 1.3-related features and fixes, see the
<a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=label%3A%22DITA+1.3%22" target="_blank" rel="external noopener">DITA 1.3 label</a> in the GitHub issues tracker.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2017/dita-ot_day.html#Accessibility_DITA-OT" target="_blank" rel="external noopener" title="Not only is accessible content often mandatory, it's also just a good idea -- assuming you want your content available to as many readers as possible. This session provides an overview of the accessibility features in output generated by the DITA-OT. While many features are automated thanks to the semantic nature of DITA elements, others rely on you to make sure your content includes everything it needs to. While going over these features, we will explain how DITA-OT handles your content, while also giving tips for how to ensure your content reaches users on all sorts of devices.">Accessibility in DITA-OT</a></li><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2014/dita-ot_day.html#RNG_to_DTD_and_XSD_using_the_DITA_Open_Toolkit" target="_blank" rel="external noopener" title="The new version of DITA, version 1.3, will use Relax NG as the normative grammar to express the DITA content models. George proposed this idea and provided a working prototype under the DITA-NG open source project and Eliot took this further making it an official proposal for DITA 1.3 and finalized its implementation. See how Relax NG simplifies the way DITA content models and specializations are defined and what other benefits it brings to DITA 1.3.">RNG to DTD and XSD using the DITA Open Toolkit</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.html" target="_blank" rel="external noopener">DITA 1.3 Part 3 latest errata version: All-Inclusive Edition (HTML)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.pdf" target="_blank" rel="external noopener">DITA 1.3 Part 3 latest errata version: All-Inclusive Edition (PDF)</a></li><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part3-all-inclusive/dita-v1.3-errata01-os-part3-all-inclusive-complete-dita.zip" target="_blank" rel="external noopener">DITA Version 1.3 Errata 01 (Distribution ZIP of the DITA source)</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita" target="_blank" rel="external noopener">OASIS DITA Technical Committee</a></li><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita-adoption" target="_blank" rel="external noopener">OASIS DITA Adoption Technical Committee</a></li></ul></div></nav>
</article></main></body></html>

100
dita-ot-3.6/doc/reference/dita-v2-0-support.html Normal file
View file

@ -0,0 +1,100 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit 3.6 provides a preview of features for the upcoming OASIS DITA 2.0 specification. This preliminary processing support is provided on the basis of the latest DRAFT versions of the DITA 2.0 DTD and RELAX&nbsp;NG grammar files from OASIS (as of October 2020)."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA 2.0 preview support</title></head><body id="ID"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li class="active"><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">DITA 2.0 preview support</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit <span class="keyword">3.6</span> provides a preview of features for the upcoming OASIS DITA
2.0 specification. This preliminary processing support is provided on the basis of the latest DRAFT versions of the
DITA 2.0 DTD and RELAX&nbsp;NG grammar files from OASIS (as of October 2020).</p>
<p class="p" id="ID__grammar-files">DITA documents that reference the draft grammar files can be parsed, and where features
overlap with DITA 1.3, those features will work as expected.</p>
<section class="section"><h2 class="title sectiontitle">DITA-OT 3.5</h2>
<p class="p">DITA-OT 3.5 provided an initial preview of DITA 2.0 features.</p>
<ul class="ul">
<li class="li" id="ID__3453">
<p class="p">
<span class="ph" id="ID__include">The new <code class="keyword markupname xmlelement">&lt;include&gt;</code> element can be used to reference text or XML
content from other files. In addition to the processing mandated by the specification, DITA-OT also
supports the character set definition and line range extraction options previously provided for
<code class="keyword markupname xmlelement">&lt;coderef&gt;</code> elements (see
<a class="xref" href="extended-functionality.html" title="DITA-OT provides additional processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for code references, normalize indendation, add line numbers or display whitespace characters in code blocks.">Extended codeblock processing</a>).</span>
</p>
</li>
<li class="li" id="ID__3462">
<p class="p">
<span class="ph" id="ID__specializations">The new <code class="keyword markupname xmlatt">@specializations</code> attribute, which replaces the DITA 1.x
<code class="keyword markupname xmlatt">@domains</code> attribute, can now be used as an alternative method of declaring specialized
attributes.</span>
</p>
</li>
<li class="li" id="ID__3463">
<p class="p">
<span class="ph" id="ID__outputclass">The <code class="keyword markupname xmlatt">@outputclass</code> attribute can now be specified as a flagging behavior
in DITAVAL files. This allows you to flag an element with a CSS class keyword that will be added to the
<code class="keyword markupname xmlatt">@class</code> attribute value in the generated HTML. Output classes allow you to pick up
pre-defined styles from existing web frameworks, and are more easily overridden with custom CSS files than
the inline <code class="keyword markupname xmlatt">@style</code> attributes generated by DITA 1.x flagging options such as
<code class="keyword markupname xmlatt">@color</code> and <code class="keyword markupname xmlatt">@backcolor</code>.</span>
</p>
</li>
<li class="li" id="ID__3464">
<p class="p">
<span class="ph" id="ID__simple-table-titles">Titles can now be specified on simple tables, and
<code class="keyword markupname xmlelement">&lt;simpletable&gt;</code> entries now support row and column spanning attributes.</span>
</p>
</li>
<li class="li" id="ID__3483">
<p class="p">
<span class="ph" id="ID__topic-based-classes">Where DITA 1.x defined conflicting <code class="keyword markupname xmlatt">@class</code> values for
<code class="keyword markupname xmlelement">&lt;linktext&gt;</code>, <code class="keyword markupname xmlelement">&lt;shortdesc&gt;</code>, and
<code class="keyword markupname xmlelement">&lt;searchtitle&gt;</code> in maps and topics, the new draft of DITA 2.0 uses the topic-based
<code class="keyword markupname xmlatt">@class</code> value in all cases. Processing is updated to recognize the updated value when
these elements are used in maps.</span>
</p>
</li>
</ul>
</section>
<section class="section"><h2 class="title sectiontitle">DITA-OT 3.6</h2>
<p class="p">DITA-OT 3.6 adds support for additional DITA 2.0 features.</p>
<ul class="ul" id="ID__added-in-3.6">
<li class="li">Where earlier DITA versions relied on the <code class="keyword markupname xmlelement">&lt;object&gt;</code> to embed media in DITA source
files, DITA 2.0 provides new <code class="keyword markupname xmlelement">&lt;audio&gt;</code> and <code class="keyword markupname xmlelement">&lt;video&gt;</code> elements that
correspond to their HTML5 equivalents.</li>
<li class="li">For HTML5 compatibility, the new emphasis domain adds support for the <code class="keyword markupname xmlelement">&lt;strong&gt;</code> and
<code class="keyword markupname xmlelement">&lt;em&gt;</code> elements in addition to the existing <code class="keyword markupname xmlelement">&lt;b&gt;</code> and
<code class="keyword markupname xmlelement">&lt;i&gt;</code> elements in the highlighting domain.</li>
<li class="li">The troubleshooting domain has been updated with additional constructs that can be used to provide detailed
diagnostic information.</li>
<li class="li">Several obsolete elements and attributes have been removed from DITA 2.0, including:
<ul class="ul">
<li class="li"><code class="keyword markupname xmlelement">&lt;boolean&gt;</code></li>
<li class="li"><code class="keyword markupname xmlelement">&lt;data-about&gt;</code></li>
<li class="li"><code class="keyword markupname xmlelement">&lt;indextermref&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@alt</code> on <code class="keyword markupname xmlelement">&lt;image&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@navtitle</code> on <code class="keyword markupname xmlelement">&lt;topicref&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@query</code> on <code class="keyword markupname xmlelement">&lt;topicref&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@refcols</code> on <code class="keyword markupname xmlelement">&lt;simpletable&gt;</code></li>
<li class="li"><code class="keyword markupname xmlatt">@xtrc</code></li>
<li class="li"><code class="keyword markupname xmlatt">@xtrf</code></li>
</ul>
</li>
</ul>
<div class="note note note_note" id="ID__more-to-come"><span class="note__title">Note:</span> Other new or revised features proposed for DITA 2.0 are not yet supported. Additional
features will be implemented in future versions of DITA-OT as the specification evolves.</div>
<div class="note tip note_tip"><span class="note__title">Tip:</span> For the latest status information on DITA 2.0-related features and fixes, see the
<a class="xref" href="https://github.com/dita-ot/dita-ot/issues?q=label%3A%22DITA+2.0%22" target="_blank" rel="external noopener">DITA 2.0 label</a> in the GitHub issues tracker.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita" target="_blank" rel="external noopener">OASIS DITA Technical Committee</a></li></ul></div></nav>
</article></main></body></html>

145
dita-ot-3.6/doc/reference/docs-dita-features.html Normal file
View file

@ -0,0 +1,145 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit uses various recent DITA features in the project documentation."><meta name="keywords" content=", audience, orient, profiling, branch filters, Antenna House, DITA XML mention domain, DITA 1.3, XML mention domain"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>DITA features in the documentation</title></head><body id="ID"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li class="active"><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">DITA features in the documentation</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit uses various recent DITA features in the project documentation.</p>
<p class="p">The
<a class="xref" href="https://github.com/dita-ot/docs" target="_blank" rel="external noopener">source files</a> for the DITA-OT
documentation include examples of the following DITA features (among others):</p>
<ul class="ul">
<li class="li">subjectScheme classification for controlling available attributes</li>
<li class="li">profiling and branch filtering (novice/expert content)</li>
<li class="li">extending topics with conref push</li>
<li class="li">keys and key references</li>
<li class="li">XML mention domain</li>
</ul>
<section class="section"><h2 class="title sectiontitle">Subject schemes </h2>
<p class="p">Various topics, sections and elements in the docs are profiled by audience:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;li id="novice-variables-last" audience="novice"&gt;
&lt;p id="common-format-info"&gt;
&lt;varname&gt;format&lt;/varname&gt; is the output format (transformation type). This argument corresponds to the
common parameter &lt;parmname&gt;transtype&lt;/parmname&gt;. Use the same values as for the
&lt;parmname&gt;transtype&lt;/parmname&gt; build parameter, for example &lt;option&gt;html5&lt;/option&gt; or
&lt;option&gt;pdf&lt;/option&gt;.&lt;/p&gt;
&lt;/li&gt;</code></pre></div>
<p class="p">An “audience” subject scheme controls the values that are available for the <code class="keyword markupname xmlatt">@audience</code>
attribute:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;subjectdef keys="audience"&gt;
&lt;subjectdef keys="novice"/&gt;
&lt;subjectdef keys="expert"/&gt;
&lt;subjectdef keys="xslt-customizer"/&gt;
&lt;/subjectdef&gt;</code></pre></div>
<p class="p">A dedicated subject scheme map defines several series of permissible values for <code class="keyword markupname xmlatt">@outputclass</code>
attributes, which apply styling to elements on the project website, enable
<a class="xref" href="extended-functionality.html" title="DITA-OT provides additional processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for code references, normalize indendation, add line numbers or display whitespace characters in code blocks.">extended codeblock processing</a> such as whitespace visualization and
line numbering in PDF output, or trigger
<a class="xref" href="https://www.w3.org/TR/html52/textlevel-semantics.html#the-code-element" target="_blank" rel="external noopener">HTML5-compliant syntax highlighting</a> via
<a class="xref" href="https://prismjs.com" target="_blank" rel="external noopener">prism.js</a>.</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;schemeref href="subjectscheme-outputclass.ditamap"/&gt;</code></pre></div>
</section>
<section class="section"><h2 class="title sectiontitle">Branch filtering: re-using profiled content</h2>
</section>
<section class="section">
<p class="p"><cite class="cite">Installing DITA-OT</cite> pulls a subset of the build description from <cite class="cite">using the
<span class="keyword cmdname">dita</span> command</cite>, filtered to display only content deemed suitable for novice users
under
<a class="xref" href="../topics/first-build-using-dita-command.html" title="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Building output</a>:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;topicref href="using-dita-command.dita"
keys="first-build-using-dita-command" locktitle="yes"&gt;
&lt;topicmeta&gt;
&lt;navtitle&gt;Building output&lt;/navtitle&gt;
&lt;/topicmeta&gt;
&lt;ditavalref href="../resources/novice.ditaval"&gt;
&lt;ditavalmeta&gt;
&lt;dvrResourcePrefix&gt;first-build-&lt;/dvrResourcePrefix&gt;
&lt;/ditavalmeta&gt;
&lt;/ditavalref&gt;
&lt;/topicref&gt;</code></pre></div>
<p class="p">The same content appears later in
<a class="xref" href="../topics/build-using-dita-command.html" title="You can generate output using the dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Using the dita command</a> with additional information on arguments, options and examples.</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;topicref href="using-dita-command.dita"
keys="build-using-dita-command" locktitle="yes"&gt;
&lt;topicmeta&gt;
&lt;navtitle&gt;Using the &lt;cmdname&gt;dita&lt;/cmdname&gt; command&lt;/navtitle&gt;
&lt;/topicmeta&gt;
&lt;ditavalref href="../resources/expert.ditaval"&gt;
&lt;ditavalmeta&gt;
&lt;dvrResourcePrefix&gt;build-&lt;/dvrResourcePrefix&gt;
&lt;/ditavalmeta&gt;
&lt;/ditavalref&gt;</code></pre></div>
</section>
<section class="section"><h2 class="title sectiontitle">Conref push</h2>
</section>
<section class="section">
<p class="p">The docs build uses the conref push mechanism (with the <code class="ph codeph">pushreplace</code>, <code class="ph codeph">mark</code>,
and <code class="ph codeph">pushafter</code>
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/langRef/attributes/theconactionattribute.html" target="_blank" rel="external noopener">conactions</a>) to extend the parameter descriptions embedded in the
default plug-ins:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;plentry id="args.csspath"&gt;
&lt;pt&gt;
&lt;parmname&gt;args.csspath&lt;/parmname&gt;
&lt;/pt&gt;
&lt;pd conaction="pushreplace" conref="parameters-html5.dita#html5/args.csspath.desc"&gt;
&lt;div conref="./ant-parameters-details.dita#base-html/args.csspath.desc"/&gt;
&lt;/pd&gt;
&lt;pd conaction="mark" conref="parameters-html5.dita#html5/args.csspath.desc"/&gt;
&lt;pd conaction="pushafter"&gt;
&lt;div conref="./ant-parameters-details.dita#base-html/args.csspath.details"/&gt;
&lt;/pd&gt;
&lt;/plentry&gt;</code></pre></div>
<p class="p">The pushed content appears in the output after the default description. (See
<a class="xref" href="../parameters/parameters-base-html.html" title="Certain parameters apply to all HTML-based transformation types: HTML5, XHTML, HTML&nbsp;Help, and Eclipse help.">HTML-based output parameters</a>.)</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> You could also use the same mechanism to extend the documentation with custom information that
applies only to your company’s toolkit distribution.</div>
</section>
<section class="section"><h2 class="title sectiontitle">Keys and key references</h2>
</section>
<section class="section">
<p class="p">The <code class="ph codeph">key-definitions.ditamap</code> defines keys for version references, re-usable links, etc.</p>
<p class="p">This key definition defines the maintenance release version:</p>
<div class="p"><pre class="pre codeblock language-xml normalize-space"><code>&lt;keydef keys="maintenance-version"&gt;
&lt;topicmeta&gt;
&lt;keywords&gt;
&lt;keyword&gt;3.6&lt;/keyword&gt;
&lt;/keywords&gt;
&lt;/topicmeta&gt;
&lt;/keydef&gt;</code></pre></div>
<p class="p">In topics, the keyword is used in place of hard-coded version references:</p>
<pre class="pre codeblock language-xml"><code>&lt;title&gt;DITA Open Toolkit &lt;keyword keyref="maintenance-version"/&gt; Release Notes&lt;/title&gt;</code></pre>
</section>
<section class="section"><h2 class="title sectiontitle">XML mention domain</h2>
</section>
<section class="section">
<p class="p">The docs use the
<a class="xref" href="http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/langRef/containers/xml-mention-domain.html#xml-mention-domain" target="_blank" rel="external noopener">XML mention domain</a> to mark up XML elements and attributes:</p>
<pre class="pre codeblock language-xml"><code>&lt;li id="1777"&gt;
DITA 1.3: Initial support has been added for the &lt;xmlatt&gt;orient&lt;/xmlatt&gt;
attribute on &lt;xmlelement&gt;table&lt;/xmlelement&gt; elements. These changes allow
Antenna House Formatter to render tables in landscape mode when the
&lt;xmlatt&gt;orient&lt;/xmlatt&gt; attribute is set to &lt;option&gt;land&lt;/option&gt;. […]
&lt;/li&gt;</code></pre>
<p class="p">When the toolkit generates output for the sample above:</p>
<ul class="ul">
<li class="li">the XML element name is wrapped in angle brackets as <code class="keyword markupname xmlelement">&lt;table&gt;</code>
</li>
<li class="li">the attribute name is prefixed with an “at” sign as <code class="keyword markupname xmlatt">@orient</code></li>
</ul>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div></nav></article></main></body></html>

62
dita-ot-3.6/doc/reference/eclipsehelp-processing.html Normal file
View file

@ -0,0 +1,62 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The eclipsehelp transformation generates XHTML-based output and files that are needed to create an Eclipse Help system plug-in. Once the normal XHTML process has run, the dita.map.eclipse target is used to create a set of control files and navigation files."><meta name="keywords" content="HTML, Eclipse Help, dita.map.eclipse, targets, index, table of contents"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Eclipse help processing</title></head><body id="xhtmleclipse"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li class="active"><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Eclipse help processing</h1>
<div class="body conbody"><p class="shortdesc">The <span class="keyword option">eclipsehelp</span> transformation generates XHTML-based output and files that are needed to
create an Eclipse Help system plug-in. Once the normal XHTML process has run, the <code class="ph codeph">dita.map.eclipse</code>
target is used to create a set of control files and navigation files.</p>
<section class="section">
<p class="p">Eclipse uses multiple files to control the plug-in behavior. Some of these control files are generated by the
build, while others might be created manually. The following Ant targets control the Eclipse help
processing:</p>
<div class="p">
<dl class="dl">
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.init</code></dt>
<dd class="dd">Sets up various default properties</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.toc</code></dt>
<dd class="dd">Creates the XML file that defines an Eclipse table of contents</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.index</code></dt>
<dd class="dd">Creates the sorted XML file that defines an Eclipse index</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.plugin</code></dt>
<dd class="dd">Creates the <span class="ph filepath">plugin.xml</span> file that controls the behavior of an Eclipse plug-in</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.plugin.properties</code></dt>
<dd class="dd">Creates a Java properties file that sets properties for the plug-in, such as name and version
information</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.manifest.file</code></dt>
<dd class="dd">Creates a <span class="ph filepath">MANIFEST.MF</span> file that contains additional information used by
Eclipse</dd>
<dt class="dt dlterm"><code class="ph codeph">copy-plugin-files</code></dt>
<dd class="dd">Checks for the presence of certain control files in the source directory, and copies those found to the
output directory</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.map.eclipse.fragment.language.init</code></dt>
<dd class="dd">Works in conjunction with the <code class="ph codeph">dita.map.eclipse.fragment.language.country.init</code> and
<code class="ph codeph">dita.map.eclipse.fragment.error</code> targets to control Eclipse fragment files, which are
used for versions of a plug-in created for a new language or locale</dd>
</dl>
</div>
<p class="p">Several of the targets listed above have matching templates for processing content that is located outside of
the scope of the map directory, such as <code class="ph codeph">dita.out.map.eclipse.toc</code>.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

145
dita-ot-3.6/doc/reference/extended-functionality.html Normal file
View file

@ -0,0 +1,145 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA-OT provides additional processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for code references, normalize indendation, add line numbers or display whitespace characters in code blocks."><meta name="keywords" content=", coderef, codeblock, format, outputclass, encoding, DOTJ052E, character set"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extended codeblock processing</title></head><body id="code-reference"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li class="active"><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Extended codeblock processing</h1>
<div class="body refbody"><p class="shortdesc">DITA-OT provides additional processing support beyond that which is mandated by the DITA specification.
These extensions can be used to define character encodings or line ranges for code references, normalize
indendation, add line numbers or display whitespace characters in code blocks.</p>
<section class="section" id="code-reference__coderef-charset"><h2 class="title sectiontitle">Character set definition</h2>
<p class="p">For <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> elements, DITA-OT supports defining the code reference target file
encoding using the <code class="keyword markupname xmlatt">@format</code> attribute. The supported format is:</p>
<pre class="pre codeblock"><code>format (";" space* "charset=" charset)?</code></pre>
<p class="p">If a character set is not defined, the system default character set will be used. If the character set is not
recognized or supported, the <span class="keyword msgnum">DOTJ052E</span> error is thrown and the system default character set is
used as a fallback.</p>
<pre class="pre codeblock language-xml"><code>&lt;coderef href="unicode.txt" format="txt; charset=UTF-8"/&gt;</code></pre>
<p class="p">As of DITA-OT 3.3, the default character set for code references can be changed by adding the
<span class="keyword parmname">default.coderef-charset</span> key to the
<a class="xref" href="../parameters/configuration-properties-file.html" title="The configuration.properties file controls certain common properties, as well as some properties that control PDF processing.">configuration.properties</a> file:</p>
<pre class="pre codeblock language-properties"><code>default.coderef-charset = ISO-8859-1</code></pre>
<p class="p">The character set values are those supported by the Java
<a class="xref" href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" target="_blank" rel="external noopener">Charset</a> class.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Line range extraction</h2>
<p class="p">Code references can be limited to extract only a specified line range by defining the
<code class="ph codeph">line-range</code> pointer in the URI fragment. The format is:</p>
<pre class="pre codeblock"><code>uri ("#line-range(" start ("," end)? ")" )?</code></pre>
<p class="p">Start and end line numbers start from 1 and are inclusive. If the end range is omitted, the range ends on the
last line of the file.</p>
</section>
<div class="example">
<pre class="pre codeblock language-xml"><code>&lt;coderef href="Parser.scala#line-range(5,10)" format="scala"/&gt;</code></pre>
<p class="p">Only lines from 5 to 10 will be included in the output.</p>
</div>
<section class="section"><h2 class="title sectiontitle">RFC 5147</h2>
<p class="p">DITA-OT also supports the line position and range syntax from
<a class="xref" href="http://tools.ietf.org/html/rfc5147" target="_blank" rel="external noopener">RFC 5147</a>. The format for line range is:</p>
<pre class="pre codeblock"><code>uri ("#line=" start? "," end? )?</code></pre>
<p class="p">Start and end line numbers start from 0 and are inclusive and exclusive, respectively. If the start range is
omitted, the range starts from the first line; if the end range is omitted, the range ends on the last line of
the file. The format for line position is:</p>
<pre class="pre codeblock"><code>uri ("#line=" position )?</code></pre>
<p class="p">The position line number starts from 0.</p>
</section>
<div class="example">
<pre class="pre codeblock language-xml"><code>&lt;coderef href="Parser.scala#line=4,10" format="scala"/&gt;</code></pre>
<p class="p">Only lines from 5 to 10 will be included in the output.</p>
</div>
<section class="section"><h2 class="title sectiontitle">Line range by content</h2>
<p class="p">Instead of specifying line numbers, you can also select lines to include in the code reference by specifying
keywords (or “<dfn class="term">tokens</dfn>”) that appear in the referenced file.</p>
<div class="div" id="code-reference__coderef-by-content">
<p class="p">DITA-OT supports the <code class="ph codeph">token</code> pointer in the URI fragment to extract a line range based on the
file content. The format for referencing a range of lines by content is:</p>
<pre class="pre codeblock"><code>uri ("#token=" start? ("," end)? )?</code></pre>
<p class="p">Lines identified using start and end tokens are exclusive: the lines that contain the start token and end
token will be not be included. If the start token is omitted, the range starts from the first line in the
file; if the end token is omitted, the range ends on the last line of the file. </p>
</div>
</section>
<div class="example">
<p class="p">Given a Haskell source file named <span class="ph filepath">fact.hs</span> with the following content,</p>
<pre class="pre codeblock language-haskell normalize-space show-line-numbers show-whitespace"><code>-- START-FACT
fact :: Int -&gt; Int
fact 0 = 1
fact n = n * fact (n-1)
-- END-FACT
main = print $ fact 7</code></pre>
<p class="p">a range of lines can be referenced as:</p>
<pre class="pre codeblock language-xml"><code>&lt;coderef href="fact.hs#token=START-FACT,END-FACT"/&gt;</code></pre>
<p class="p">to include the range of lines that follows the <code class="ph codeph">START-FACT</code> token on Line 1, up to (but not
including) the line that contains the <code class="ph codeph">END-FACT</code> token (Line 5). The resulting
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> would contain lines 2–4:</p>
<pre class="pre codeblock language-haskell"><code>fact :: Int -&gt; Int
fact 0 = 1
fact n = n * fact (n-1)</code></pre>
<div class="note tip note_tip" id="code-reference__coderef-by-content-tip"><span class="note__title">Tip:</span> This approach can be used to reference code samples that are
frequently edited. In these cases, referencing line ranges by line number can be error-prone, as the target line
range for the reference may shift if preceding lines are added or removed. Specifying ranges by line content
makes references more robust, as long as the <code class="ph codeph">token</code> keywords are preserved when the referenced
resource is modified.</div></div>
<div class="bodydiv refbodydiv" id="code-reference__normalize-codeblock-whitespace">
<section class="section"><h2 class="title sectiontitle">Whitespace normalization</h2>
<p class="p">DITA-OT can adjust the leading whitespace in code blocks to remove excess indentation and keep lines short.
Given an XML snippet in a codeblock with lines that all begin with spaces (indicated here as dots “·”),</p>
</section>
<div class="example">
<div class="p"><pre class="pre codeblock language-xml"><code>··&lt;subjectdef keys="audience"&gt;
····&lt;subjectdef keys="novice"/&gt;
····&lt;subjectdef keys="expert"/&gt;
··&lt;/subjectdef&gt;</code></pre></div>
<p class="p">DITA-OT can remove the leading whitespace that is common to all lines in the code block. To trim the excess
space, set the <code class="keyword markupname xmlatt">@outputclass</code> attribute on the <code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element to
include the <code class="ph codeph">normalize-space</code> keyword.</p>
<p class="p">In this case, two spaces (“··”) would be removed from the beginning of each line, shifting content to the
left by two characters, while preserving the indentation of lines that contain additional whitespace (beyond
the common indent):</p>
<div class="p"><pre class="pre codeblock language-xml"><code>&lt;subjectdef keys="audience"&gt;
··&lt;subjectdef keys="novice"/&gt;
··&lt;subjectdef keys="expert"/&gt;
&lt;/subjectdef&gt;</code></pre></div>
</div>
</div>
<div class="bodydiv refbodydiv" id="code-reference__visualize-codeblock-whitespace">
<section class="section"><h2 class="title sectiontitle">Whitespace visualization (PDF)</h2>
<p class="p">DITA-OT can be set to display the whitespace characters in code blocks to visualize indentation in PDF
output.</p>
<p class="p">To enable this feature, set the <code class="keyword markupname xmlatt">@outputclass</code> attribute on the
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element to include the <code class="ph codeph">show-whitespace</code> keyword.</p>
<p class="p">When PDF output is generated, space characters in the code will be replaced with a middle dot or “interpunct”
character (&nbsp;<code class="ph codeph">·</code>&nbsp;); tab characters are replaced with a rightwards arrow and three spaces
(&nbsp;<code class="ph codeph">→&nbsp;&nbsp;&nbsp;</code>&nbsp;).</p>
</section>
</div>
<div class="bodydiv refbodydiv" id="code-reference__codeblock-line-numbers">
<section class="section"><h2 class="title sectiontitle">Line numbering (PDF)</h2>
<p class="p">DITA-OT can be set to add line numbers to code blocks to make it easier to distinguish specific lines.</p>
<p class="p">To enable this feature, set the <code class="keyword markupname xmlatt">@outputclass</code> attribute on the
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element to include the <code class="ph codeph">show-line-numbers</code> keyword.</p>
</section>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div><div class="linklist relconcepts"><strong>Related concepts</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../reference/preprocess-topic-fragment.html" title="The topic-fragment step expands content references to elements in the same topic and resolves references made with the coderef element. This step is implemented in SAX pipes.">Resolve topic fragments and code references (topic-fragment)</a></li></ul></div></nav></article></main></body></html>

183
dita-ot-3.6/doc/reference/flagging-migration.html Normal file
View file

@ -0,0 +1,183 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="This topic is primarily of interest to developers with XHTML transform overrides written prior to DITA-OT 1.7. Due to significant changes in the flagging process with the 1.7 release, some changes may be needed to make overrides work properly with DITAVAL-based flagging. The new design is significantly simpler than the old design; in many cases, migration will consist of deleting old code that is no longer needed."><meta name="keywords" content=", ul, deprecated features, mode=&#34;elementname-fmt&#34;, DITAVAL templates, DITAVAL, template changes in 1.7, CSS, gen-style, flagging"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XHTML migration for flagging updates in DITA-OT 1.7</title></head><body id="flagging-migration"><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 3.6</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></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><ul><li><a href="../topics/plugin-benefits.html">Plug-in benefits</a></li><li><a href="../topics/plugin-configfile.html">Plug-in descriptor file</a></li><li><a href="../topics/plugin-coding-conventions.html">Coding conventions</a></li><li><a href="../topics/plugin-dependencies.html">Plug-in dependencies</a></li><li><a href="../topics/plugin-use-cases.html">Plug-in use cases</a></li><li><a href="../topics/html-customization-plugins.html">Custom HTML plug-ins</a></li><li><a href="../topics/pdf-customization-plugins.html">Custom PDF plug-ins</a></li><li><a href="../topics/globalization.html">Globalizing DITA content</a></li><li><a href="../topics/migration.html">Migrating customizations</a><ul><li><a href="../topics/migrating-to-3.6.html">To 3.6</a></li><li><a href="../topics/migrating-to-3.5.html">To 3.5</a></li><li><a href="../topics/migrating-to-3.4.html">To 3.4</a></li><li><a href="../topics/migrating-to-3.3.html">To 3.3</a></li><li><a href="../topics/migrating-to-3.2.html">To 3.2</a></li><li><a href="../topics/migrating-to-3.1.html">To 3.1</a></li><li><a href="../topics/migrating-to-3.0.html">To 3.0</a></li><li><a href="../topics/migrating-to-2.5.html">To 2.5</a></li><li><a href="../topics/migrating-to-2.4.html">To 2.4</a></li><li><a href="../topics/migrating-to-2.3.html">To 2.3</a></li><li><a href="../topics/migrating-to-2.2.html">To 2.2</a></li><li><a href="../topics/migrating-to-2.1.html">To 2.1</a></li><li><a href="../topics/migrating-to-2.0.html">To 2.0</a></li><li><a href="../topics/migrating-to-1.8.html">To 1.8</a></li><li><a href="../topics/migrating-to-1.7.html">To 1.7</a><ul><li class="active"><a href="../reference/flagging-migration.html">Flagging updates</a></li></ul></li><li><a href="../topics/migrating-to-1.6.html">To 1.6</a></li><li><a href="../topics/migrating-to-1.5.4.html">To 1.5.4</a></li></ul></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">XHTML migration for flagging updates in DITA-OT 1.7</h1>
<div class="body refbody"><p class="shortdesc">This topic is primarily of interest to developers with XHTML transform overrides written prior to DITA-OT
1.7. Due to significant changes in the flagging process with the 1.7 release, some changes may be needed to make
overrides work properly with DITAVAL-based flagging. The new design is significantly simpler than the old design; in
many cases, migration will consist of deleting old code that is no longer needed.</p>
<section class="section"><h2 class="title sectiontitle">Which XHTML overrides need to migrate?</h2>
<p class="p">If your override does not contain any code related to DITAVAL flagging, then there is nothing to migrate.</p>
<p class="p">If your builds do not make use of DITAVAL-based flagging, but call the deprecated flagging templates, then you
should override but there is little urgency. You will not see any difference in the output, but those templates
will be removed in a future release.</p>
<div class="p">If you do make use of DITAVAL-based flagging, try using your override with 1.7. Check the elements you
override:
<ol class="ol">
<li class="li">In some cases flags may be doubled. This will be the case if you call routines such as
<code class="ph codeph">"start-flagit"</code>.</li>
<li class="li">In some cases flags may be removed. This will be the case if you call shortcut routines such as
<code class="ph codeph">"revtext"</code> or <code class="ph codeph">"revblock"</code>.</li>
<li class="li">In other cases, flags may still appear properly, in which case migration is less urgent.</li>
</ol></div>
<p class="p">For any override that needs migration, please see the instructions that follow.</p></section>
<section class="section"><h2 class="title sectiontitle">Deprecated templates in DITA-OT 1.7</h2>
<p class="p">All of the old DITAVAL based templates are deprecated in DITA-OT 1.7. If your overrides include any of the
following templates, they should be migrated for the new release; in many cases the templates below will not
have any effect on your output, but all instances should be migrated.</p>
<ul class="ul">
<li class="li">The <code class="ph codeph">"gen-style"</code> template used to add CSS styling</li>
<li class="li">The <code class="ph codeph">"start-flagit"</code> and <code class="ph codeph">"end-flagit"</code> templates used to generate image flags
based on property attributes like @audience</li>
<li class="li">The <code class="ph codeph">"start-revflag"</code> and <code class="ph codeph">"end-revflag"</code> templates, used to generate images
for active revisions</li>
<li class="li">Shortcut templates that group these templates into a single call, such as:
<ul class="ul">
<li class="li"><code class="ph codeph">"start-flags-and-rev"</code> and <code class="ph codeph">"end-flags-and-rev"</code>, used to combine flags
and revisions into one call</li>
<li class="li"><code class="ph codeph">"revblock"</code> and <code class="ph codeph">"revtext"</code>, both used to output start revisions, element
content, and end revisions</li>
<li class="li">The modes <code class="ph codeph">"outputContentsWithFlags"</code> and
<code class="ph codeph">"outputContentsWithFlagsAndStyle"</code>, both used to combine processing for
property/revision flags with content processing</li>
</ul></li>
<li class="li">All other templates that make use of the <code class="ph codeph">$flagrules</code> variable, which is no longer used in
any of the DITA-OT 1.7 code</li>
<li class="li">All templates within <span class="ph filepath">flag.xsl</span> that were called from the templates listed above</li>
<li class="li">Element processing handled with mode="elementname-fmt", such as <code class="ph codeph">mode="ul-fmt"</code> for
processing unordered lists and <code class="ph codeph">mode="section-fmt"</code> for sections.</li>
</ul></section>
<section class="section"><h2 class="title sectiontitle">What replaces the templates?</h2>
<p class="p">The new flagging design described in the preprocess design section now adds literal copies of relevant DITAVAL
elements, along with CSS based flagging information, into the relevant section of the topic. This allows most
flags to be processed in document order; in addition, there is never a need to read the DITAVAL, interpret CSS,
or evaluate flagging logic. The <span class="ph filepath">htmlflag.xsl</span> file contains a few rules to match and process
the start/end flags; in most cases, all code to explicitly process flags can be deleted.</p>
<div class="p">For example, the common logic for most element rules before DITA-OT 1.7 could be boiled down to the following:
<ol class="ol">
<li class="li">Match element </li>
<li class="li">Create <code class="ph codeph">"flagrules"</code> variable by reading DITAVAL for active flags </li>
<li class="li">Output start tag such as <code class="ph codeph">&lt;div&gt;</code> or <code class="ph codeph">&lt;span&gt;</code>
</li>
<li class="li">Call <code class="ph codeph">"commonattributes"</code> and ID processing </li>
<li class="li">Call <code class="ph codeph">"gen-style"</code> with <code class="ph codeph">$flagrules</code>, to create DITAVAL based CSS </li>
<li class="li">Call <code class="ph codeph">"start-flagit"</code> with <code class="ph codeph">$flagrules</code>, to create start flag images </li>
<li class="li">Call <code class="ph codeph">"start-revflag"</code> with <code class="ph codeph">$flagrules</code>, to create start revision images </li>
<li class="li">Output contents </li>
<li class="li">Call <code class="ph codeph">"end-revflag"</code> with <code class="ph codeph">$flagrules</code>, to create end revision images </li>
<li class="li">Call <code class="ph codeph">"end-flagit"</code> with <code class="ph codeph">$flagrules</code>, to create end flag images </li>
<li class="li">Output end tag such as <code class="ph codeph">&lt;/div&gt;</code> or <code class="ph codeph">&lt;/span&gt;</code></li>
</ol>
</div>
<p class="p">In DITA-OT 1.7, style and images are typically handled with XSLT fallthrough processing. This removes virtually
all special flag coding from element rules, because flags are already part of the document and processed in
document order. </p>
<div class="p">The sample above is reduced to:
<ol class="ol">
<li class="li">Match element </li>
<li class="li">Output start tag such as <code class="ph codeph">&lt;div&gt;</code> or <code class="ph codeph">&lt;span&gt;</code>
</li>
<li class="li">Call <code class="ph codeph">"commonattributes"</code> and ID processing </li>
<li class="li">Output contents </li>
<li class="li">Output end tag such as <code class="ph codeph">&lt;/div&gt;</code> or <code class="ph codeph">&lt;/span&gt;</code></li>
</ol>
</div>
</section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"gen-style"</code> named template</h2>
<p class="p">Calls to the <code class="ph codeph">"gen-style"</code> template should be deleted. There is no need to replace this call for
most elements.</p>
<p class="p">The <code class="ph codeph">"gen-style"</code> template was designed to read a DITAVAL file, find active style-based flagging
(such as colored or bold text), and add it to the generated @style attribute in HTML.</p>
<div class="p">With DITA-OT 1.7, the style is calculated in the pre-process flagging module. The result is created as
@outputclass on a <code class="ph codeph">&lt;ditaval-startprop&gt;</code> sub-element. The <code class="ph codeph">"commonattributes"</code>
template now includes a line to process that value; the result is that for every element that calls
<code class="ph codeph">"commonattributes"</code>, DITAVAL style will be processed when needed. Because virtually every
element includes a call to this common template, there is little chance that your override needs to explicitly
process the style. The new line in <code class="ph codeph">"commonattributes"</code> that handles the style is:
<pre class="pre codeblock language-xml"><code>&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]/@outputclass" mode="add-ditaval-style"/&gt;</code></pre></div></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"start-flagit"</code>, <code class="ph codeph">"start-revflag"</code>, <code class="ph codeph">"end-flagit"</code>,
and <code class="ph codeph">"end-flagit"</code> named templates</h2>
<p class="p">Calls to these templates fall into two general groups.</p>
<p class="p">If the flow of your element rule is to create a start tag like <code class="ph codeph">&lt;div&gt;</code>,
<code class="ph codeph">"start-flagit"</code>/<code class="ph codeph">"start-revflag"</code>, process contents,
<code class="ph codeph">"end-revflag"</code>/<code class="ph codeph">"end-flagit"</code>, end tag - you just need to delete the calls to
these templates. Flags will be generated simply by processing the element contents in document order.</p>
<p class="p">If the flow of your element rule processes flags outside of the normal document-order. There are generally two
reasons this is done. The first case is for elements like <code class="ph codeph">&lt;ol&gt;</code>, where flags must appear
before the <code class="ph codeph">&lt;ol&gt;</code> in order to create valid XHTML. The second is for elements like
<code class="ph codeph">&lt;section&gt;</code>, where start flags are created, followed by the title or some generated text,
element contents, and finally end flags. In either of these cases, support for processing flags in document
order is disabled, so they must be explicitly processed out-of-line.</p>
<p class="p">This is done with the following two lines (one for start flag/revision, one for end flag/revision):</p>
<ul class="ul">
<li class="li">
<p class="p">Create starting flag and revision images:</p>
<pre class="pre codeblock language-xml"><code>&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]" mode="out-of-line"/&gt;</code></pre></li>
<li class="li">
<p class="p">Create ending flag and revision images:</p>
<pre class="pre codeblock language-xml"><code>&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-endprop ')]" mode="out-of-line"/&gt;</code></pre></li>
</ul>
<div class="p">For example, the following lines are used in DITA-OT 1.7 to process the <code class="keyword markupname xmlelement">&lt;ul&gt;</code> element
(replacing the 29 lines used in DITA-OT
1.6):<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;xsl:template match="*[contains(@class,' topic/ul ')]"&gt;
<strong class="ph b">&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-startprop ')]" mode="out-of-line"/&gt;</strong>
&lt;xsl:call-template name="setaname"/&gt;
&lt;ul&gt;
&lt;xsl:call-template name="commonattributes"/&gt;
&lt;xsl:apply-templates select="@compact"/&gt;
&lt;xsl:call-template name="setid"/&gt;
&lt;xsl:apply-templates/&gt;
&lt;/ul&gt;
<strong class="ph b">&lt;xsl:apply-templates select="*[contains(@class,' ditaot-d/ditaval-endprop ')]" mode="out-of-line"/&gt;</strong>
&lt;xsl:value-of select="$newline"/&gt;
&lt;/xsl:template&gt;</code></pre></div></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"start-flags-and-rev"</code> and <code class="ph codeph">"end-flags-and-rev"</code></h2>
<ul class="ul">
<li class="li"><code class="ph codeph">"start-flags-and-rev"</code> is equivalent to calling <code class="ph codeph">"start-flagit"</code> followed by
<code class="ph codeph">"start-revflag"</code>; it should be migrated as in the previous section.</li>
<li class="li"><code class="ph codeph">"end-flags-and-rev"</code> is equivalent to calling <code class="ph codeph">"end-revflag"</code> followed by
<code class="ph codeph">"end-flagit"</code>; it should be migrated as in the previous section.</li>
</ul></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">"revblock"</code> and <code class="ph codeph">"revtext"</code></h2>
<p class="p">Calls to these two templates can be replaced with a simple call to
<code class="ph codeph">&lt;xsl:apply-templates/&gt;</code>.</p></section>
<section class="section"><h2 class="title sectiontitle">Migrating modes <code class="ph codeph">"outputContentsWithFlags"</code> and
<code class="ph codeph">"outputContentsWithFlagsAndStyle"</code></h2>
<p class="p">Processing an element with either of these modes can be replaced with a simple call to
<code class="ph codeph">&lt;xsl:apply-templates/&gt;</code>.</p></section>
<section class="section"><h2 class="title sectiontitle">Migrating <code class="ph codeph">mode="elementname-fmt"</code></h2>
<div class="p">Prior to DITA-OT 1.7, many elements were processed with the following
logic:<pre class="pre">Match element
Set variable to determine if revisions are active and $DRAFT is on
If active
create division with rev style
process element with mode="elementname-fmt"
end division
Else
process element with mode="elementname-fmt"
Match element with mode="elementname-fmt"
Process as needed</pre></div>
<p class="p">Beginning with DITA-OT 1.7, styling from revisions is handled automatically with the
<code class="ph codeph">"commonattributes"</code> template. This means there is no need for the extra testing, or the
indirection to <code class="ph codeph">mode="elementname-fmt"</code>. These templates are deprecated, and element processing
will move into the main element rule. Overrides that include this indirection may remove it; overrides should
also be sure to match the default rule, rather than matching with
<code class="ph codeph">mode="elementname-fmt"</code>.</p></section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/migrating-to-1.7.html" title="In DITA-OT 1.7, a new preprocessing step implements flagging for HTML-based output formats. PDF processing was corrected with regard to shortdesc handling, and a new XSLT template mode was introduced for HTML TOC processing. Several stylesheets were moved to plug-in specific folders and deprecated properties and XSLT variables were removed.">Migrating to release 1.7</a></div></div></nav></article></main></body></html>

80
dita-ot-3.6/doc/reference/glossary.html Normal file
View file

@ -0,0 +1,80 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Certain terms have particular meaning in the context of the DITA Open Toolkit project."><meta name="keywords" content="DOST"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Glossary</title></head><body><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li class="active"><a href="../reference/glossary.html#glossary">Glossary</a><ul><li><a href="../reference/glossary.html#gloss-argument">argument</a></li><li><a href="../reference/glossary.html#gloss-dita-open-toolkit">DITA Open Toolkit</a></li><li><a href="../reference/glossary.html#gloss-extension-point">extension point</a></li><li><a href="../reference/glossary.html#gloss-option">option</a></li><li><a href="../reference/glossary.html#gloss-output-format">output format</a></li><li><a href="../reference/glossary.html#gloss-parameter">parameter</a></li><li><a href="../reference/glossary.html#gloss-plug-in">plug-in</a></li><li><a href="../reference/glossary.html#gloss-processor">processor</a></li><li><a href="../reference/glossary.html#gloss-property">property</a></li><li><a href="../reference/glossary.html#gloss-template-plugin">template</a></li><li><a href="../reference/glossary.html#gloss-transformation-type">transformation type</a></li><li><a href="../reference/glossary.html#gloss-variable">variable</a></li><li><a href="../reference/glossary.html#gloss-template-xslt">XSL template</a></li></ul></li></ul></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"><article class="nested0" aria-labelledby="ariaid-title1" id="glossary">
<h1 class="title topictitle1" id="ariaid-title1">Glossary</h1>
<p class="shortdesc">Certain terms have particular meaning in the context of the DITA Open Toolkit project.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a></div></div></nav><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title2" id="gloss-argument">
<h2 class="title glossterm topictitle2" id="ariaid-title2">argument</h2>
<div class="abstract glossdef">Required parameter passed to the Ant process or <span class="keyword cmdname">dita</span> command.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title3" id="gloss-dita-open-toolkit">
<h2 class="title glossterm topictitle2" id="ariaid-title3">DITA Open Toolkit</h2>
<div class="body conbody glossBody"><div class="abstract glossdef">The open-source publishing engine for content authored in the Darwin Information Typing
Architecture.</div>
<section class="section glossAlt"><h3 class="title glossAbbreviation sectiontitle">DITA-OT</h3>
<div class="note glossUsage note note_note"><span class="note__title">Note:</span> Treat as a proper noun; do not precede with <em class="ph i">the</em> definite article.</div>
</section>
<section class="section glossAlt"><h3 class="title glossAcronym sectiontitle">DOST</h3>
<div class="note glossUsage note note_note"><span class="note__title">Note:</span> Deprecated acronym for “<strong class="ph b">D</strong>ITA <strong class="ph b">O</strong>pen <em class="ph i"><strong class="ph b">S</strong>ource</em>
<strong class="ph b">T</strong>oolkit”. Use <dfn class="term">DITA-OT</dfn> instead.</div>
</section>
</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title4" id="gloss-extension-point">
<h2 class="title glossterm topictitle2" id="ariaid-title4">extension point</h2>
<div class="abstract glossdef">Pre-defined interface that can be added to a plug-in to allow other plug-ins to extend or customize portions
of its functionality. An extendable feature is defined by declaring an <code class="keyword markupname xmlelement">&lt;extension-point&gt;</code>
element in the <span class="ph filepath">plugin.xml</span> file. Other plug-ins can then override the default behavior by
defining custom code that runs when this extension point is called.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title5" id="gloss-option">
<h2 class="title glossterm topictitle2" id="ariaid-title5">option</h2>
<div class="abstract glossdef">Discretionary parameter passed to the Ant process or <span class="keyword cmdname">dita</span> command.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title6" id="gloss-output-format">
<h2 class="title glossterm topictitle2" id="ariaid-title6">output format</h2>
<div class="abstract glossdef">Deliverable file or set of files containing all of the transformed content.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title7" id="gloss-parameter">
<h2 class="title glossterm topictitle2" id="ariaid-title7">parameter</h2>
<div class="abstract glossdef">Command-line argument or option passed to the Ant process or <span class="keyword cmdname">dita</span> command.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title8" id="gloss-plug-in">
<h2 class="title glossterm topictitle2" id="ariaid-title8">plug-in</h2>
<div class="abstract glossdef">Group of related files that change the default behavior of DITA-OT in some way.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title9" id="gloss-processor">
<h2 class="title glossterm topictitle2" id="ariaid-title9">processor</h2>
<div class="abstract glossdef">Software that performs a series of operations to transform DITA content from one format to
another.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title10" id="gloss-property">
<h2 class="title glossterm topictitle2" id="ariaid-title10">property</h2>
<div class="abstract glossdef">Ant-specific argument or option.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title11" id="gloss-template-plugin">
<h2 class="title glossterm topictitle2" id="ariaid-title11">template</h2>
<div class="abstract glossdef">Optional <code class="keyword markupname xmlelement">&lt;template&gt;</code> elements can be added to <span class="ph filepath">plugin.xml</span> files to
define XML or XSL files that integrate DITA-OT extensions. Template files are often named with a
<span class="ph filepath">_template</span> suffix, and may be used to create custom extensions, group targets, and more.
Anything contained in the plug-in’s template files is integrated when the plug-in is installed.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title12" id="gloss-transformation-type">
<h2 class="title glossterm topictitle2" id="ariaid-title12">transformation type</h2>
<div class="body conbody glossBody"><div class="abstract glossdef">Component of a plug-in that defines an output format.</div>
<section class="section glossAlt"><h3 class="title glossAbbreviation sectiontitle">transtype</h3>
<div class="note glossUsage note note_note"><span class="note__title">Note:</span> Abbreviated form of <dfn class="term">transformation type</dfn>. Use only to refer to the
<span class="keyword parmname">transtype</span> parameter of the <span class="keyword cmdname">dita</span> command, or to the
<code class="keyword markupname xmlelement">&lt;transtype&gt;</code> element in a <span class="ph filepath">plugin.xml</span> file that defines the output
format.</div>
</section>
</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title13" id="gloss-variable">
<h2 class="title glossterm topictitle2" id="ariaid-title13">variable</h2>
<div class="abstract glossdef">Language-specific piece of generated text, most often defined in the files in
<span class="ph filepath">org.dita.base\xsl\common</span>.</div>
</article><article class="topic concept glossentry nested1" aria-labelledby="ariaid-title14" id="gloss-template-xslt">
<h2 class="title glossterm topictitle2" id="ariaid-title14">XSL template</h2>
<div class="abstract glossdef">Set of rules in an XSL stylesheet that are applied to nodes that match specific XML structures.</div>
</article></article></article></main></body></html>

16
dita-ot-3.6/doc/reference/html-based-processing.html Normal file
View file

@ -0,0 +1,16 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files."><meta name="keywords" content="HTML, various output types, pipelines, 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 processing modules</title></head><body id="xhtmlwithnavigation"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li class="active"><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">HTML-based processing modules</h1>
<div class="body conbody"><p class="shortdesc">DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through
the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after
which they generate HTML files and then branch to create the transformation-specific navigation files.</p>
<section class="section">
</section>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/common-html-processing.html">Common HTML-based processing</a></strong><br>After the pre-processing operation runs, HTML-based builds each run a common series of Ant targets to generate HTML file. Navigation may be created before or after this set of common routines.</li><li class="link ulchildlink"><strong><a href="../reference/xhtml-processing.html">XHTML processing</a></strong><br>After the XHTML files are generated by the common routine, the <code class="ph codeph">dita.map.xhtml</code> target is called by the <span class="keyword option">xhtml</span> transformation. This target generates a TOC file called <span class="ph filepath">index.html</span>, which can be loaded into a frameset.</li><li class="link ulchildlink"><strong><a href="../reference/html5-processing.html">HTML5 processing</a></strong><br>After the HTML5 files are generated, the <span class="keyword option">html5</span> transformation generates a table of contents (ToC) file called <span class="ph filepath">index.html</span>, which can be loaded as a cover page or rendered in a navigation sidebar or menu via CSS.</li><li class="link ulchildlink"><strong><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></strong><br>The <span class="keyword option">eclipsehelp</span> transformation generates XHTML-based output and files that are needed to create an Eclipse Help system plug-in. Once the normal XHTML process has run, the <code class="ph codeph">dita.map.eclipse</code> target is used to create a set of control files and navigation files.</li><li class="link ulchildlink"><strong><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></strong><br>The <span class="keyword option">htmlhelp</span> transformation creates HTML Help control files. If the build runs on a system that has the HTML Help compiler installed, the control files are compiled into a CHM file.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

16
dita-ot-3.6/doc/reference/html5-processing.html Normal file
View file

@ -0,0 +1,16 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="After the HTML5 files are generated, the html5 transformation generates a table of contents (ToC) file called index.html, which can be loaded as a cover page or rendered in a navigation sidebar or menu via CSS."><meta name="keywords" content="HTML, HTML5, HTML5, CSS, nav-toc, targets, CSS, entry file"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML5 processing</title></head><body id="ID"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li class="active"><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">HTML5 processing</h1>
<div class="body conbody"><p class="shortdesc">After the HTML5 files are generated, the <span class="keyword option">html5</span> transformation generates a table of
contents (ToC) file called <span class="ph filepath">index.html</span>, which can be loaded as a cover page or rendered in a
navigation sidebar or menu via CSS.</p>
<p class="p">As of DITA-OT 2.2, the <span class="keyword parmname">nav-toc</span> parameter can be used in HTML5 transformations to embed
navigation directly in topics using native HTML5 elements without JavaScript or framesets.</p>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

33
dita-ot-3.6/doc/reference/htmlhelp-processing.html Normal file
View file

@ -0,0 +1,33 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The htmlhelp transformation creates HTML Help control files. If the build runs on a system that has the HTML Help compiler installed, the control files are compiled into a CHM file."><meta name="keywords" content="HTML, CHM, dita.map.htmlhelp, targets, HTML Help, .hhp, .hhc, .hhk"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>HTML Help processing</title></head><body id="xhtmlchm"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li class="active"><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">HTML Help processing</h1>
<div class="body conbody"><p class="shortdesc">The <span class="keyword option">htmlhelp</span> transformation creates HTML Help control files. If the build runs on a system
that has the HTML Help compiler installed, the control files are compiled into a CHM file.</p>
<section class="section">
<p class="p">Once the pre-processing and XHTML processes are completed, most of the HTML Help processing is handled by the
following targets:</p>
<dl class="dl">
<dt class="dt dlterm"><code class="ph codeph">dita.map.htmlhelp</code></dt>
<dd class="dd">Create the HHP, HHC, and HHK files. The HHK file is sorted based on the language of the map.</dd>
<dt class="dt dlterm"><code class="ph codeph">dita.htmlhelp.convertlang</code></dt>
<dd class="dd">Ensures that the content can be processed correctly by the compiler, and that the appropriate code pages
and languages are used.</dd>
<dt class="dt dlterm"><code class="ph codeph">compile.HTML.Help</code></dt>
<dd class="dd">Attempts to detect the HTML Help compiler. If the compiler is found, the full project is compiled into a
single CHM file.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files.">HTML-based processing modules</a></div></div></nav></article></main></body></html>

1
dita-ot-3.6/doc/reference/images/processing-flow.svg Normal file
View file

File diff suppressed because one or more lines are too long
Side by side

After

Width:  |  Height:  |  Size: 18 KiB

114
dita-ot-3.6/doc/reference/implementation-dependent-features.html Normal file
View file

@ -0,0 +1,114 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="For certain features, the DITA specification allows conforming processors to choose between different implementation alternatives. In these cases, there may be differences in behavior when DITA content is handled by different processors. DITA-OT supports implementation-specific features by applying one or more of the permissible processing approaches."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Implementation-dependent features</title></head><body id="implementation-dependent-features"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a><ul><li><a href="../reference/dita-v1-2-support.html">DITA 1.2 support</a></li><li><a href="../reference/dita-v1-3-support.html">DITA 1.3 support</a></li><li><a href="../reference/dita-v2-0-support.html">DITA 2.0 preview</a></li><li class="active"><a href="../reference/implementation-dependent-features.html">Implementation-dependent features</a></li><li><a href="../reference/extended-functionality.html">Codeblock extensions</a></li><li><a href="../reference/docs-dita-features.html">DITA features in docs</a></li></ul></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Implementation-dependent features</h1>
<div class="body refbody"><p class="shortdesc">For certain features, the DITA specification allows conforming processors to choose between different
implementation alternatives. In these cases, there may be differences in behavior when DITA content is handled by
different processors. DITA-OT supports implementation-specific features by applying one or more of the permissible
processing approaches.</p>
<section class="section" id="implementation-dependent-features__section_jla_oqn_qc"><h2 class="title sectiontitle">Chunking</h2>
<p class="p">DITA content can be divided or merged into new output documents in different ways, depending on the value of
the <code class="keyword markupname xmlatt">@chunk</code> attribute.</p>
<p class="p">DITA-OT supports the following chunking methods:</p>
<ul class="ul">
<li class="li">select-topic</li>
<li class="li">select-document</li>
<li class="li">select-branch</li>
<li class="li">by-topic</li>
<li class="li">by-document</li>
<li class="li">to-content</li>
<li class="li">to-navigation.</li>
</ul>
<p class="p">When no chunk attribute values are given, no chunking is performed.</p>
<div class="note note note_note"><span class="note__title">Note:</span> For HTML-based transformation types, this is effectively equivalent to select-document and by-document
defaults.</div>
<p class="p">Error recovery:</p>
<ul class="ul">
<li class="li">When two tokens from the same category are used, no error or warning is thrown.</li>
<li class="li">When an unrecognized chunking method is used, no error or warning is thrown.</li>
</ul>
</section>
<section class="section" id="implementation-dependent-features__section_zaa_bgs_qc"><h2 class="title sectiontitle">Filtering</h2>
<p class="p">Error recovery:</p>
<ul class="ul">
<li class="li">When there are multiple <code class="keyword markupname xmlelement">&lt;revprop&gt;</code> elements with the same <code class="keyword markupname xmlatt">@val</code>
attribute, no error or warning is thrown</li>
<li class="li">When multiple prop elements define a duplicate attribute and value combination, attribute default, or
fall-back behavior, the <span class="keyword msgnum">DOTJ007W</span> warning is thrown.</li>
</ul>
</section>
<section class="section" id="implementation-dependent-features__section_kjq_egs_qc"><h2 class="title sectiontitle">Debugging attributes</h2>
<p class="p">The debug attributes are populated as follows:</p>
<dl class="dl">
<dt class="dt dlterm">xtrf</dt>
<dd class="dd">The XML trace filename is used to store the absolute system path of the original source document.</dd>
<dt class="dt dlterm">xtrc</dt>
<dd class="dd">The XML trace counter stores an element counter with the following format:
<pre class="pre codeblock"><code>element-name ":" integer-counter ";" line-number ":" column-number</code></pre></dd>
</dl>
</section>
<section class="section" id="implementation-dependent-features__section_dco_qgs_qc"><h2 class="title sectiontitle">Image scaling</h2>
<p class="p">If both height and width attributes are given, the image is scaled non-uniformly.</p>
<p class="p">If the scale attribute is not an unsigned integer, no error or warning is thrown during preprocessing.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Map processing</h2>
<p class="p">When a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> element that references a map contains child
<code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements, the <span class="keyword msgnum">DOTX068W</span> error is thrown and the child
<code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements are ignored. </p>
</section>
<section class="section" id="implementation-dependent-features__section_h3h_jsx_1h"><h2 class="title sectiontitle">Link processing</h2>
<p class="p">When the value of a hyperlink reference in the <code class="keyword markupname xmlatt">@href</code> attribute is not a valid URI reference,
the <span class="keyword msgnum">DOTJ054E</span> error is thrown. Depending on the
<a class="xref" href="../parameters/parameters-base.html#base__processing-mode">processing-mode</a> setting, error
recovery may be attempted.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Copy-to processing</h2>
<p class="p">When the <code class="keyword markupname xmlatt">@copy-to</code> attribute is specified on a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code>, the content of
the <code class="keyword markupname xmlelement">&lt;shortdesc&gt;</code> element is not used to override the short description of the topic.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Coderef processing</h2>
<p class="p">When <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> elements are used within code blocks to reference external files with
literal code samples, the system default character set is used as the target file encoding unless a different
character set is explicitly defined via the mechanisms described under
<a class="xref" href="extended-functionality.html#code-reference__coderef-charset">Character set definition</a>.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/dita-spec-support.html" title="DITA Open Toolkit 3.6 supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.">DITA specification support</a></div></div></nav></article></main></body></html>

10
dita-ot-3.6/doc/reference/index.html Normal file
View file

@ -0,0 +1,10 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing."><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Reference</title></head><body id="reference"><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 3.6</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></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 class="active"><a href="../reference/index.html">Reference</a><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Reference</h1>
<p class="shortdesc">The <cite class="cite">Reference</cite> topics provide more advanced information about the DITA-OT architecture, OASIS
specification support, and licensing.</p>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/architecture.html">DITA Open Toolkit Architecture</a></strong><br>DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.</li><li class="link ulchildlink"><strong><a href="../reference/dita-spec-support.html">DITA specification support</a></strong><br>DITA Open Toolkit <span class="keyword">3.6</span> supports all versions of the OASIS DITA specification, including 1.0, 1.1, 1.2, and 1.3.</li><li class="link ulchildlink"><strong><a href="../extension-points/plugin-extension-points.html">Extension point reference</a></strong><br>DITA Open Toolkit provides a series of extension points that can be used to integrate changes into the core code. Extension points are defined in the <span class="ph filepath">plugin.xml</span> file for each plug-in. When plug-ins are installed, DITA-OT makes each extension visible to the rest of the toolkit.</li><li class="link ulchildlink"><strong><a href="../reference/license.html">License Information</a></strong><br> <span class="ph">DITA Open Toolkit is released under the Apache License, Version 2.0.</span> </li><li class="link ulchildlink"><strong><a href="../reference/glossary.html#glossary">Glossary</a></strong><br>Certain terms have particular meaning in the context of the DITA Open Toolkit project.</li></ul></nav></article></main></body></html>

56
dita-ot-3.6/doc/reference/java-api.html Normal file
View file

@ -0,0 +1,56 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit includes a Java Application Programming Interface to allow developers to embed the toolkit more easily into other Java programs."><meta name="keywords" content="Java, API, command, dita, classpath, classpath, Java, command"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Using the Java API</title></head><body id="API"><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 3.6</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></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 class="active"><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">
<h1 class="title topictitle1" id="ariaid-title1">Using the Java API</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit includes a Java Application Programming Interface to allow developers to embed the
toolkit more easily into other Java programs.</p>
<p class="p">When using the API, programmers don’t need to know or care that DITA-OT uses Ant, they can just use Java. </p>
<div class="note note note_note"><span class="note__title">Note:</span> When running DITA-OT via the <span class="keyword cmdname">dita</span> command, an <code class="ph codeph">ant</code> shell script handles the
classpath setup, but when using the API the classpath should be set up as part of the normal classpath
configuration for the Java application.</div>
<div class="example"><h2 class="title sectiontitle">Example usage</h2>
<pre class="pre codeblock language-java normalize-space show-line-numbers show-whitespace"><code>// Create a reusable processor factory with DITA-OT base directory
ProcessorFactory pf = ProcessorFactory.newInstance(ditaDir);
// and set the temporary directory
pf.setBaseTempDir(tempDir);
// Create a processor using the factory and configure the processor
Processor p = pf.newProcessor("html5")
.setInput(mapFile)
.setOutputDir(outDir)
.setProperty("nav-toc", "partial");
// Run conversion
p.run();</code></pre>
</div>
<section class="section">
<p class="p">By default, running DITA-OT via the API will write a debug log to the temporary directory. A custom SLF4J
logger can also be used to access the log via the Simple Logging Facade for Java.</p>
<p class="p">The processor cleans the temporary directory by default, but this can be disabled to simplify debugging in
cases where the processor failed.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> See the <cite class="cite">DITA-OT Java API documentation</cite> in the <span class="ph filepath">doc/api/</span> folder
of the DITA-OT distribution package for information on the packages, classes, interfaces and methods provided by
the Java API.</div>
</section>
<section class="section"><h2 class="title sectiontitle">Downloading DITA-OT from Maven Central</h2>
<p class="p">As of version 2.5, the DITA Open Toolkit base library (<span class="ph filepath">dost.jar</span>) is available via the
Maven 2 Central Repository. You can use this mechanism to download the main JAR file and include it in the build
for other Java projects.</p>
<p class="p">To locate the latest version,
<a class="xref" href="https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.dita-ot%22" target="_blank" rel="external noopener">search for the <code class="ph codeph">org.dita-ot</code> group ID</a>.</p>
<div class="note important note_important"><span class="note__title">Important:</span> The <span class="ph filepath">dost.jar</span> file provides only the DITA Open Toolkit base library. It
does <strong class="ph b">not</strong> contain the full DITA-OT distribution and cannot be used to run DITA-OT by itself. You will need
to ensure that your build installs the other files and directories required for the toolkit along with the
dependencies for your project.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/building-output.html" title="You can use the dita command-line tool, Ant, or the Java API to transform DITA content to the various output formats that DITA Open Toolkit supports.">Building output</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../api/index.html">DITA-OT Java API documentation</a></li></ul></div></nav></article></main></body></html>

18
dita-ot-3.6/doc/reference/license.html Normal file
View file

@ -0,0 +1,18 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit is released under the Apache License, Version 2.0."><meta name="keywords" content="license, Apache licence"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>License Information</title></head><body id="ID"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li class="active"><a href="../reference/license.html">License</a><ul><li><a href="../reference/third-party-software.html">Third-party software</a></li></ul></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">License Information</h1>
<div class="body conbody"><p class="shortdesc">
<span class="ph" id="ID__ph_docs-license-desc">DITA Open Toolkit is released under the Apache License, Version 2.0.</span>
</p>
<div class="note note note_note"><span class="note__title">Note:</span> For information on the terms and conditions for use, reproduction, and distribution of DITA Open Toolkit,
refer to the
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a>.</div>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/third-party-software.html">Third-party software</a></strong><br>DITA Open Toolkit uses third-party software components to provide certain features in the core toolkit, Java API, and bundled plug-ins.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/index.html" title="The Reference topics provide more advanced information about the DITA-OT architecture, OASIS specification support, and licensing.">Reference</a></div></div></nav></article></main></body></html>

109
dita-ot-3.6/doc/reference/map-first-preprocessing.html Normal file
View file

@ -0,0 +1,109 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA-OT 3.0 provides a map-first preprocessing option as an alternative to the default preprocess operation. The method, which was introduced in DITA-OT 2.5 as an experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing provides the same functionality as the default preprocess, but takes a different approach."><meta name="keywords" content="filters, map-first preprocessing, preprocessing, map first, DITA 1.0, DITA 1.2, DITA 1.3, effect on preprocessing, pipelines, validate, maps, DITA maps, DITA maps"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Map-first preprocessing</title></head><body id="ID"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li class="active"><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Map-first preprocessing</h1>
<div class="body conbody"><p class="shortdesc"><span class="ph" id="ID__map-first-preproc-desc">DITA-OT 3.0 provides a map-first preprocessing option as an alternative to
the default <code class="ph codeph">preprocess</code> operation. The method, which was introduced in DITA-OT 2.5 as an
experimental feature, has been improved and is ready for use in many production scenarios. Map-first-preprocessing
provides the same functionality as the default <code class="ph codeph">preprocess</code>, but takes a different
approach.</span></p>
<p class="p" id="ID__map-first-preproc-gain">Whereas the default preprocessing routine handles both maps and topics at the same
time, often switching back and forth between map operations and topic operations, the map-first approach only
begins processing topics after nearly all map processing is complete. This simplifies the processing logic and
creates cleaner module responsibilities, which makes it easier to process only those topics that are actually
referenced after filtering, for example, or to only process the map to validate the map structure.</p>
<p class="p">The current preprocessing architecture was established during the DITA 1.0 era when there were fewer DITA
features that operated on the map level. Initially, the difference between processing modes was not that great.
DITA 1.2 and 1.3 introduced many more map-level features, such as keys and key scopes, that make it difficult to
reliably work with topics before all map features have been resolved. </p>
<p class="p">The original preprocessing operation already handles many map operations first, but this was not the original
design and requires regular refactoring to handle edge cases. The new map-first preprocessing is designed with
this model in mind, improving the overall processing flow and making it more formal about the map-first model. The
new model also takes advantage of hashed topic file names in the temporary directory, which simplifies many
processing steps, and is better able to handle topics referenced outside of the map directory (that case has
resulted in a variety of issues with the original model).</p>
<div class="note note note_note" id="ID__map-first-preproc-note"><span class="note__title">Note:</span> The map-first preprocessing option is enabled by default in DITA-OT 3.0 for PDF
and HTML Help. These formats were chosen because they generate a compiled result file, so temporarily hashed file
names should all be invisible to the build. After further testing and feedback, the new option will most likely
become the default for other output formats in future versions. Because the DITA-OT development team cannot have
access to all varieties of DITA, all edge cases, or even all the ways DITA-OT itself is extended, the switch to
default map-first preprocessing for other output formats will be smoother for everyone if more people can test and
provide feedback.</div>
<section class="section"><h2 class="title sectiontitle">How to use map-first preprocessing</h2>
<p class="p">To use (or test) map-first preprocessing, call the <code class="ph codeph">preprocess2</code> Ant target in your custom
transformation types instead of using the default <code class="ph codeph">preprocess</code> target.</p>
<p class="p">For example, if you have a custom HTML5 transformation type named "myhtml", then you may have a plug-in
extension that looks this:</p>
<pre class="pre codeblock language-xml"><code>&lt;!-- Simple variant: set properties and call default HTML5 --&gt;
&lt;target name="dita2myhtml" depends="myhtml.init,dita2html5"/&gt;
</code></pre>
<p class="p">This type of extension is quite common, and is used to set default properties for your environment followed by
a normal build to use those properties. In this case, you'll need to replace <code class="ph codeph">dita2html5</code> with
the normal HTML5 steps, swapping out <code class="ph codeph">preprocess</code> for <code class="ph codeph">preprocess2</code>:</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;!-- Simple variant: set properties and call default HTML5 --&gt;
&lt;target name="dita2myhtml"
depends="myhtml.init,
html5.init,
build-init,
<strong class="ph b">preprocess2,</strong>
html5.topic,
html5.map,
html5.css"/&gt;</code></pre>
<div class="note note note_note"><span class="note__title">Note:</span> If you use this simple method for customized PDF or HTML Help builds, you will automatically be using
<code class="ph codeph">preprocess2</code>.</div>
<p class="p">Some custom transformation types already require you to repeat the default dependencies, in which case you
should already call <code class="ph codeph">preprocess</code> directly, as in the following:</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;!-- More complex variant: add processing steps to default HTML5 --&gt;
&lt;target name="dita2myhtml"
depends="myhtml.init,
build-init,
preprocess,
local-extensions-after-preprocess,
html5.topic,
html5.map,
html5.css"/&gt;</code></pre>
<p class="p">In such cases, the modification is much easier – simply add a <code class="ph codeph">2</code> to the existing
<code class="ph codeph">preprocess</code> target.</p>
</section>
<section class="section"><h2 class="title sectiontitle">How to test in a production environment</h2>
<p class="p">In some cases, you may be responsible for maintaining transformation types that are actually run by many people
on your team or around a company. In this case, you likely need to maintain your existing transformation types
based on the backwards-compatible <code class="ph codeph">preprocess</code> modules, but also want to provide your colleagues
with a way to test their own documents using <code class="ph codeph">preprocess2</code>.</p>
<p class="p">There are several ways to do this. One fairly straightforward approach would be to create a new custom
transformation type that is exactly the same, except for preprocessing. For example, if you have a local HTML
variant called <code class="ph codeph">myhtml</code> as above, instead of modifying that transformation directly, you could
create a second transformation type called <code class="ph codeph">myhtml-beta</code> that provides exactly the same support,
but with the new map-first preprocessing:</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code><em class="ph i">&lt;!-- Original "myhtml" is not modified, used for production --&gt;</em>
&lt;target name="dita2myhtml5" depends="myhtml.init,dita2html5"/&gt;
<em class="ph i">&lt;!-- "myhtml-beta" used to test and provide feedback on preprocess2 --&gt;</em>
&lt;target name="dita2myhtml-beta"
depends="myhtml.init,
html5.init,
build-init,
<strong class="ph b">preprocess2,</strong>
html5.topic,
html5.map,
html5.css"/&gt;</code></pre>
</section>
<section class="section"><h2 class="title sectiontitle">Known limitations</h2>
<p class="p">The <code class="ph codeph">preprocess2</code> implementation details are subject to change; dependencies within
<code class="ph codeph">preprocess2</code> may be renamed or removed based on feedback.</p>
<p class="p">The internal extension points that run before or after individual steps in the
original <code class="ph codeph">preprocess</code> pipeline (<code class="ph codeph">preprocess.*.pre/preprocess.*.post</code>) are not
available in the newer map-first preprocessing pipeline (<code class="ph codeph">preprocess2</code>), which is used in the PDF
and HTML Help transformations as of DITA-OT 3.0.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2017/dita-ot_day.html#preprocess_2" target="_blank" rel="external noopener" title="Overview of preprocess2, the replacement module for the original preprocessing routines. This session explains the new approach, why we developed it, and why should you care.">We shall call it preprocess2</a></li></ul></div></nav></article></main></body></html>

75
dita-ot-3.6/doc/reference/pdf-transform.html Normal file
View file

@ -0,0 +1,75 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The PDF (formerly known as PDF2) transformation process runs the pre-processing routine and follows it by a series of additional targets. These steps work together to create a merged set of content, convert the merged content to XSL-FO, and then format the XSL-FO file to PDF."><meta name="keywords" content="DITAVAL, PDF, Antenna House, transform.fo2pdf, topic.fo, Apache FOP, PDF, preprocessing, targets, XSLT, RenderX, XEP, RenderX, index, stage1.xml, pipelines, stage1a.xml, stage2.fo, stage3.fo"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>PDF processing modules</title></head><body id="pdfdefault"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li class="active"><a href="../reference/pdf-transform.html">PDF processing modules</a><ul><li><a href="../reference/pdf-transformation-history.html">History of the PDF transformation</a></li></ul></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">PDF processing modules</h1>
<div class="body conbody"><p class="shortdesc">The <span class="keyword option">PDF</span> (formerly known as <span class="keyword option">PDF2</span>) transformation process runs the
pre-processing routine and follows it by a series of additional targets. These steps work together to create a
merged set of content, convert the merged content to XSL-FO, and then format the XSL-FO file to PDF.</p>
<section class="section">
<p class="p">The PDF process includes many Ant targets. During a typical conversion from map to PDF, the following targets
are most significant.</p>
<dl class="dl">
<dt class="dt dlterm"><code class="ph codeph">map2pdf2</code></dt>
<dd class="dd">Creates a merged file by calling a common Java merge module. It then calls the
<code class="ph codeph">publish.map.pdf</code> target to do the remainder of the work.</dd>
<dt class="dt dlterm"><code class="ph codeph">publish.map.pdf</code></dt>
<dd class="dd">Performs some initialization and then calls the <code class="ph codeph">transform.topic2pdf</code> target to do the
remainder of processing.</dd>
<dt class="dt dlterm"><code class="ph codeph">transform.topic2pdf</code></dt>
<dd class="dd">Converts the merged file to XSL-FO, generates the PDF, and deletes the <span class="ph filepath">topic.fo</span> file,
unless instructed to keep it.</dd>
</dl>
<p class="p">The <code class="ph codeph">transform.topic2pdf</code> target uses the following targets to perform those tasks:</p>
<dl class="dl">
<dt class="dt dlterm"><code class="ph codeph">transform.topic2fo</code></dt>
<dd class="dd">Convert the merged file to an XSL-FO file. This process is composed of several sub-targets. </dd>
<dt class="dt dlterm"><code class="ph codeph">transform.topic2fo.index</code></dt>
<dd class="dd">Runs a Java process to set up index processing, based on the document language. This step generates the
file <span class="ph filepath">stage1.xml</span> in the temporary processing directory. </dd>
<dt class="dt dlterm"><code class="ph codeph">transform.topic2fo.flagging</code></dt>
<dd class="dd">Sets up preprocessing for flagging based on a DITAVAL file. This step generates the file
<span class="ph filepath">stage1a.xml</span> in the temporary processing directory.</dd>
<dt class="dt dlterm"><code class="ph codeph">transform.topic2fo.main</code></dt>
<dd class="dd">Does the bulk of the conversion from DITA to XSL-FO. It runs the XSLT-based process that creates
<span class="ph filepath">stage2.fo</span> in the temporary processing directory</dd>
<dt class="dt dlterm"><code class="ph codeph">transform.topic2fo.i18n</code></dt>
<dd class="dd">Does additional localization processing on the FO file; it runs a Java process that converts
<span class="ph filepath">stage2.fo</span> into <span class="ph filepath">stage3.fo</span>, followed by an XSLT process that
converts <span class="ph filepath">stage3.fo</span> into <span class="ph filepath">topic.fo</span>.</dd>
<dt class="dt dlterm"><code class="ph codeph">transform.fo2pdf</code></dt>
<dd class="dd">Converts the <span class="ph filepath">topic.fo</span> file into PDF using the specified FO processor (Antenna House,
XEP, or Apache FOP).</dd>
<dt class="dt dlterm"><code class="ph codeph">delete.fo2pdf.topic.fo</code></dt>
<dd class="dd">Deletes the <span class="ph filepath">topic.fo</span> file, unless otherwise specified by setting an Ant property or
command-line option.</dd>
</dl>
</section>
</div>
<nav role="navigation" class="related-links"><ul class="ullinks"><li class="link ulchildlink"><strong><a href="../reference/pdf-transformation-history.html">History of the PDF transformation</a></strong><br>The DITA Open Toolkit PDF transformation was originally based on a third-party contribution by Idiom Technologies, and is commonly known as the “pdf2” plug-in.</li></ul><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

38
dita-ot-3.6/doc/reference/pdf-transformation-history.html Normal file
View file

@ -0,0 +1,38 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The DITA Open Toolkit PDF transformation was originally based on a third-party contribution by Idiom Technologies, and is commonly known as the “pdf2” plug-in."><meta name="keywords" content=", info, legacypdf, PDF2, PDF, plug-in, history of, languages, auto-generated strings, PDF, HTML formatting differences, Idiom Technologies, HTML, PDF formatting differences, DITA 1.1, index, indexing domain, Customization directory, org.dita.pdf2"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>History of the PDF transformation</title></head><body id="history-pdf-transformation"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a><ul><li class="active"><a href="../reference/pdf-transformation-history.html">History of the PDF transformation</a></li></ul></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">History of the PDF transformation</h1>
<div class="body conbody"><p class="shortdesc">The DITA Open Toolkit PDF transformation was originally based on a third-party contribution by Idiom
Technologies, and is commonly known as the “pdf2” plug-in.</p>
<p class="p">When IBM developed the code that later became DITA-OT, it included only a proof-of-concept PDF transformation.
IBM had their own processing chain for producing PDFs from SGML, which they had developed over several decades, so
resources were focused primarily on XHTML output and preprocessing.</p>
<p class="p">Since the initial proof-of-concept transformation was not robust enough for production-grade output, companies
began to develop their own PDF transformations. One company, Idiom Technologies, made their transformation (known
as the “pdf2” transformation) available as open source on 23 February 2006. The Idiom plug-in was initially
available as a separately-downloadable plug-in that could be installed into DITA-OT.</p>
<p class="p">Later the DITA-OT project formally incorporated the Idiom plug-in as a demonstration in the
<span class="ph filepath">demo/fo</span> directory. Beginning with DITA-OT version 1.5, released 18 December 2009, the
“pdf2” code served as the main, supported PDF transformation. (The original PDF transformation was deprecated and
renamed “legacypdf”.) In DITA-OT version 1.6, the “pdf2” plug-in was moved to
<span class="ph filepath">plugins/org.dita.pdf2</span>. </p>
<p class="p">The fact that the current PDF transformation was not originally developed in parallel with the other core DITA-OT
transformations led to anomalies that often confuse users:</p>
<ul class="ul">
<li class="li">Elements are often (by default) styled differently in the XHTML and PDF transformations. For example, consider
the <code class="keyword markupname xmlelement">&lt;info&gt;</code> element in a task topic. In HTML output, this is an inline element; in PDF
output, it is a block-level element.</li>
<li class="li">The auto-generated strings used for localization are different, and so languages that are supported by DITA-OT
differ based on whether the XHTML or PDF transformation is used.</li>
<li class="li">The Idiom plug-in used its own extension mechanism (the <span class="ph filepath">Customization</span> folder) to provide
overrides to the PDF transformation.</li>
<li class="li">Before the release of DITA 1.1 (which added support for the indexing domain), Idiom developed an index
extension that used a FrameMaker-inspired syntax.</li>
</ul>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/pdf-transform.html" title="The PDF (formerly known as PDF2) transformation process runs the pre-processing routine and follows it by a series of additional targets. These steps work together to create a merged set of content, convert the merged content to XSL-FO, and then format the XSL-FO file to PDF.">PDF processing modules</a></div></div></nav></article></main></body></html>

10
dita-ot-3.6/doc/reference/preprocess-branch-filter.html Normal file
View file

@ -0,0 +1,10 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The branch-filter step filters topics using DITAVAL files defined in the map."><meta name="keywords" content="DITAVAL, preprocess step, branch-filter, filters, branch filters, DITAVAL, profiling, preprocessing"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Branch filtering (branch-filter)</title></head><body id="preprocess-branch-filter"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li class="active"><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Branch filtering (branch-filter)</h1>
<p class="shortdesc">The <code class="ph codeph">branch-filter</code> step filters topics using DITAVAL files defined in the map.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-mapref.html" title="The mapref step resolves references from one DITA map to another. This step is implemented in XSLT.">Resolve map references (mapref)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-keyref.html" title="The keyref step examines all the keys that are defined in the DITA source and resolves the key references. Links that make use of keys are updated so that any href value is replaced by the appropriate target; key-based text replacement is also performed, and the key definition list file is written to the temporary directory. This step is implemented in Java.">Resolve key references (keyref)</a></div></div></nav></article></main></body></html>

24
dita-ot-3.6/doc/reference/preprocess-chunk.html Normal file
View file

@ -0,0 +1,24 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The chunk step breaks apart and assembles referenced DITA content based on the @chunk attribute in maps. This step is implemented in Java."><meta name="keywords" content=", chunk, supported methods, preprocessing, Java, "><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Chunk topics (chunk)</title></head><body id="preprocess-chunk"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li class="active"><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Chunk topics (chunk)</h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">chunk</code> step breaks apart and assembles referenced DITA content based on the @chunk
attribute in maps. This step is implemented in Java.</p>
<div class="p">DITA-OT has implemented processing for the following values of the <code class="keyword markupname xmlatt">@chunk</code> attribute:
<ul class="ul">
<li class="li">select-topic</li>
<li class="li">select-document</li>
<li class="li">select-branch</li>
<li class="li">by-topic</li>
<li class="li">by-document</li>
<li class="li">to-content</li>
<li class="li">to-navigation</li>
</ul>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-topic-fragment.html" title="The topic-fragment step expands content references to elements in the same topic and resolves references made with the coderef element. This step is implemented in SAX pipes.">Resolve topic fragments and code references (topic-fragment)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-metadata.html" title="The move-meta-entries step pushes metadata back and forth between maps and topics. For example, index entries and copyrights in the map are pushed into affected topics, so that the topics can be processed later in isolation while retaining all relevant metadata. This step is implemented in Java.">Move metadata (move-meta-entries) and pull content into maps (mappull)</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="http://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html" target="_blank" rel="external noopener">Chunking definition in the DITA 1.2 specification</a></li></ul></div></nav></article></main></body></html>

11
dita-ot-3.6/doc/reference/preprocess-clean-map.html Normal file
View file

@ -0,0 +1,11 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The clean-map step removes any elements and attributes that were added to files to support preprocessing."><meta name="keywords" content="preprocessing, clean-map"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Map cleanup (clean-map)</title></head><body id="preprocess-clean-map"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li class="active"><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Map cleanup (clean-map)</h1>
<p class="shortdesc">The <code class="ph codeph">clean-map</code> step removes any elements and attributes that were added to files to support
preprocessing.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-flagging.html" title="Beginning with DITA-OT 1.7, flagging support is implemented as a common flag-module preprocessing step. The module evaluates the DITAVAL against all flagging attributes, and adds DITA-OT–specific hints to the topic when flags are active. Any extended transformation type may use these hints to support flagging without adding logic to interpret the DITAVAL.">Flagging (flag-module)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-copyfiles.html" title="The copy-files step copies non-DITA resources to the output directory, such as HTML files that are referenced in a map or images that are referenced by a DITAVAL file. Which files are copied depends on the transformation type.">Copy related files (copy-files)</a></div></div></nav></article></main></body></html>

56
dita-ot-3.6/doc/reference/preprocess-conref.html Normal file
View file

@ -0,0 +1,56 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The conref step resolves content references, processing only the DITA maps or topics that use the conref attribute. This step is implemented in XSLT."><meta name="keywords" content=", fig, xref, section, , conref, resolving, id, resolution, preprocessing, XSLT, step"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Resolve content references (conref)</title></head><body id="preprocess-conref"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li class="active"><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Resolve content references (conref)</h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">conref</code> step resolves content references, processing only the DITA maps or topics that
use the <code class="keyword markupname xmlatt">@conref</code> attribute. This step is implemented in XSLT.</p>
<section class="section">
<p class="p">The values of the <code class="keyword markupname xmlatt">@id</code> attribute on referenced content are changed as the elements are pulled
into the new locations. This ensures that the values of the <code class="keyword markupname xmlatt">@id</code> attribute within the referencing
topic remain unique.</p>
<div class="p">If an element is pulled into a new context along with a cross reference that references the target, both the
values of the <code class="keyword markupname xmlatt">@id</code> and <code class="keyword markupname xmlatt">@xref</code> attributes are updated so that they remain valid in
the new location. For example, a referenced topic might include a section as in the following example: <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Referenced topic that contains a section and cross reference</figcaption>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;topic id="referenced_topic"&gt;
&lt;title&gt;...&lt;/title&gt;
&lt;body&gt;
&lt;section id="sect"&gt;
&lt;title&gt;Sample section&lt;/title&gt;
&lt;p&gt;Figure &lt;xref href="#referenced_topic/fig"/&gt;
contains a code sample that demonstrates ... .&lt;/p&gt;
&lt;fig id="fig"&gt;
&lt;title&gt;Code sample&lt;/title&gt;
&lt;codeblock&gt;....&lt;/codeblock&gt;
&lt;/fig&gt;
&lt;/section&gt;
&lt;/body&gt;
&lt;/topic&gt;</code></pre>
</figure></div>
<div class="p">When the section is referenced using a <code class="keyword markupname xmlatt">@conref</code> attribute, the value of the <code class="keyword markupname xmlatt">@id</code>
attribute on the <code class="keyword markupname xmlelement">&lt;fig&gt;</code> element is modified to ensure that it remains unique in the new
context. At the same time, the <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element is also modified so that it remains valid
as a local reference. For example, if the referencing topic has an <code class="keyword markupname xmlatt">@id</code> set to "new_topic", then
the conrefed element may look like this in the intermediate document <code class="keyword markupname xmlelement">&lt;section&gt;</code>. <figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 2. </span>Resolved conrefed <code class="keyword markupname xmlelement">&lt;section&gt;</code> element after the conref step</figcaption>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;section id="sect"&gt;
&lt;title&gt;Sample section&lt;/title&gt;
&lt;p&gt;Figure &lt;xref href="#new_topic/d1e25"/&gt; contains a code sample
that demonstrates ... .&lt;/p&gt;
&lt;fig id="d1e25"&gt;
&lt;title&gt;Code sample&lt;/title&gt;
&lt;codeblock&gt;....&lt;/codeblock&gt;
&lt;/fig&gt;
&lt;/section&gt;</code></pre>
</figure></div>
<p class="p">In this case, the value of the <code class="keyword markupname xmlatt">@id</code> attribute on the <code class="keyword markupname xmlelement">&lt;fig&gt;</code> element has
been changed to a generated value of "d1e25". At the same time, the <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element has
been updated to use that new generated ID, so that the cross reference remains valid.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-conrefpush.html" title="The conrefpush step resolves &#34;conref push&#34; references. This step only processes documents that use conref push or that are updated due to the push action. This step is implemented in Java.">Conref push (conrefpush)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-profile.html" title="The profile step removes content from topics and maps based on the rules in DITAVAL files or the print attribute setting. Output can differ based on when filtering is done.">Filter conditional content (profile)</a></div></div></nav></article></main></body></html>

11
dita-ot-3.6/doc/reference/preprocess-conrefpush.html Normal file
View file

@ -0,0 +1,11 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The conrefpush step resolves &#34;conref push&#34; references. This step only processes documents that use conref push or that are updated due to the push action. This step is implemented in Java."><meta name="keywords" content="preprocessing, conrefpush, Java"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Conref push (conrefpush)</title></head><body id="preprocess-conrefpush"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li class="active"><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Conref push (conrefpush)</h1>
<p class="shortdesc">The <code class="ph codeph">conrefpush</code> step resolves "conref push" references. This step only processes documents
that use conref push or that are updated due to the push action. This step is implemented in Java.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-copy-to.html" title="The copy-to step makes a copy of original topic resources to new resources defined by the copy-to attribute.">Copy topics (copy-to)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-conref.html" title="The conref step resolves content references, processing only the DITA maps or topics that use the conref attribute. This step is implemented in XSLT.">Resolve content references (conref)</a></div></div></nav></article></main></body></html>

11
dita-ot-3.6/doc/reference/preprocess-copy-to.html Normal file
View file

@ -0,0 +1,11 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The copy-to step makes a copy of original topic resources to new resources defined by the copy-to attribute."><meta name="keywords" content=", copy-to, preprocessing"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Copy topics (copy-to)</title></head><body id="preprocess-copy-to"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li class="active"><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Copy topics (copy-to)</h1>
<p class="shortdesc">The <code class="ph codeph">copy-to</code> step makes a copy of original topic resources to new resources defined by the
<code class="keyword markupname xmlatt">@copy-to</code> attribute.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-keyref.html" title="The keyref step examines all the keys that are defined in the DITA source and resolves the key references. Links that make use of keys are updated so that any href value is replaced by the appropriate target; key-based text replacement is also performed, and the key definition list file is written to the temporary directory. This step is implemented in Java.">Resolve key references (keyref)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-conrefpush.html" title="The conrefpush step resolves &#34;conref push&#34; references. This step only processes documents that use conref push or that are updated due to the push action. This step is implemented in Java.">Conref push (conrefpush)</a></div></div></nav></article></main></body></html>

12
dita-ot-3.6/doc/reference/preprocess-copyfiles.html Normal file
View file

@ -0,0 +1,12 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The copy-files step copies non-DITA resources to the output directory, such as HTML files that are referenced in a map or images that are referenced by a DITAVAL file. Which files are copied depends on the transformation type."><meta name="keywords" content="DITAVAL, preprocess step, copy-files, preprocessing, images, copying"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Copy related files (copy-files)</title></head><body id="preprocess-copyfiles"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li class="active"><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Copy related files (copy-files)</h1>
<p class="shortdesc">The <code class="ph codeph">copy-files</code> step copies non-DITA resources to the output directory, such as HTML files
that are referenced in a map or images that are referenced by a DITAVAL file. Which files are copied depends on the
transformation type.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-clean-map.html" title="The clean-map step removes any elements and attributes that were added to files to support preprocessing.">Map cleanup (clean-map)</a></div></div></nav></article></main></body></html>

29
dita-ot-3.6/doc/reference/preprocess-debugfilter.html Normal file
View file

@ -0,0 +1,29 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The debug-filter step processes all referenced DITA content and creates copies in a temporary directory. As the DITA content is copied, filtering is performed, debugging information is inserted, and table column names are adjusted. This step is implemented in Java."><meta name="keywords" content=", ph, xtrf, xtrc, DITAVAL, preprocess step, debug-filter, preprocessing, debugging, tables, DITAVAL"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Debug and filter (debug-filter)</title></head><body id="preprocess-debugfilter"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li class="active"><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Debug and filter (debug-filter)</h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">debug-filter</code> step processes all referenced DITA content and creates copies in a
temporary directory. As the DITA content is copied, filtering is performed, debugging information is inserted, and
table column names are adjusted. This step is implemented in Java.</p>
<section class="section">
<p class="p">The following modifications are made to the DITA source:</p>
<ul class="ul">
<li class="li">If a DITAVAL file is specified, the DITA source is filtered according to the entries in the DITAVAL
file.</li>
<li class="li">Debug information is inserted into each element using the <code class="keyword markupname xmlatt">@xtrf</code> and <code class="keyword markupname xmlatt">@xtrc</code>
attributes. The values of these attributes enable messages later in the build to reliably indicate the
original source of the error. For example, a message might trace back to the fifth <code class="keyword markupname xmlelement">&lt;ph&gt;</code>
element in a specific DITA topic. Without these attributes, that count might no longer be available due to
filtering and other processing.</li>
<li class="li">The table column names are adjusted to use a common naming scheme. This is done only to simplify later
conref processing. For example, if a table row is pulled into another table, this ensures that a reference to
"column 5 properties" will continue to work in the fifth column of the new table.</li>
</ul>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-genlist.html" title="The gen-list step examines the input files and creates lists of topics, images, document properties, or other content. These lists are used by later steps in the pipeline. This step is implemented in Java.">Generate lists (gen-list)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-mapref.html" title="The mapref step resolves references from one DITA map to another. This step is implemented in XSLT.">Resolve map references (mapref)</a></div></div></nav></article></main></body></html>

218
dita-ot-3.6/doc/reference/preprocess-flagging.html Normal file
View file

@ -0,0 +1,218 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="Beginning with DITA-OT 1.7, flagging support is implemented as a common flag-module preprocessing step. The module evaluates the DITAVAL against all flagging attributes, and adds DITA-OT–specific hints to the topic when flags are active. Any extended transformation type may use these hints to support flagging without adding logic to interpret the DITAVAL."><meta name="keywords" content=", foreign, ditaval-startprop, prop, revprop, startflag, endflag, ditaval-endprop, ditaval-prop, p, ol, li, outputclass, xtrf, xtrc, rev, DITAVAL, preprocess step, flag-module, DITA, specializations, preprocessing, flagging, XSLT, CSS, images"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Flagging (flag-module)</title></head><body id="flagging"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li class="active"><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Flagging (flag-module)</h1>
<div class="body refbody"><p class="shortdesc">Beginning with DITA-OT 1.7, flagging support is implemented as a common <code class="ph codeph">flag-module</code>
preprocessing step. The module evaluates the DITAVAL against all flagging attributes, and adds DITA-OT–specific
hints to the topic when flags are active. Any extended transformation type may use these hints to support flagging
without adding logic to interpret the DITAVAL.</p>
<section class="section"><h2 class="title sectiontitle">Evaluating the DITAVAL flags</h2>
<p class="p">Flagging is implemented as a reusable module during the preprocess stage. If a DITAVAL file is not used with a
build, this step is skipped with no change to the file.</p>
<p class="p">When a flag is active, relevant sections of the DITAVAL itself are copied into the topic as a sub-element of
the current topic. The active flags are enclosed in a pseudo-specialization of the
<code class="keyword markupname xmlelement">&lt;foreign&gt;</code> element (referred to as a pseudo-specialization because it is used only under
the covers, with all topic types; it is not integrated into any shipped document types).</p>
<dl class="dl parml">
<dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code></dt>
<dd class="dd pd">
<p class="p">When any flag is active on an element, a <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> element will be
created as the first child of the flagged element:</p>
<pre class="pre codeblock language-xml"><code>&lt;ditaval-startprop class="+ topic/foreign ditaot-d/ditaval-startprop "&gt;</code></pre>
<div class="p">The <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> element will contain the following:
<ul class="ul">
<li class="li">If the active flags should create a new style, that style is included using standard CSS markup on
the <code class="keyword markupname xmlatt">@outputclass</code> attribute. Output types that make use of CSS, such as XHTML, can use
this value as-is.</li>
<li class="li">If styles conflict, and a <code class="keyword markupname xmlelement">&lt;style-conflict&gt;</code> element exists in the DITAVAL, it
will be copied as a child of <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code>.</li>
<li class="li">Any <code class="keyword markupname xmlelement">&lt;prop&gt;</code> or <code class="keyword markupname xmlelement">&lt;revprop&gt;</code> elements that define active
flags will be copied in as children of the <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> element. Any
<code class="keyword markupname xmlelement">&lt;startflag&gt;</code> children of the properties will be included, but
<code class="keyword markupname xmlelement">&lt;endflag&gt;</code> children will not.</li>
</ul>
</div>
</dd>
<dt class="dt pt dlterm"><code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code></dt>
<dd class="dd pd">
<p class="p">When any flag is active on an element, a <code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code> element will be created
as the last child of the flagged element:</p>
<pre class="pre codeblock language-xml"><code>&lt;ditaval-endprop class="+ topic/foreign ditaot-d/ditaval-endprop "&gt;</code></pre>
<p class="p">CSS values and <code class="keyword markupname xmlelement">&lt;style-conflict&gt;</code> elements are not included on this element.</p>
<p class="p">Any <code class="keyword markupname xmlelement">&lt;prop&gt;</code> or <code class="keyword markupname xmlelement">&lt;revprop&gt;</code> elements that define active flags
will be copied in as children of <code class="keyword markupname xmlelement">&lt;ditaval-prop&gt;</code>. Any
<code class="keyword markupname xmlelement">&lt;startflag&gt;</code> children of the properties will be included, but
<code class="keyword markupname xmlelement">&lt;endflag&gt;</code> children will not.</p>
</dd>
</dl>
</section>
<section class="section"><h2 class="title sectiontitle">Supporting flags in overrides or custom transformation types</h2>
<p class="p">For most transformation types, the <code class="keyword markupname xmlelement">&lt;foreign&gt;</code> element should be ignored by default,
because arbitrary non-DITA content may not mix well unless coded for ahead of time. If the
<code class="keyword markupname xmlelement">&lt;foreign&gt;</code> element is ignored by default, or if a rule is added to specifically ignore
<code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> and <code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code>, then the added
elements will have no impact on a transform. If desired, flagging support may be integrated at any time in the
future.</p>
<p class="p">The processing described above runs as part of the common preprocess, so any transform that uses the default
preprocess will get the topic updates. To support generating flags as images, XSLT based transforms can use
default fallthrough processing in most cases. For example, if a paragraph is flagged, the first child of
<code class="keyword markupname xmlelement">&lt;p&gt;</code> will contain the start flag information; adding a rule to handle images in
<code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> will cause the image to appear at the start of the paragraph
content.</p>
<p class="p">In some cases fallthrough processing will not result in valid output; for those cases, the flags must be
explicitly processed. This is done in the XHTML transform for elements like <code class="keyword markupname xmlelement">&lt;ol&gt;</code>, because
fallthrough processing would place images in between <code class="keyword markupname xmlelement">&lt;ol&gt;</code> and
<code class="keyword markupname xmlelement">&lt;li&gt;</code>. To handle this, the code processes <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code>
before starting the element, and <code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code> at the end. Fallthrough processing is
then disabled for those elements as children of <code class="keyword markupname xmlelement">&lt;ol&gt;</code>.</p></section>
<div class="example"><h2 class="title sectiontitle">Example DITAVAL</h2>
<p class="p">Assume the following DITAVAL file is in use during a build. This DITAVAL will be used for each of the following
content examples.</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;val&gt;
<em class="ph i">&lt;!-- Define what happens in the case of conflicting styles --&gt;</em>
&lt;style-conflict background-conflict-color="red"/&gt;
<em class="ph i">&lt;!-- Define two flagging properties that give styles (no image) --&gt;</em>
&lt;prop action="flag" att="audience" style="underline" val="user"
backcolor="green"/&gt;
&lt;prop action="flag" att="platform" style="overline" val="win"
backcolor="blue"/&gt;
<em class="ph i">&lt;!-- Define a property that includes start and end image flags --&gt;</em>
&lt;prop action="flag" att="platform" val="linux" style="overline"
backcolor="blue"&gt;
&lt;startflag imageref="startlin.png"&gt;
&lt;alt-text&gt;Start linux&lt;/alt-text&gt;&lt;/startflag&gt;
&lt;endflag imageref="endlin.png"&gt;
&lt;alt-text&gt;End linux&lt;/alt-text&gt;&lt;/endflag&gt;
&lt;/prop&gt;
<em class="ph i">&lt;!-- Define a revision that includes start and end image flags --&gt;</em>
&lt;revprop action="flag" style="double-underline" val="rev2"&gt;
&lt;startflag imageref="start_rev.gif"&gt;
&lt;alt-text&gt;START&lt;/alt-text&gt;&lt;/startflag&gt;
&lt;endflag imageref="end_rev.gif"&gt;&lt;alt-text&gt;END&lt;/alt-text&gt;&lt;/endflag&gt;
&lt;/revprop&gt;
&lt;/val&gt;</code></pre>
</div>
<div class="example"><h2 class="title sectiontitle">Content example 1: Adding style</h2>
<p class="p">Now assume the following paragraph exists in a topic. Class attributes are included, as they would normally be
in the middle of the preprocess routine; <code class="keyword markupname xmlatt">@xtrf</code> and <code class="keyword markupname xmlatt">@xtrc</code> are left off for
clarity.</p>
<pre class="pre codeblock language-xml"><code>&lt;p audience="user"&gt;Simple user; includes style but no images&lt;/p&gt;</code></pre>
<p class="p">Based on the DITAVAL above, audience="user" results in a style with underlining and with a green background.
The interpreted CSS value is added to <code class="keyword markupname xmlatt">@outputclass</code> on
<code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code>, and the actual property definition is included at the start and end
of the element. The output from the flagging step looks like this (with newlines added for clarity, and class
attributes added as they would appear in the temporary file):</p>
<p class="p">The resulting file after the flagging step looks like this; for clarity, newlines are added, while
<code class="keyword markupname xmlatt">@xtrf</code> and <code class="keyword markupname xmlatt">@xtrc</code> are removed:</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;p audience="user" class="- topic/p "&gt;
<strong class="ph b">&lt;ditaval-startprop</strong>
<strong class="ph b">class="+ topic/foreign ditaot-d/ditaval-startprop "</strong>
<strong class="ph b">outputclass="background-color:green;text-decoration:underline;"&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="audience" style="underline" val="user"
backcolor="green"/&gt;</strong>
<strong class="ph b">&lt;/ditaval-startprop&gt;</strong>
Simple user; includes style but no images
<strong class="ph b">&lt;ditaval-endprop</strong>
<strong class="ph b">class="+ topic/foreign ditaot-d/ditaval-endprop "&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="audience" style="underline" val="user"
backcolor="green"/&gt;</strong>
<strong class="ph b">&lt;/ditaval-endprop&gt;</strong>
&lt;/p&gt;</code></pre>
</div>
<div class="example"><h2 class="title sectiontitle">Content example 2: Conflicting styles</h2>
<p class="p">This example includes a paragraph with conflicting styles. When the audience and platform attributes are both
evaluated, the DITAVAL indicates that the background color is both green and blue. In this situation, the
<code class="keyword markupname xmlelement">&lt;style-conflict&gt;</code> element is evaluated to determine how to style the content.</p>
<pre class="pre codeblock language-xml"><code>&lt;p audience="user" platform="win"&gt;Conflicting styles (still no images)&lt;/p&gt;</code></pre>
<p class="p">The <code class="keyword markupname xmlelement">&lt;style-conflict&gt;</code> element results in a background color of red, so this value is
added to <code class="keyword markupname xmlatt">@outputclass</code> on <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code>. As above, active properties
are copied into the generated elements; the <code class="keyword markupname xmlelement">&lt;style-conflict&gt;</code> element itself is also
copied into the generated <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> element.</p>
<p class="p">The resulting file after the flagging step looks like this; for clarity, newlines are added, while
<code class="keyword markupname xmlatt">@xtrf</code> and <code class="keyword markupname xmlatt">@xtrc</code> are removed:</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;p audience="user" platform="win" class="- topic/p "&gt;
<strong class="ph b">&lt;ditaval-startprop</strong>
<strong class="ph b">class="+ topic/foreign ditaot-d/ditaval-startprop "</strong>
<strong class="ph b">outputclass="background-color:red;"&gt;</strong>
<strong class="ph b">&lt;style-conflict background-conflict-color="red"/&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="audience" style="underline" val="user"
backcolor="green"/&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="platform" style="overline" val="win"
backcolor="blue"/&gt;</strong>
<strong class="ph b">&lt;/ditaval-startprop&gt;</strong>
Conflicting styles (still no images)
<strong class="ph b">&lt;ditaval-endprop</strong>
<strong class="ph b">class="+ topic/foreign ditaot-d/ditaval-endprop "&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="platform" style="overline" val="win"
backcolor="blue"/&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="audience" style="underline" val="user"
backcolor="green"/&gt;</strong><strong class="ph b">
&lt;/ditaval-endprop&gt;</strong>
&lt;/p&gt;</code></pre>
</div>
<div class="example"><h2 class="title sectiontitle">Content example 3: Adding image flags</h2>
<p class="p">This example includes image flags for both <code class="keyword markupname xmlatt">@platform</code> and <code class="keyword markupname xmlatt">@rev</code>, which are
defined in DITAVAL <code class="keyword markupname xmlelement">&lt;prop&gt;</code> and <code class="keyword markupname xmlelement">&lt;revprop&gt;</code> elements.</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;ol platform="linux" rev="rev2"&gt;
&lt;li&gt;Generate images for platform="linux" and rev="2"&lt;/li&gt;
&lt;/ol&gt;</code></pre>
<p class="p">As above, the <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> and <code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code> nest the
active property definitions, with the calculated CSS value on <code class="keyword markupname xmlatt">@outputclass</code>. The
<code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code> drops the ending image, and
<code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code> drops the starting image. To make document-order processing more
consistent, property flags are always included before revisions in <code class="keyword markupname xmlelement">&lt;ditaval-startprop&gt;</code>,
and the order is reversed for <code class="keyword markupname xmlelement">&lt;ditaval-endprop&gt;</code>.</p>
<p class="p">The resulting file after the flagging step looks like this; for clarity, newlines are added, while
<code class="keyword markupname xmlatt">@xtrf</code> and <code class="keyword markupname xmlatt">@xtrc</code> are removed:</p>
<pre class="pre codeblock language-xml normalize-space show-line-numbers show-whitespace"><code>&lt;ol platform="linux" rev="rev2" class="- topic/ol "&gt;
<strong class="ph b">&lt;ditaval-startprop</strong>
<strong class="ph b">class="+ topic/foreign ditaot-d/ditaval-startprop "</strong>
<strong class="ph b">outputclass="background-color:blue;</strong>
<strong class="ph b">text-decoration:underline;</strong>
<strong class="ph b">text-decoration:overline;"&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="platform" val="linux" style="overline"
backcolor="blue"&gt;</strong>
<strong class="ph b">&lt;startflag imageref="startlin.png"&gt;</strong>
<strong class="ph b">&lt;alt-text&gt;Start linux&lt;/alt-text&gt;&lt;/startflag&gt;&lt;/prop&gt;</strong>
<strong class="ph b">&lt;revprop action="flag" style="double-underline" val="rev2"&gt;</strong>
<strong class="ph b">&lt;startflag imageref="start_rev.gif"&gt;</strong>
<strong class="ph b">&lt;alt-text&gt; &lt;/alt-text&gt;&lt;/startflag&gt;&lt;/revprop&gt;</strong>
<strong class="ph b">&lt;/ditaval-startprop&gt;</strong>
&lt;li class="- topic/li "&gt;
Generate images for platform="linux" and rev="2"
&lt;/li&gt;
<strong class="ph b">&lt;ditaval-endprop</strong>
<strong class="ph b">class="+ topic/foreign ditaot-d/ditaval-endprop "&gt;</strong>
<strong class="ph b">&lt;revprop action="flag" style="double-underline" val="rev2"&gt;</strong>
<strong class="ph b">&lt;endflag imageref="end_rev.gif"&gt;</strong>
<strong class="ph b">&lt;alt-text&gt;END&lt;/alt-text&gt;&lt;/endflag&gt;&lt;/revprop&gt;</strong>
<strong class="ph b">&lt;prop action="flag" att="platform" val="linux" style="overline"</strong>
<strong class="ph b">backcolor="blue"&gt;</strong>
<strong class="ph b">&lt;endflag imageref="endlin.png"&gt;</strong>
<strong class="ph b">&lt;alt-text&gt;End linux&lt;/alt-text&gt;&lt;/endflag&gt;&lt;/prop&gt;</strong>
<strong class="ph b">&lt;/ditaval-endprop&gt;</strong>
&lt;/ol&gt;</code></pre>
</div>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-topicpull.html" title="The topicpull step pulls content into xref and link elements. This step is implemented in XSLT.">Pull content into topics (topicpull)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-clean-map.html" title="The clean-map step removes any elements and attributes that were added to files to support preprocessing.">Map cleanup (clean-map)</a></div></div></nav></article></main></body></html>

155
dita-ot-3.6/doc/reference/preprocess-genlist.html Normal file
View file

@ -0,0 +1,155 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The gen-list step examines the input files and creates lists of topics, images, document properties, or other content. These lists are used by later steps in the pipeline. This step is implemented in Java."><meta name="keywords" content="deprecated features, htmlfile, html.file, imagefile, image.file, preprocessing, gen-list, conref, dita.list, dita.xml.properties"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Generate lists (gen-list)</title></head><body id="preprocess-genlist"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li class="active"><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Generate lists (gen-list)</h1>
<div class="body refbody"><p class="shortdesc">The <code class="ph codeph">gen-list</code> step examines the input files and creates lists of topics, images, document
properties, or other content. These lists are used by later steps in the pipeline. This step is implemented in
Java.</p>
<section class="section">
<p class="p">For example, one list includes all topics that make use of the conref attribute; only those files are processed
during the conref stage of the build. The list file name name is derived from the list file property. For
example, the <code class="ph codeph">conref.list</code> file is generated for “conreffile” and a corresponding list property
is provided for each generated list, in this case “conreflist”.</p>
<p class="p">The result of this step is a set of several list files in the temporary directory, including
<span class="ph filepath">dita.list</span> and <span class="ph filepath">dita.xml.properties</span>.</p>
<table class="table table-hover frame-none"><caption></caption><colgroup><col style="width:25%"><col style="width:37.5%"><col style="width:37.5%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-0 rowsep-1" id="preprocess-genlist__entry__1">List file property</th>
<th class="entry colsep-0 rowsep-1" id="preprocess-genlist__entry__2">List file</th>
<th class="entry colsep-0 rowsep-1" id="preprocess-genlist__entry__3">Usage</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">canditopicsfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">canditopics.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">conreffile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">conref.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Documents that contain conref attributes that need to be resolved in preprocess.</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">conreftargetsfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">conreftargets.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">copytosourcefile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">copytosource.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">flagimagefile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">flagimage.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">fullditamapandtopicfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">fullditamapandtopic.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">All of the ditamap and topic files that are referenced during the transformation. These may be
referenced by href or conref attributes.</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">fullditamapfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">fullditamap.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">All of the ditamap files in dita.list</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">fullditatopicfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">fullditatopic.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">All of the topic files in dita.list</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">hrefditatopicfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">hrefditatopic.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">All of the topic files that are referenced with an href attribute</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">hreftargetsfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">hreftargets.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Link targets</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">htmlfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">html.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Resource files</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">imagefile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">image.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Image files that are referenced in the content</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">outditafilesfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">outditafiles.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">resourceonlyfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">resourceonly.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">subjectschemefile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">subjectscheme.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">subtargetsfile</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"><code class="ph codeph">subtargets.list</code>
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">tempdirToinputmapdir.relative.value</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"></td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">uplevels</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"></td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3"></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">user.input.dir
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"></td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Absolute input directory path</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">user.input.file.listfile
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"></td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Input file list file</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__1">user.input.file
</td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__2"></td>
<td class="entry colsep-0 rowsep-1" headers="preprocess-genlist__entry__3">Input file path, relative to the input directory</td>
</tr>
</tbody></table>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-debugfilter.html" title="The debug-filter step processes all referenced DITA content and creates copies in a temporary directory. As the DITA content is copied, filtering is performed, debugging information is inserted, and table column names are adjusted. This step is implemented in Java.">Debug and filter (debug-filter)</a></div></div></nav></article></main></body></html>

13
dita-ot-3.6/doc/reference/preprocess-keyref.html Normal file
View file

@ -0,0 +1,13 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The keyref step examines all the keys that are defined in the DITA source and resolves the key references. Links that make use of keys are updated so that any href value is replaced by the appropriate target; key-based text replacement is also performed, and the key definition list file is written to the temporary directory. This step is implemented in Java."><meta name="keywords" content=", href, preprocessing, keyref"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Resolve key references (keyref)</title></head><body id="preprocess-keyref"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li class="active"><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Resolve key references (keyref)</h1>
<p class="shortdesc">The <code class="ph codeph">keyref</code> step examines all the keys that are defined in the DITA source and resolves the
key references. Links that make use of keys are updated so that any <code class="keyword markupname xmlatt">@href </code>value is replaced by the
appropriate target; key-based text replacement is also performed, and the key definition list file is written to the
temporary directory. This step is implemented in Java.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-branch-filter.html" title="The branch-filter step filters topics using DITAVAL files defined in the map.">Branch filtering (branch-filter)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-copy-to.html" title="The copy-to step makes a copy of original topic resources to new resources defined by the copy-to attribute.">Copy topics (copy-to)</a></div></div></nav></article></main></body></html>

19
dita-ot-3.6/doc/reference/preprocess-maplink.html Normal file
View file

@ -0,0 +1,19 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="This step collects links based on a map and moves those links into the referenced topics. The links are created based on hierarchy in the DITA map, the collection-type attribute, and relationship tables. This step is implemented in XSLT and Java."><meta name="keywords" content=", collection-type, preprocessing, maplink, Java, XSLT, preprocessing step, relationship tables, memory"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Map based linking (maplink)</title></head><body id="preprocess-maplink"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li class="active"><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Map based linking (maplink)</h1>
<div class="body conbody"><p class="shortdesc">This step collects links based on a map and moves those links into the referenced topics. The links are
created based on hierarchy in the DITA map, the <code class="keyword markupname xmlatt">@collection-type</code> attribute, and relationship tables.
This step is implemented in XSLT and Java.</p>
<section class="section">
<p class="p">The <code class="ph codeph">maplink</code> module runs an XSLT stylesheet that evaluates the map; it places all the generated
links into a single file in memory. The module then runs a Java program that pushes the generated links into the
applicable topics.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-metadata.html" title="The move-meta-entries step pushes metadata back and forth between maps and topics. For example, index entries and copyrights in the map are pushed into affected topics, so that the topics can be processed later in isolation while retaining all relevant metadata. This step is implemented in Java.">Move metadata (move-meta-entries) and pull content into maps (mappull)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-topicpull.html" title="The topicpull step pulls content into xref and link elements. This step is implemented in XSLT.">Pull content into topics (topicpull)</a></div></div></nav></article></main></body></html>

22
dita-ot-3.6/doc/reference/preprocess-mapref.html Normal file
View file

@ -0,0 +1,22 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The mapref step resolves references from one DITA map to another. This step is implemented in XSLT."><meta name="keywords" content=", map, preprocessing, mapref, XSLT, preprocessing step, relationship tables"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Resolve map references (mapref)</title></head><body id="preprocess-mapref"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li class="active"><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Resolve map references (mapref)</h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">mapref</code> step resolves references from one DITA map to another. This step is implemented
in XSLT.</p>
<section class="section">
<div class="p">Maps reference other maps by using the following sorts of markup:
<pre class="pre codeblock language-xml"><code>&lt;topicref href="other.ditamap" format="ditamap"/&gt;
...
&lt;mapref href="other.ditamap"/&gt;</code></pre></div>
<p class="p">As a result of the mapref step, the element that references another map is replaced by the topic references
from the other map. Relationship tables are pulled into the referencing map as a child of the root element
(<code class="keyword markupname xmlelement">&lt;map&gt;</code> or a specialization of <code class="keyword markupname xmlelement">&lt;map&gt;</code>). </p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-debugfilter.html" title="The debug-filter step processes all referenced DITA content and creates copies in a temporary directory. As the DITA content is copied, filtering is performed, debugging information is inserted, and table column names are adjusted. This step is implemented in Java.">Debug and filter (debug-filter)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-branch-filter.html" title="The branch-filter step filters topics using DITAVAL files defined in the map.">Branch filtering (branch-filter)</a></div></div></nav></article></main></body></html>

39
dita-ot-3.6/doc/reference/preprocess-metadata.html Normal file
View file

@ -0,0 +1,39 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The move-meta-entries step pushes metadata back and forth between maps and topics. For example, index entries and copyrights in the map are pushed into affected topics, so that the topics can be processed later in isolation while retaining all relevant metadata. This step is implemented in Java."><meta name="keywords" content=", topicref, linktext, shortdesc, locktitle, type, toc, print, preprocessing, move-meta-entries, Java, metadata, moving, XSLT, index, entries in map file, TOC, table of contents"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Move metadata (move-meta-entries) and pull content into maps (mappull)</title></head><body id="preprocess-metadata"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li class="active"><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Move metadata (move-meta-entries) and pull content into maps (mappull) </h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">move-meta-entries</code> step pushes metadata back and forth between maps and topics. For
example, index entries and copyrights in the map are pushed into affected topics, so that the topics can be
processed later in isolation while retaining all relevant metadata. This step is implemented in Java.</p>
<div class="note note note_note"><span class="note__title">Note:</span> As of DITA-OT 2.2, the <code class="ph codeph">move-meta-entries</code> and <code class="ph codeph">mappull</code> steps have been merged.
The <code class="ph codeph">mappull</code> step has been moved into <code class="ph codeph">move-meta-entries</code>.</div>
<section class="section">
<p class="p">The <code class="ph codeph">mappull</code> step pulls content from referenced topics into maps, and then cascades data within
maps. This step is implemented in XSLT.</p>
<div class="p">The <code class="ph codeph">mappull</code> step makes the following changes to the DITA map:
<ul class="ul">
<li class="li">Titles are pulled from referenced DITA topics. Unless the <code class="keyword markupname xmlatt">@locktitle</code> attribute is set to
"yes", the pulled titles replace the navigation titles specified on the <code class="keyword markupname xmlelement">&lt;topicref&gt;</code>
elements.</li>
<li class="li">The <code class="keyword markupname xmlelement">&lt;linktext&gt;</code> element is set based on the title of the referenced topic, unless it
is already specified locally.</li>
<li class="li">The <code class="keyword markupname xmlelement">&lt;shortdesc&gt;</code> element is set based on the short description of the referenced
topic, unless it is already specified locally.</li>
<li class="li">The <code class="keyword markupname xmlatt">@type</code> attribute is set on <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements that reference
local DITA topics. The value of the <code class="keyword markupname xmlatt">@type</code> attribute is set to value of the root element of
the topic; for example, a <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> element that references a task topic is given a
<code class="keyword markupname xmlatt">@type</code> attribute set to "task"".</li>
<li class="li">Attributes that cascade, such as <code class="keyword markupname xmlatt">@toc</code> and <code class="keyword markupname xmlatt">@print</code>, are made explicit on any
child <code class="keyword markupname xmlelement">&lt;topicref&gt;</code> elements. This allows future steps to work with the attributes
directly, without reevaluating the cascading behavior.</li>
</ul>
</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-chunk.html" title="The chunk step breaks apart and assembles referenced DITA content based on the @chunk attribute in maps. This step is implemented in Java.">Chunk topics (chunk)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-maplink.html" title="This step collects links based on a map and moves those links into the referenced topics. The links are created based on hierarchy in the DITA map, the collection-type attribute, and relationship tables. This step is implemented in XSLT and Java.">Map based linking (maplink)</a></div></div></nav></article></main></body></html>

11
dita-ot-3.6/doc/reference/preprocess-profile.html Normal file
View file

@ -0,0 +1,11 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The profile step removes content from topics and maps based on the rules in DITAVAL files or the print attribute setting. Output can differ based on when filtering is done."><meta name="keywords" content=", print, DITAVAL, preprocess step, profile, profiling, preprocessing"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Filter conditional content (profile)</title></head><body id="preprocess-profile"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li class="active"><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Filter conditional content (profile)</h1>
<p class="shortdesc">The <code class="ph codeph">profile</code> step removes content from topics and maps based on the rules in DITAVAL files
or the <code class="keyword markupname xmlatt">@print</code> attribute setting. Output can differ based on when filtering is done.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-conref.html" title="The conref step resolves content references, processing only the DITA maps or topics that use the conref attribute. This step is implemented in XSLT.">Resolve content references (conref)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-topic-fragment.html" title="The topic-fragment step expands content references to elements in the same topic and resolves references made with the coderef element. This step is implemented in SAX pipes.">Resolve topic fragments and code references (topic-fragment)</a></div></div></nav></article></main></body></html>

21
dita-ot-3.6/doc/reference/preprocess-topic-fragment.html Normal file
View file

@ -0,0 +1,21 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The topic-fragment step expands content references to elements in the same topic and resolves references made with the coderef element. This step is implemented in SAX pipes."><meta name="keywords" content=", coderef, codeblock, preprocessing, topic-fragment, Saxon, conref"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Resolve topic fragments and code references (topic-fragment)</title></head><body id="preprocess-topic-fragment"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li class="active"><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Resolve topic fragments and code references (topic-fragment)</h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">topic-fragment</code> step expands content references to elements in the same topic and
resolves references made with the <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> element. This step is implemented in SAX
pipes.</p>
<section class="section">
<p class="p">Content references to elements in the same topic are defined via same-topic fragments such as
<code class="ph codeph">#./ID</code> in URIs.</p>
<p class="p">The <code class="keyword markupname xmlelement">&lt;coderef&gt;</code> element is used to reference code stored externally in non-XML documents.
During the pre-processing step, the referenced content is pulled into the containing
<code class="keyword markupname xmlelement">&lt;codeblock&gt;</code> element.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-profile.html" title="The profile step removes content from topics and maps based on the rules in DITAVAL files or the print attribute setting. Output can differ based on when filtering is done.">Filter conditional content (profile)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-chunk.html" title="The chunk step breaks apart and assembles referenced DITA content based on the @chunk attribute in maps. This step is implemented in Java.">Chunk topics (chunk)</a></div></div><div class="linklist relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../reference/extended-functionality.html" title="DITA-OT provides additional processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for code references, normalize indendation, add line numbers or display whitespace characters in code blocks.">Extended codeblock processing</a></li></ul></div></nav></article></main></body></html>

25
dita-ot-3.6/doc/reference/preprocess-topicpull.html Normal file
View file

@ -0,0 +1,25 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The topicpull step pulls content into xref and link elements. This step is implemented in XSLT."><meta name="keywords" content=", xref, link, desc, linktext, preprocessing, topicpull, XSLT"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Pull content into topics (topicpull)</title></head><body id="preprocess-topicpull"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a><ul><li><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a></li><li><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a></li><li><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a></li><li><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a></li><li><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a></li><li><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a></li><li><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a></li><li class="active"><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a></li><li><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a></li><li><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a></li></ul></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Pull content into topics (topicpull)</h1>
<div class="body conbody"><p class="shortdesc">The <code class="ph codeph">topicpull</code> step pulls content into <code class="keyword markupname xmlelement">&lt;xref&gt;</code> and
<code class="keyword markupname xmlelement">&lt;link&gt;</code> elements. This step is implemented in XSLT.</p>
<section class="section">
<p class="p">If an <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element does not contain link text, the target is examined and the link
text is pulled. For example, a reference to a topic pulls the title of the topic; a reference to a list item
pulls the number of the item. If the <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element references a topic that has a short
description, and the <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element does not already contain a child
<code class="keyword markupname xmlelement">&lt;desc&gt;</code> element, a <code class="keyword markupname xmlelement">&lt;desc&gt;</code> element is created that contains the
text from the topic short description.</p>
<p class="p">The process is similar for <code class="keyword markupname xmlelement">&lt;link&gt;</code> elements. If the <code class="keyword markupname xmlelement">&lt;link&gt;</code> element
does not have a child <code class="keyword markupname xmlelement">&lt;linktext&gt;</code> element, one is created with the appropriate link text.
Similarly, if the <code class="keyword markupname xmlelement">&lt;link&gt;</code> element does not have a child <code class="keyword markupname xmlelement">&lt;desc&gt;</code>
element, and the short description of the target can be determined, a <code class="keyword markupname xmlelement">&lt;desc&gt;</code> element is
created that contains the text from the topic short description.</p></section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/preprocessing.html" title="The pre-processing operation is a set of steps that typically runs at the beginning of every DITA-OT transformation. Each step or stage corresponds to an Ant target in the build pipeline; the preprocess target calls the entire set of steps.">Pre-processing modules</a></div><div class="previouslink"><strong>Previous topic:</strong> <a class="link" href="../reference/preprocess-maplink.html" title="This step collects links based on a map and moves those links into the referenced topics. The links are created based on hierarchy in the DITA map, the collection-type attribute, and relationship tables. This step is implemented in XSLT and Java.">Map based linking (maplink)</a></div><div class="nextlink"><strong>Next topic:</strong> <a class="link" href="../reference/preprocess-flagging.html" title="Beginning with DITA-OT 1.7, flagging support is implemented as a common flag-module preprocessing step. The module evaluates the DITAVAL against all flagging attributes, and adds DITA-OT–specific hints to the topic when flags are active. Any extended transformation type may use these hints to support flagging without adding logic to interpret the DITAVAL.">Flagging (flag-module)</a></div></div></nav></article></main></body></html>

12
dita-ot-3.6/doc/reference/preprocessing.html Normal file
View file

File diff suppressed because one or more lines are too long

46
dita-ot-3.6/doc/reference/processing-order.html Normal file
View file

@ -0,0 +1,46 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The order of processing is often significant when evaluating DITA content. Although the DITA specification does not mandate a specific order for processing, DITA-OT has determined that performing filtering before conref resolution best meets user expectations. Switching the order of processing, while legal, may give different results."><meta name="keywords" content=", note, product, , conref, resolving, filters, processing order, processing, pipelines"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Processing order</title></head><body id="processing-order"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li class="active"><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Processing order</h1>
<div class="body conbody"><p class="shortdesc">The order of processing is often significant when evaluating DITA content. Although the DITA specification
does not mandate a specific order for processing, DITA-OT has determined that performing filtering before conref
resolution best meets user expectations. Switching the order of processing, while legal, may give different
results.</p>
<section class="section">
<div class="p">The DITA-OT project has found that filtering first provides several benefits. Consider the following sample
that contains a <code class="keyword markupname xmlelement">&lt;note&gt;</code> element that both uses conref and contains a
<code class="keyword markupname xmlatt">@product</code>
attribute:<pre class="pre codeblock language-xml"><code>&lt;note conref="documentA.dita#doc/note" product="MyProd"/&gt;</code></pre></div>
<p class="p">If the <code class="keyword markupname xmlatt">@conref</code> attribute is evaluated first, then documentA must be parsed in order to retrieve
the note content. That content is then stored in the current document (or in a representation of that document
in memory). However, if all content with product="MyProd" is filtered out, then that work is all discarded later
in the build.</p>
<div class="p">If the filtering is done first (as in DITA-OT), this element is discarded immediately, and documentA is never
examined. This provides several important benefits:
<ul class="ul">
<li class="li">Time is saved by discarding unused content as early as possible; all future steps can load the document
without this extra content.</li>
<li class="li">Additional time is saved case by not evaluating the <code class="keyword markupname xmlatt">@conref</code> attribute; in fact, documentA
does not even need to be parsed.</li>
<li class="li">Any user reproducing this build does not need documentA. If the content is sent to a translation team,
that team can reproduce an error-free build without documentA; this means documentA can be kept back from
translation, preventing accidental translation and increased costs.</li>
</ul></div>
<div class="p">If the order of these two steps is reversed, so that conref is evaluated first, it is possible that results
will differ. For example, in the code sample above, the <code class="keyword markupname xmlatt">@product</code> attribute on the reference
target will override the product setting on the referencing note. Assume that the referenced
<code class="keyword markupname xmlelement">&lt;note&gt;</code> element in documentA is defined as follows:
<pre class="pre codeblock language-xml"><code>&lt;note id="note" product="SomeOtherProduct"&gt;This is an important note!&lt;/note&gt;</code></pre></div>
<p class="p">A process that filters out product="SomeOtherProduct" will remove the target of the original conref before that
conref is ever evaluated, which will result in a broken reference. Evaluating conref first would resolve the
reference, and only later filter out the target of the conref. While some use cases can be found where this is
the desired behavior, benefits such as those described above resulted in the current processing order used by
DITA-OT.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

37
dita-ot-3.6/doc/reference/processing-pipeline-modules.html Normal file
View file

@ -0,0 +1,37 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="The DITA-OT processing pipeline is implemented using Ant. Individual modules within the Ant script are implemented in either Java or XSLT, depending on such factors as performance or requirements for customization. Virtually all Ant and XSLT modules can be extended by adding a plug-in to the toolkit; new Ant targets may be inserted before or after common processing, and new rules may be imported into common XSLT modules to override default processing."><meta name="keywords" content="specializations, DITA, specializations, DITA, processing, Ant, extending, Java, processing modules, XSLT, preprocessing, extension points (overview), index, sorting, pipelines, Ant module, Java module, locale"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Processing modules</title></head><body id="processing-pipeline-modules"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li class="active"><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Processing modules</h1>
<div class="body conbody"><p class="shortdesc">The DITA-OT processing pipeline is implemented using Ant. Individual modules within the Ant script are
implemented in either Java or XSLT, depending on such factors as performance or requirements for customization.
Virtually all Ant and XSLT modules can be extended by adding a plug-in to the toolkit; new Ant targets may be
inserted before or after common processing, and new rules may be imported into common XSLT modules to override
default processing.</p>
<section class="section"><h2 class="title sectiontitle">XSLT modules</h2>
<p class="p">The XSLT modules use shell files. Typically, each shell file begins by importing common rules that apply to all
topics. This set of common processing rules may in turn import additional common modules, such as those used for
reporting errors or determining the document locale. After the common rules are imported, additional imports can
be included in order to support processing for DITA specializations.</p>
<p class="p">For example, XHTML processing is controlled by the <span class="ph filepath">xsl/dita2xhtml.xsl</span> file. The shell
begins by importing common rules that are applicable to all general topics:
<span class="ph filepath">xslhtml/dita2htmlImpl.xsl</span>. After that, additional XSLT overrides are imported for
specializations that require modified processing. For example, an override for reference topics is imported in
order to add default headers to property tables. Additional modules are imported for tasks, for the highlighting
domain, and for several other standard specializations. After the standard XSLT overrides occur, plug-ins may
add in additional processing rules for local styles or for additional specializations.</p>
</section>
<section class="section"><h2 class="title sectiontitle">Java modules</h2>
<p class="p">Java modules are typically used when XSLT is a poor fit, such as for processes that make use of standard Java
libraries (like those used for index sorting). Java modules are also used in many cases where a step involves
copying files, such as the initial process where source files are parsed and copied to a temporary processing
directory.</p>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

28
dita-ot-3.6/doc/reference/processing-structure.html Normal file
View file

@ -0,0 +1,28 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA-OT implements a multi-stage, map-driven architecture to process DITA content. Each stage in the process examines some or all of the content; some stages result in temporary files that are used by later steps, while others stages result in updated copies of the DITA content. Most of the processing takes place in a temporary working directory; the source files themselves are never modified."><meta name="keywords" content="architecture, preprocessing, Eclipse Help, HTML Help, XHTML, PDF, HTML5, preprocesing, pipelines, description of"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Processing structure</title></head><body id="processing-structure"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li class="active"><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Processing structure</h1>
<div class="body conbody"><p class="shortdesc">DITA-OT implements a multi-stage, map-driven architecture to process DITA content. Each stage in the
process examines some or all of the content; some stages result in temporary files that are used by later steps,
while others stages result in updated copies of the DITA content. Most of the processing takes place in a temporary
working directory; the source files themselves are never modified.</p>
<p class="p">DITA-OT is designed as a pipeline. Most of the pipeline is common to all output formats; it is known as the
<dfn class="term">pre-processing stage</dfn>. In general, any DITA process begins with this common set of pre-processing
routines.</p>
<p class="p">Once the pre-processing is completed, the pipeline diverges based on the requested output format. Some processing
is still common to multiple output formats; for example, Eclipse Help and HTML Help both use the same routines to
generate XHTML topics, after which the two pipelines branch to create different sets of navigation files.</p>
<p class="p">The following image illustrates how the pipeline works for several common output formats: PDF, Eclipse Help, HTML
Help, XHTML, and HTML5.</p>
<div class="note note note_note"><span class="note__title">Note:</span> Other output formats may implement additional processing steps.</div>
<figure class="fig fignone"><figcaption><span class="fig--title-label">Figure 1. </span>Diagram of some possible paths through the transformation pipeline</figcaption>
<br><img class="image" src="images/processing-flow.svg" width="624"><br>
</figure>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

68
dita-ot-3.6/doc/reference/store-api.html Normal file
View file

@ -0,0 +1,68 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA-OT originally assumed resources would be available on disk and available from file paths. Recent versions added URI input, so HTTPS resources could be used, but temporary and output resources were still file-based. DITA-OT 3.6 introduces a new Store API that can process temporary resources in memory instead of writing them to disk."><meta name="keywords" content="Store API, in-memory processing"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Store API – Processing in memory</title></head><body id="store-api"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li class="active"><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Store API – Processing in memory</h1>
<div class="body"><p class="shortdesc">DITA-OT originally assumed resources would be available on disk and available from file paths. Recent
versions added URI input, so HTTPS resources could be used, but temporary and output resources were still
file-based. DITA-OT 3.6 introduces a new Store API that can process temporary resources in memory instead of writing
them to disk.</p>
<p class="p">The Store API (<code class="ph codeph">org.dita.dost.store.Store</code>) is a Java abstraction over temporary file operations.
So for example instead of reading resources directly with <code class="ph codeph">FileInputStream</code>, the Store API provides
operations for this. This abstraction allows implementations of the Store API to choose how they handle resources,
enables optimizations or non–file-based storage. Since DITA-OT processes a lot of XML data, the Store API offers
operations for XML processing directly. For example, a read method to directly get a DOM
<code class="ph codeph">Document</code>, instead of opening a file stream manually, parsing it with an XML parser, and getting
the <code class="ph codeph">Document</code> instance from the parser.</p>
<p class="p">The Store API is extendable using Java’s
<a class="xref" href="https://docs.oracle.com/javase/9/docs/api/java/util/ServiceLoader.html" target="_blank" rel="external noopener">Resource Loader</a> with the <code class="ph codeph">org.dita.dost.store.StoreBuilder</code> service. This is a builder
interface to get named <code class="ph codeph">Store</code> instances (“a Store”).</p>
<section class="section" id="store-api__stream-store"><h2 class="title sectiontitle">Stream Store for file-based processing</h2>
<p class="p">This Store could also be a File Store, since it uses disk and local files for temporary resources. This is the
traditional DITA-OT implementation, where temporary XML files are stored under the
<code class="ph codeph">dita.temp.dir</code> path.</p>
<p class="p">The Stream Store is activated by setting the <span class="keyword parmname">store-type</span> parameter to
<span class="keyword option">file</span>.</p>
<div class="note note note_note"><span class="note__title">Note:</span> To ensure backwards compatibility, the <span class="keyword option">file</span> Store is the default setting in DITA-OT
3.6.</div>
</section>
<section class="section" id="store-api__cache-store"><h2 class="title sectiontitle">Cache Store for in-memory processing</h2>
<p class="p">This Store is an in-memory Store, that keeps all temporary resources in memory. The name comes from the feature
of the Store, that it caches the parsed XML after reading. That is, instead of storing XML as a byte array, it
keeps it as a DOM <code class="ph codeph">Document</code> or <span class="keyword apiname">S9api</span> <code class="ph codeph">XdmNode</code>. When the same
resource is re-read later, it doesn't have to parse it again, only return the parsed document. Resources that
are not available in the temporary directory are handled with the Stream Store.</p>
<p class="p">While the Store doesn't write anything to the temporary directory, it will still use URIs where the resources
are under the temporary directory. The URIs are simply used for addressing, similarly to URNs. Future releases
of DITA-OT may use some other method of addressing, such as a <code class="ph codeph">tmp</code> URI scheme.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> As of DITA-OT 3.6, the Cache Store can be activated by setting the
<span class="keyword parmname">store-type</span> parameter to <span class="keyword option">memory</span>.</div>
</section>
<section class="section" id="store-api__benefits"><h2 class="title sectiontitle">Benefits</h2>
<p class="p">The initial implementation of the Cache Store is provided in DITA-OT 3.6 as a preview to allow integration
partners to test this new feature.</p>
<p class="p">
<span class="ph">In-memory processing provides performance advantages in I/O bound environments such as cloud
computing platforms, where processing time depends primarily on how long it takes to read and write temporary
files.</span></p>
<p class="p">The Store API also makes the Saxon <span class="keyword apiname">S9api</span> easier to use. It offers an XML document model that
is in most cases easier to work with than DOM. The abstraction Store makes it easier to work with XML, so
various modules don’t need to repeat the same type of XML processing code.</p></section>
<section class="section" id="store-api__caveats"><h2 class="title sectiontitle">Caveats</h2>
<p class="p">Not all custom plug-ins will work with the Cache Store, because they may assume files are used and expect direct file
access for resource operations.</p>
<div class="note important note_important"><span class="note__title">Important:</span> To take advantage of the Store API, custom plug-ins must use DITA-OT XSLT modules in custom
<code class="keyword markupname xmlelement">&lt;pipeline&gt;</code> elements instead of Ant’s built-in <code class="keyword markupname xmlelement">&lt;xslt&gt;</code> tasks as
recommended in <a class="xref" href="../topics/plugin-coding-conventions.html" title="To ensure custom plug-ins work well with the core toolkit code and remain compatible with future releases, the DITA Open Toolkit project recommends that plug-ins use modern development practices and common coding patterns.">Plug-in coding conventions</a>.</div>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/architecture.html" title="DITA Open Toolkit is an open-source implementation of the OASIS specification for the Darwin Information Typing Architecture. The toolkit uses Ant, XSLT, and Java to transform DITA content (maps and topics) into different deliverable formats.">DITA Open Toolkit Architecture</a></div></div></nav></article></main></body></html>

148
dita-ot-3.6/doc/reference/third-party-software.html Normal file
View file

@ -0,0 +1,148 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="DITA Open Toolkit uses third-party software components to provide certain features in the core toolkit, Java API, and bundled plug-ins."><meta name="keywords" content="PDF, plug-in, required software, third-party software"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Third-party software</title></head><body id="third-party-software"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a><ul><li class="active"><a href="../reference/third-party-software.html">Third-party software</a></li></ul></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">Third-party software</h1>
<div class="body conbody"><p class="shortdesc">DITA Open Toolkit uses third-party software components to provide certain features in the core toolkit,
Java API, and bundled plug-ins.</p>
<section class="section"><h2 class="title sectiontitle">DITA-OT <span class="keyword">3.6</span></h2>
<p class="p">DITA-OT core processing uses the following third-party software:</p>
<table class="table table-hover frame-none"><caption></caption><colgroup><col style="width:25%"><col style="width:25%"><col style="width:50%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-0 rowsep-1" id="third-party-software__entry__1">Software</th>
<th class="entry colsep-0 rowsep-1" id="third-party-software__entry__2">Version</th>
<th class="entry colsep-0 rowsep-1" id="third-party-software__entry__3">License</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Ant
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">1.10.9</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a>
</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Apache Commons Codec
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">1.10</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Apache Commons IO
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">2.8.0</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Guava
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">25.1-jre</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">ICU for Java (ICU4J)
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">61.1</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="http://source.icu-project.org/repos/icu/icu/tags/release-57-1/LICENSE" target="_blank" rel="external noopener">ICU License</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Logback Classic Module
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">1.2.3</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="http://www.eclipse.org/legal/epl-v10.html" target="_blank" rel="external noopener">Eclipse Public License 1.0</a>,
<a class="xref" href="https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html" target="_blank" rel="external noopener">GNU Lesser General Public License 2.1</a>
</td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1"><span class="keyword">Saxon-HE</span>
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">9.9.1.4</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.mozilla.org/media/MPL/1.1/index.0c5913925d40.txt" target="_blank" rel="external noopener">Mozilla Public License 1.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Simple Logging Facade for Java (SLF4J)
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">1.7.25</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://opensource.org/licenses/mit-license.php" target="_blank" rel="external noopener">MIT License</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">Xerces
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">2.12.0</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">XML APIs
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">1.4.01</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a>,
<a class="xref" href="https://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231" target="_blank" rel="external noopener">W3C Document License</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__1">XML Resolver
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__2"><span class="keyword">1.2</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__3">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
</tbody></table>
<div class="note note note_note"><span class="note__title">Note:</span> The XML APIs library contains source code for SAX and DOM APIs, which each have their own licenses.</div>
</section>
<section class="section"><h2 class="title sectiontitle">PDF plug-in</h2>
<p class="p">The <code class="ph codeph">org.dita.pdf2</code> plug-in relies on additional third-party software to generate PDF
output:</p>
<table class="table table-hover frame-none"><caption></caption><colgroup><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"><col style="width:33.33333333333333%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-0 rowsep-1" id="third-party-software__entry__37">Software</th>
<th class="entry colsep-0 rowsep-1" id="third-party-software__entry__38">Version</th>
<th class="entry colsep-0 rowsep-1" id="third-party-software__entry__39">License</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__37">Apache Commons Logging
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__38">1.0.4</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__39">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__37">Apache XML Graphics
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__38"><span class="keyword">2.5</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__39">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__37">Batik
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__38">1.13</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__39">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
<tr class="row">
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__37">FOP
</td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__38"><span class="keyword">2.5</span></td>
<td class="entry colsep-0 rowsep-1" headers="third-party-software__entry__39">
<a class="xref" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="external noopener">Apache License 2.0</a></td>
</tr>
</tbody></table>
</section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/license.html" title="DITA Open Toolkit is released under the Apache License, Version 2.0.">License Information</a></div></div></nav></article></main></body></html>

12
dita-ot-3.6/doc/reference/xhtml-processing.html Normal file
View file

@ -0,0 +1,12 @@
<!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 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="After the XHTML files are generated by the common routine, the dita.map.xhtml target is called by the xhtml transformation. This target generates a TOC file called index.html, which can be loaded into a frameset."><meta name="keywords" content="HTML, XHTML, dita.map.xhtml, targets, entry file"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>XHTML processing</title></head><body id="xhtmldefault"><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 3.6</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></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><ul><li><a href="../reference/architecture.html">DITA-OT architecture</a><ul><li><a href="../reference/processing-structure.html">Processing structure</a></li><li><a href="../reference/map-first-preprocessing.html">Map-first preprocessing</a></li><li><a href="../reference/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../reference/processing-order.html">Processing order</a></li><li><a href="../reference/store-api.html">Store API</a></li><li><a href="../reference/preprocessing.html">Pre-processing modules</a></li><li><a href="../reference/html-based-processing.html">HTML-based processing modules</a><ul><li><a href="../reference/common-html-processing.html">Common HTML-based processing</a></li><li class="active"><a href="../reference/xhtml-processing.html">XHTML processing</a></li><li><a href="../reference/html5-processing.html">HTML5 processing</a></li><li><a href="../reference/eclipsehelp-processing.html">Eclipse help processing</a></li><li><a href="../reference/htmlhelp-processing.html">HTML Help processing</a></li></ul></li><li><a href="../reference/pdf-transform.html">PDF processing modules</a></li></ul></li><li><a href="../reference/dita-spec-support.html">DITA specification support</a></li><li><a href="../extension-points/plugin-extension-points.html">Extension points</a></li><li><a href="../reference/license.html">License</a></li><li><a href="../reference/glossary.html#glossary">Glossary</a></li></ul></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">
<h1 class="title topictitle1" id="ariaid-title1">XHTML processing</h1>
<p class="shortdesc">After the XHTML files are generated by the common routine, the <code class="ph codeph">dita.map.xhtml</code> target is
called by the <span class="keyword option">xhtml</span> transformation. This target generates a TOC file called
<span class="ph filepath">index.html</span>, which can be loaded into a frameset.</p>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../reference/html-based-processing.html" title="DITA-OT ships with several varieties of HTML output, each of which follows roughly the same path through the processing pipeline. All HTML-based transformations begin with the same call to the pre-processing module, after which they generate HTML files and then branch to create the transformation-specific navigation files.">HTML-based processing modules</a></div></div></nav></article></main></body></html>