12 lines
No EOL
12 KiB
HTML
12 lines
No EOL
12 KiB
HTML
<!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 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."><meta name="keywords" content="preprocessing, modules"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Pre-processing modules</title></head><body id="preprocessarch"><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 class="active"><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><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">Pre-processing modules</h1>
|
||
<p class="shortdesc">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
|
||
<code class="ph codeph">preprocess</code> target calls the entire set of steps.</p>
|
||
|
||
<nav role="navigation" class="related-links"><ol class="olchildlinks"><li class="link olchildlink"><a href="../reference/preprocess-genlist.html">Generate lists (gen-list)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-debugfilter.html">Debug and filter (debug-filter)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-mapref.html">Resolve map references (mapref)</a><br>The <code class="ph codeph">mapref</code> step resolves references from one DITA map to another. This step is implemented in XSLT.</li><li class="link olchildlink"><a href="../reference/preprocess-branch-filter.html">Branch filtering (branch-filter)</a><br>The <code class="ph codeph">branch-filter</code> step filters topics using DITAVAL files defined in the map.</li><li class="link olchildlink"><a href="../reference/preprocess-keyref.html">Resolve key references (keyref)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-copy-to.html">Copy topics (copy-to)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-conrefpush.html">Conref push (conrefpush)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-conref.html">Resolve content references (conref)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-profile.html">Filter conditional content (profile)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-topic-fragment.html">Resolve topic fragments and code references (topic-fragment)</a><br>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"><coderef></code> element. This step is implemented in SAX pipes.</li><li class="link olchildlink"><a href="../reference/preprocess-chunk.html">Chunk topics (chunk)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-maplink.html">Map based linking (maplink)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-topicpull.html">Pull content into topics (topicpull)</a><br>The <code class="ph codeph">topicpull</code> step pulls content into <code class="keyword markupname xmlelement"><xref></code> and <code class="keyword markupname xmlelement"><link></code> elements. This step is implemented in XSLT.</li><li class="link olchildlink"><a href="../reference/preprocess-flagging.html">Flagging (flag-module)</a><br>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.</li><li class="link olchildlink"><a href="../reference/preprocess-clean-map.html">Map cleanup (clean-map)</a><br>The <code class="ph codeph">clean-map</code> step removes any elements and attributes that were added to files to support preprocessing.</li><li class="link olchildlink"><a href="../reference/preprocess-copyfiles.html">Copy related files (copy-files)</a><br>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.</li></ol><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> |