Domů Procházet Nápověda
Přihlásit se
bn
/
se
2
0
Rozštěpit 0
Soubory Úkoly 0 Pull Requesty 0 Wiki
Strom: e89bfafc3a
Větve Značky
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
dev_ref
/
preprocess-conref.html

preprocess-conref.html 8.6 KB
Historie Surový

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  3. <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 conref step resolves conref attributes, processing only the DITA maps or topics that use the @conref attribute. This step is implemented in XSLT."><meta name="DC.Relation" scheme="URI" content="../dev_ref/DITA-OTPreprocess.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-conrefpush.html"><meta name="DC.Relation" scheme="URI" content="../dev_ref/preprocess-coderef.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="preprocess-conref"><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>Conref (conref)</title></head><body id="preprocess-conref"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </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><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 class="active"><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">
    7. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Conref (conref)</h1>
    8. 

  8.   
    9. 

  9.   <div class="body conbody"><p class="shortdesc">The <code class="ph codeph">conref</code> step resolves conref attributes, processing only the DITA maps or topics that
    10. 

  10.     use the @conref attribute. This step is implemented in XSLT.</p>
    11. 

  11.     <section class="section">
    12. 

  12.       <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
    13. 

  13.         into the new locations. This ensures that the values of the <code class="keyword markupname xmlatt">@id</code> attribute within the referencing
    14. 

  14.         topic remain unique.</p>
    15. 

  15.       <div class="p">If an element is pulled into a new context along with a cross reference that references the target, both the
    16. 

  16.         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
    17. 

  17.         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>
    18. 

  18.           
    19. 

  19.           <pre class="pre codeblock"><code>&lt;topic id="referenced_topic"&gt;
    20. 

  20.   &lt;title&gt;...&lt;/title&gt;
    21. 

  21.   &lt;body&gt;
    22. 

  22.     &lt;section id="sect"&gt;&lt;title&gt;Sample section&lt;/title&gt;
    23. 

  23.       &lt;p&gt;Figure &lt;xref href="#referenced_topic/fig"/&gt; contains an code sample that demonstrates ... .&lt;/p&gt;
    24. 

  24.       &lt;fig id="fig"&gt;&lt;title&gt;Code sample&lt;/title&gt;
    25. 

  25.         &lt;codeblock&gt;....&lt;/codeblock&gt;
    26. 

  26.       &lt;/fig&gt;
    27. 

  27.     &lt;/section&gt;
    28. 

  28.   &lt;/body&gt;
    29. 

  29. &lt;/topic&gt;</code></pre>
    30. 

  30.         </figure></div>
    31. 

  31.       <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
    32. 

  32.         </code>attribute on the <code class="keyword markupname xmlelement">&lt;fig&gt;</code> element is modified to ensure that it remains unique in
    33. 

  33.         the new context. At the same time, the  <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element is also modified so that it
    34. 

  34.         remains valid as a local reference. For example, if the referencing topic has an <code class="keyword markupname xmlatt">@id </code> set to
    35. 

  35.         "new_topic", then the conrefed  element may look like this in the intermediate
    36. 

  36.           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 &lt;section&gt; element after the conref step</figcaption>
    37. 

  37.           
    38. 

  38.           <pre class="pre codeblock"><code>&lt;section id="sect"&gt;&lt;title&gt;Sample section&lt;/title&gt;
    39. 

  39.     &lt;p&gt;Figure &lt;xref href="#new_topic/d1e25"/&gt; contains an code sample that demonstrates ... .&lt;/p&gt;
    40. 

  40.     &lt;fig id="d1e25"&gt;&lt;title&gt;Code sample&lt;/title&gt;
    41. 

  41.         &lt;codeblock&gt;....&lt;/codeblock&gt;
    42. 

  42.     &lt;/fig&gt;
    43. 

  43. &lt;/section&gt;</code></pre>
    44. 

  44.         </figure></div>
    45. 

  45.       <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
    46. 

  46.         been changed to a generated value of "d1e25". At the same time, the <code class="keyword markupname xmlelement">&lt;xref&gt;</code> element has
    47. 

  47.         been updated to use that new generated ID, so that the cross reference remains valid.</p>
    48. 

  48.     </section>
    49. 

  49.   </div>
    50. 

  50. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../dev_ref/DITA-OTPreprocess.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="../dev_ref/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="../dev_ref/preprocess-coderef.html" title="The coderef step resolves references made with the coderef element. This step is implemented in Java.">Resolve code references (coderef)</a></div></div></nav></article></main></body></html>
    51.