Ana Sayfa Keşfet Yardım
Giriş Yap
bn
/
se
2
0
Çatalla 0
Dosyalar Sorunlar 0 Değişiklik İstekleri 0 Wiki
Ağaç: e89bfafc3a
Dallar Biçim İmleri
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
user-guide
/
extended-functionality.html

extended-functionality.html 6.1 KB
Geçmiş Ham

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 
  1. <!DOCTYPE html
    2. 

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

  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="reference"><meta name="description" content="DITA-OT provides additional code reference processing support beyond that which is mandated by the DITA specification. These extensions can be used to define character encodings or line ranges for use in code blocks."><meta name="DC.Relation" scheme="URI" content="../user-guide/DITA_spec-support.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="extended-functionality"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Extended functionality</title></head><body id="extended-functionality"><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><ul><li><a href="../user-guide/transforming-dita-content.html">Publishing DITA content</a></li><li><a href="../user-guide/AvailableTransforms.html">Output formats</a></li><li><a href="../user-guide/DITA_spec-support.html">DITA specification support</a><ul><li><a href="../user-guide/DITA_v1-2-support.html">DITA 1.2 support</a></li><li><a href="../user-guide/DITA_v1-3-support.html">DITA 1.3 support</a></li><li><a href="../user-guide/implementation-dependent-features.html">Feature implementation</a></li><li class="active"><a href="../user-guide/extended-functionality.html">Extended functionality</a></li></ul></li><li><a href="../user-guide/DITA-globalization.html">Globalizing DITA content</a></li><li><a href="../user-guide/troubleshooting-overview.html">Troubleshooting</a></li></ul></li><li><a href="../parameters/index.html">Parameter Reference</a></li><li><a href="../dev_ref/index.html">Developer Reference</a></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
    7. 

  7. 

  8.   <h1 class="title topictitle1" id="ariaid-title1">Extended functionality</h1>
    9. 

  9. 

  10.   <p class="shortdesc">DITA-OT provides additional code reference processing support beyond that which is mandated by the DITA
    11. 

  11.     specification. These extensions can be used to define character encodings or line ranges for use in code
    12. 

  12.     blocks.</p>
    13. 

  13. 

  14.   <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../user-guide/DITA_spec-support.html" title="DITA Open Toolkit 2.3 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 class="topic reference nested1" aria-labelledby="ariaid-title2" id="extended-functionality__code-reference">
    15. 

  15.     <h2 class="title topictitle2" id="ariaid-title2">Code reference processing</h2>
    16. 

  16.     <div class="body refbody">
    17. 

  17.       <section class="section" id="code-reference__coderef-charset"><h3 class="title sectiontitle">Character set definition</h3>
    18. 

  18.         
    19. 

  19.         <p class="p">DITA-OT supports defining the code reference target file encoding using the <code class="keyword markupname xmlatt">@format</code>
    20. 

  20.           attribute. The supported format is:</p>
    21. 

  21.         <pre class="pre codeblock"><code>format (";" space* "charset=" charset)?</code></pre>
    22. 

  22.         <p class="p">If a character set is not defined, the system default character set will be used. If the character set is not
    23. 

  23.           recognized or supported, the <span class="keyword msgnum">DOTJ052E</span> error is thrown and the system default character set is
    24. 

  24.           used as a fall-back.</p>
    25. 

  25.       </section>
    26. 

  26.       <div class="example">
    27. 

  27.         <pre class="pre codeblock"><code>&lt;coderef href="unicode.txt" format="txt; charset=UTF-8"/&gt;</code></pre>
    28. 

  28.       </div>
    29. 

  29.       <section class="section"><h3 class="title sectiontitle">Line range extraction</h3>
    30. 

  30.         
    31. 

  31.         <p class="p">Code references can be limited to extract only a specified line range by defining the
    32. 

  32.             <code class="ph codeph">line-range</code> pointer in the URI fragment. The format is:</p>
    33. 

  33.         <pre class="pre codeblock"><code>uri ("#line-range(" start ("," end)? ")" )?</code></pre>
    34. 

  34.         <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
    35. 

  35.           last line of the file.</p>
    36. 

  36.       </section>
    37. 

  37.       <div class="example">
    38. 

  38.         <pre class="pre codeblock"><code>&lt;coderef href="Parser.scala#line-range(5, 10)" format="scala"/&gt;</code></pre>
    39. 

  39.         <p class="p">Only lines from 5 to 10 will be included in the output.</p>
    40. 

  40.       </div>
    41. 

  41.       <section class="section"><h3 class="title sectiontitle">RFC 5147</h3>
    42. 

  42.         
    43. 

  43.         <p class="p">DITA-OT implements line position and range from <a class="xref" href="http://tools.ietf.org/html/rfc5147" target="_blank">RFC 5147</a>. The format for line range is:</p>
    44. 

  44.         <pre class="pre codeblock"><code>uri ("#line=" start? "," end? )?</code></pre>
    45. 

  45.         <p class="p">Start and end line numbers start from 0 and are inclusive and exclusive, respectively. If the start range is
    46. 

  46.           omitted, the range starts from the first line; if the end range is omitted, the range ends on the last line of
    47. 

  47.           the file. The format for line position is:</p>
    48. 

  48.         <pre class="pre codeblock"><code>uri ("#line=" position )?</code></pre>
    49. 

  49.         <p class="p">Position line number starts from 0.</p>
    50. 

  50.       </section>
    51. 

  51.       <div class="example">
    52. 

  52.         <pre class="pre codeblock"><code>&lt;coderef href="Parser.scala#line=4,10" format="scala"/&gt;</code></pre>
    53. 

  53.         <p class="p">Only lines from 5 to 10 will be included in the output.</p>
    54. 

  54.       </div>
    55. 

  55.     </div>
    56. 

  56.   </article>
    57. 

  57. </article></main></body></html>
    58.