| 1234567891011 |
- <!DOCTYPE html
- SYSTEM "about:legacy-compat">
- <html lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="concept"><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="DC.Relation" scheme="URI" content="../dev_ref/DITA-OTArchitecture.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-genlist.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-debugfilter.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-mapref.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-copyfiles.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-keyref.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-conrefpush.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-conref.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-coderef.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-chunk.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-metadata.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-maplink.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-topicpull.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-flagging.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="preprocessarch"><meta name="DC.Language" content="en-US"><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 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a><ul><li><a href="../dev_ref/DITA-OTArchitecture.html">DITA-OT Architecture</a><ul><li><a href="../dev_ref/processing-structure.html">Processing structure</a></li><li><a href="../dev_ref/processing-pipeline-modules.html">Processing modules</a></li><li><a href="../dev_ref/processing-order.html">Processing order</a></li><li class="active"><a href="../dev_ref/DITA-OTPreprocess.html">Pre-processing modules</a><ul><li><a href="../dev_ref/preprocess-genlist.html">Generate lists (gen-list)</a></li><li><a href="../dev_ref/preprocess-debugfilter.html">Debug and filter (debug-filter)</a></li><li><a href="../dev_ref/preprocess-mapref.html">Resolve map references (mapref)</a></li><li><a href="../dev_ref/preprocess-copyfiles.html">Copy related files (copy-files)</a></li><li><a href="../dev_ref/preprocess-keyref.html">Resolve keyref (keyref)</a></li><li><a href="../dev_ref/preprocess-conrefpush.html">Conref push (conrefpush)</a></li><li><a href="../dev_ref/preprocess-conref.html">Conref (conref)</a></li><li><a href="../dev_ref/preprocess-coderef.html">Resolve code references (coderef)</a></li><li><a href="../dev_ref/preprocess-chunk.html">Chunk topics (chunk)</a></li><li><a href="../dev_ref/preprocess-metadata.html">Move metadata (move-meta-entries) and pull content into maps (mappull) </a></li><li><a href="../dev_ref/preprocess-maplink.html">Map based linking (maplink)</a></li><li><a href="../dev_ref/preprocess-topicpull.html">Pull content into topics (topicpull)</a></li><li><a href="../dev_ref/preprocess-flagging.html">Flagging in the toolkit</a></li></ul></li><li><a href="../dev_ref/XhtmlWithNavigation.html">HTML-based processing modules</a></li><li><a href="../dev_ref/PdfDefault.html">PDF processing modules</a></li><li><a href="../dev_ref/OdtDefault.html">Open Document Format processing modules</a></li></ul></li><li><a href="../dev_ref/extending-the-ot.html">Extending the DITA-OT</a></li><li><a href="../dev_ref/plugin-creating.html">Creating plug-ins</a></li><li><a href="../dev_ref/plugin-extension-points.html">Extension points</a></li><li><a href="../dev_ref/pdf-customization.html">Customizing PDF output</a></li><li><a href="../dev_ref/migration.html">Migrating customizations</a></li></ul></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
- <h1 class="title topictitle1" 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 preprocess target calls
- the entire set of steps.</p>
- <nav role="navigation" class="related-links"><ol class="olchildlinks"><li class="link olchildlink"><a href="../dev_ref/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="../dev_ref/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="../dev_ref/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="../dev_ref/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.</li><li class="link olchildlink"><a href="../dev_ref/preprocess-keyref.html">Resolve keyref (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="../dev_ref/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="../dev_ref/preprocess-conref.html">Conref (conref)</a><br>The <code class="ph codeph">conref</code> step resolves conref attributes, processing only the DITA maps or topics that use the @conref attribute. This step is implemented in XSLT.</li><li class="link olchildlink"><a href="../dev_ref/preprocess-coderef.html">Resolve code references (coderef)</a><br>The <code class="ph codeph">coderef</code> step resolves references made with the <code class="keyword markupname xmlelement"><coderef></code> element. This step is implemented in Java.</li><li class="link olchildlink"><a href="../dev_ref/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="../dev_ref/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="../dev_ref/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="../dev_ref/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="../dev_ref/preprocess-flagging.html">Flagging in the toolkit</a><br>Beginning with DITA-OT 1.7, flagging support is implemented as a common preprocess module. 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></ol><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/DITA-OTArchitecture.html" title="The 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.">Architecture of the DITA Open Toolkit</a></div></div></nav></article></main></body></html>
|