Accueil Explorer Aide
Connexion
levovix
/
Nim
miroir de https://github.com/nim-lang/Nim
Suivre 1
Voter 0
Fork 1
Fichiers Tickets 0 Wiki
Branche: gh-pages
Branches Tags
Nim
/
rstgen.html

rstgen.html 77 KB
Lien permanent Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>packages/docutils/rstgen</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

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

  27.       <h1 class="title">packages/docutils/rstgen</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    56. 

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

  59.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    60. 

  60.     <ul class="simple simple-toc-section">
    61. 

  61.       <li><a class="reference" href="#EscapeMode" title="EscapeMode = enum
    62. 

  62.   emText, emOption, emUrl">EscapeMode</a></li>
    63. 

  63. <li><a class="reference" href="#IndexedDocs" title="IndexedDocs = Table[IndexEntry, seq[IndexEntry]]">IndexedDocs</a></li>
    64. 

  64. <li><a class="reference" href="#MetaEnum" title="MetaEnum = enum
    65. 

  65.   metaNone, metaTitleRaw, metaTitle, metaSubtitle, metaAuthor, metaVersion">MetaEnum</a></li>
    66. 

  66. <li><a class="reference" href="#OutputTarget" title="OutputTarget = enum
    67. 

  67.   outHtml, outLatex">OutputTarget</a></li>
    68. 

  68. <li><a class="reference" href="#RstGenerator" title="RstGenerator = object of RootObj
    69. 

  69.   target*: OutputTarget
    70. 

  70.   config*: StringTableRef
    71. 

  71.   splitAfter*: int
    72. 

  72.   listingCounter*: int
    73. 

  73.   tocPart*: seq[PRstNode]
    74. 

  74.   hasToc*: bool
    75. 

  75.   findFile*: FindFileHandler
    76. 

  76.   msgHandler*: MsgHandler
    77. 

  77.   outDir*: string            ## output directory, initialized by docgen.nim
    78. 

  78.   destFile*: string          ## output (HTML) file, initialized by docgen.nim
    79. 

  79.   filenames*: RstFileTable
    80. 

  80.   filename*: string          ## source Nim or Rst file
    81. 

  81.   meta*: array[MetaEnum, string]
    82. 

  82.   ## \
    83. 

  83.   ## Stores the empty string or the last headline/overline found in the rst
    84. 

  84.   ## document, so it can be used as a prettier name for term index generation.
    85. 

  85.   ## \
    86. 

  86.   ## Keeps count of same text index terms to generate different identifiers
    87. 

  87.   ## for hyperlinks. See renderIndexTerm proc for details.
    88. 

  88.   id*: int                   ## A counter useful for generating IDs.
    89. 

  89.   onTestSnippet*: proc (d: var RstGenerator; filename, cmd: string; status: int;
    90. 

  90.                         content: string) {.gcsafe.}
    91. 

  91.   escMode*: EscapeMode">RstGenerator</a></li>
    92. 

  92. 

  93.     </ul>
    94. 

  94.   </details>
    95. 

  95. </li>
    96. 

  96. <li>
    97. 

  97.   <details open>
    98. 

  98.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    99. 

  99.     <ul class="simple simple-toc-section">
    100. 

  100.       <li><a class="reference" href="#IndexExt" title="IndexExt = &quot;.idx&quot;">IndexExt</a></li>
    101. 

  101. 

  102.     </ul>
    103. 

  103.   </details>
    104. 

  104. </li>
    105. 

  105. <li>
    106. 

  106.   <details open>
    107. 

  107.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    108. 

  108.     <ul class="simple simple-toc-section">
    109. 

  109.       <ul class="simple nested-toc-section">defaultConfig
    110. 

  110.   <li><a class="reference" href="#defaultConfig" title="defaultConfig(): StringTableRef">defaultConfig(): StringTableRef</a></li>
    111. 

  111. 

  112. </ul>
    113. 

  113. <ul class="simple nested-toc-section">esc
    114. 

  114.   <li><a class="reference" href="#esc%2COutputTarget%2Cstring%2Cint" title="esc(target: OutputTarget; s: string; splitAfter = -1; escMode = emText): string">esc(target: OutputTarget; s: string; splitAfter = -1; escMode = emText): string</a></li>
    115. 

  115. 

  116. </ul>
    117. 

  117. <ul class="simple nested-toc-section">escChar
    118. 

  118.   <li><a class="reference" href="#escChar%2COutputTarget%2Cstring%2Cchar%2CEscapeMode" title="escChar(target: OutputTarget; dest: var string; c: char; escMode: EscapeMode)">escChar(target: OutputTarget; dest: var string; c: char; escMode: EscapeMode)</a></li>
    119. 

  119. 

  120. </ul>
    121. 

  121. <ul class="simple nested-toc-section">formatNamedVars
    122. 

  122.   <li><a class="reference" href="#formatNamedVars%2Cstring%2CopenArray%5Bstring%5D%2CopenArray%5Bstring%5D" title="formatNamedVars(frmt: string; varnames: openArray[string];
    123. 

  123.                 varvalues: openArray[string]): string">formatNamedVars(frmt: string; varnames: openArray[string];
    124. 

  124.                 varvalues: openArray[string]): string</a></li>
    125. 

  125. 

  126. </ul>
    127. 

  127. <ul class="simple nested-toc-section">initRstGenerator
    128. 

  128.   <li><a class="reference" href="#initRstGenerator%2CRstGenerator%2COutputTarget%2CStringTableRef%2Cstring%2CFindFileHandler%2CMsgHandler" title="initRstGenerator(g: var RstGenerator; target: OutputTarget;
    129. 

  129.                  config: StringTableRef; filename: string;
    130. 

  130.                  findFile: FindFileHandler = nil; msgHandler: MsgHandler = nil;
    131. 

  131.                  filenames = default(RstFileTable); hasToc = false)">initRstGenerator(g: var RstGenerator; target: OutputTarget;
    132. 

  132.                  config: StringTableRef; filename: string;
    133. 

  133.                  findFile: FindFileHandler = nil; msgHandler: MsgHandler = nil;
    134. 

  134.                  filenames = default(RstFileTable); hasToc = false)</a></li>
    135. 

  135. 

  136. </ul>
    137. 

  137. <ul class="simple nested-toc-section">mergeIndexes
    138. 

  138.   <li><a class="reference" href="#mergeIndexes%2Cstring" title="mergeIndexes(dir: string): string">mergeIndexes(dir: string): string</a></li>
    139. 

  139. 

  140. </ul>
    141. 

  141. <ul class="simple nested-toc-section">nextSplitPoint
    142. 

  142.   <li><a class="reference" href="#nextSplitPoint%2Cstring%2Cint" title="nextSplitPoint(s: string; start: int): int">nextSplitPoint(s: string; start: int): int</a></li>
    143. 

  143. 

  144. </ul>
    145. 

  145. <ul class="simple nested-toc-section">prettyLink
    146. 

  146.   <li><a class="reference" href="#prettyLink%2Cstring" title="prettyLink(file: string): string">prettyLink(file: string): string</a></li>
    147. 

  147. 

  148. </ul>
    149. 

  149. <ul class="simple nested-toc-section">readIndexDir
    150. 

  150.   <li><a class="reference" href="#readIndexDir%2Cstring" title="readIndexDir(dir: string): tuple[modules: seq[string], symbols: seq[IndexEntry],
    151. 

  151.                                  docs: IndexedDocs]">readIndexDir(dir: string): tuple[modules: seq[string], symbols: seq[IndexEntry],
    152. 

  152.                                  docs: IndexedDocs]</a></li>
    153. 

  153. 

  154. </ul>
    155. 

  155. <ul class="simple nested-toc-section">renderCodeLang
    156. 

  156.   <li><a class="reference" href="#renderCodeLang%2Cstring%2CSourceLanguage%2Cstring%2COutputTarget" title="renderCodeLang(result: var string; lang: SourceLanguage; code: string;
    157. 

  157.                target: OutputTarget)">renderCodeLang(result: var string; lang: SourceLanguage; code: string;
    158. 

  158.                target: OutputTarget)</a></li>
    159. 

  159. 

  160. </ul>
    161. 

  161. <ul class="simple nested-toc-section">renderIndexTerm
    162. 

  162.   <li><a class="reference" href="#renderIndexTerm%2CPDoc%2CPRstNode%2Cstring" title="renderIndexTerm(d: PDoc; n: PRstNode; result: var string)">renderIndexTerm(d: PDoc; n: PRstNode; result: var string)</a></li>
    163. 

  163. 

  164. </ul>
    165. 

  165. <ul class="simple nested-toc-section">renderNimCode
    166. 

  166.   <li><a class="reference" href="#renderNimCode%2Cstring%2Cstring%2COutputTarget" title="renderNimCode(result: var string; code: string; target: OutputTarget)">renderNimCode(result: var string; code: string; target: OutputTarget)</a></li>
    167. 

  167. 

  168. </ul>
    169. 

  169. <ul class="simple nested-toc-section">renderRstToOut
    170. 

  170.   <li><a class="reference" href="#renderRstToOut%2CRstGenerator%2CPRstNode%2Cstring" title="renderRstToOut(d: var RstGenerator; n: PRstNode; result: var string)">renderRstToOut(d: var RstGenerator; n: PRstNode; result: var string)</a></li>
    171. 

  171. 

  172. </ul>
    173. 

  173. <ul class="simple nested-toc-section">renderTocEntries
    174. 

  174.   <li><a class="reference" href="#renderTocEntries%2CRstGenerator%2Cint%2Cint%2Cstring" title="renderTocEntries(d: var RstGenerator; j: var int; lvl: int; result: var string)">renderTocEntries(d: var RstGenerator; j: var int; lvl: int; result: var string)</a></li>
    175. 

  175. 

  176. </ul>
    177. 

  177. <ul class="simple nested-toc-section">rstToHtml
    178. 

  178.   <li><a class="reference" href="#rstToHtml%2Cstring%2CRstParseOptions%2CStringTableRef%2CMsgHandler" title="rstToHtml(s: string; options: RstParseOptions; config: StringTableRef;
    179. 

  179.           msgHandler: MsgHandler = rst.defaultMsgHandler): string">rstToHtml(s: string; options: RstParseOptions; config: StringTableRef;
    180. 

  180.           msgHandler: MsgHandler = rst.defaultMsgHandler): string</a></li>
    181. 

  181. 

  182. </ul>
    183. 

  183. <ul class="simple nested-toc-section">rstToLatex
    184. 

  184.   <li><a class="reference" href="#rstToLatex%2Cstring%2CRstParseOptions" title="rstToLatex(rstSource: string; options: RstParseOptions): string">rstToLatex(rstSource: string; options: RstParseOptions): string</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. <ul class="simple nested-toc-section">setIndexTerm
    188. 

  188.   <li><a class="reference" href="#setIndexTerm%2CRstGenerator%2CIndexEntryKind%2Cstring%2Cstring%2Cstring%2Cstring%2Cstring%2Cint" title="setIndexTerm(d: var RstGenerator; k: IndexEntryKind; htmlFile, id, term: string;
    189. 

  189.              linkTitle, linkDesc = &quot;&quot;; line = 0)">setIndexTerm(d: var RstGenerator; k: IndexEntryKind; htmlFile, id, term: string;
    190. 

  190.              linkTitle, linkDesc = &quot;&quot;; line = 0)</a></li>
    191. 

  191. 

  192. </ul>
    193. 

  193. <ul class="simple nested-toc-section">traverseForIndex
    194. 

  194.   <li><a class="reference" href="#traverseForIndex%2CPDoc%2CPRstNode" title="traverseForIndex(d: PDoc; n: PRstNode)">traverseForIndex(d: PDoc; n: PRstNode)</a></li>
    195. 

  195. 

  196. </ul>
    197. 

  197. <ul class="simple nested-toc-section">writeIndexFile
    198. 

  198.   <li><a class="reference" href="#writeIndexFile%2CRstGenerator%2Cstring" title="writeIndexFile(g: var RstGenerator; outfile: string)">writeIndexFile(g: var RstGenerator; outfile: string)</a></li>
    199. 

  199. 

  200. </ul>
    201. 

  201. 

  202.     </ul>
    203. 

  203.   </details>
    204. 

  204. </li>
    205. 

  205. 

  206. </ul>
    207. 

  207. 

  208.   </div>
    209. 

  209.   <div class="nine columns" id="content">
    210. 

  210.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    211. 

  211. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    212. 

  212. 

  213.     <div id="tocRoot"></div>
    214. 

  214.     
    215. 

  215.     <p class="module-desc"><p>This module implements a generator of HTML/Latex from <span id="restructuredtext_1">reStructuredText</span> (see <a class="reference external" href="https://docutils.sourceforge.net/rst.html">https://docutils.sourceforge.net/rst.html</a> for information on this markup syntax) and is used by the compiler's <a class="reference external" href="docgen.html">docgen tools</a>.</p>
    216. 

  216. <p>You can generate HTML output through the convenience proc <tt class="docutils literal"><span class="pre">rstToHtml</span></tt>, which provided an input string with rst markup returns a string with the generated HTML. The final output is meant to be embedded inside a full document you provide yourself, so it won't contain the usual <tt class="docutils literal"><span class="pre">&lt;header&gt;</span></tt> or <tt class="docutils literal"><span class="pre">&lt;body&gt;</span></tt> parts.</p>
    217. 

  217. <p>You can also create a <tt class="docutils literal"><span class="pre">RstGenerator</span></tt> structure and populate it with the other lower level methods to finally build complete documents. This requires many options and tweaking, but you are not limited to snippets and can generate <a class="reference external" href="https://en.wikipedia.org/wiki/LaTeX">LaTeX documents</a> too.</p>
    218. 

  218. <p><a class="reference external" href="https://docutils.sourceforge.io/docs/user/config.htm">Docutils configuration files</a> are not supported. Instead HTML generation can be tweaked by editing file <tt class="docutils literal"><span class="pre">config/nimdoc.cfg</span></tt>.</p>
    219. 

  219. <p>There are stylistic difference between how this module renders some elements and how original Python Docutils does:</p>
    220. 

  220. <ul class="simple"><li>Backreferences to TOC in section headings are not generated. In HTML each section is also a link that points to the section itself: this is done for user to be able to copy the link into clipboard.</li>
    221. 

  221. <li>The same goes for footnotes/citations links: they point to themselves. No backreferences are generated since finding all references of a footnote can be done by simply searching for <tt class="docutils literal"><span class="pre">[footnoteName]</span></tt>.</li>
    222. 

  222. </ul>
    223. 

  223. </p>
    224. 

  224.     <div class="section" id="6">
    225. 

  225.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    226. 

  226.   <dl class="item">
    227. 

  227.     <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="hashes.html">hashes</a>, <a class="reference external" href="strtabs.html">strtabs</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="sequtils.html">sequtils</a>, <a class="reference external" href="algorithm.html">algorithm</a>, <a class="reference external" href="parseutils.html">parseutils</a>, <a class="reference external" href="strbasics.html">strbasics</a>, <a class="reference external" href="rstast.html">rstast</a>, <a class="reference external" href="rst.html">rst</a>, <a class="reference external" href="rstidx.html">rstidx</a>, <a class="reference external" href="highlite.html">highlite</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="formatfloat.html">formatfloat</a>, <a class="reference external" href="since.html">since</a>
    228. 

  228.   </dl>
    229. 

  229. </div>
    230. 

  230. <div class="section" id="7">
    231. 

  231.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    232. 

  232.   <dl class="item">
    233. 

  233.     <div id="EscapeMode">
    234. 

  234.   <dt><pre><a href="rstgen.html#EscapeMode"><span class="Identifier">EscapeMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    235. 

  235.   <span class="Identifier">emText</span><span class="Other">,</span> <span class="Identifier">emOption</span><span class="Other">,</span> <span class="Identifier">emUrl</span></pre></dt>
    236. 

  236.   <dd>
    237. 

  237.     
    238. 

  238.     
    239. 

  239.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L65" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    240. 

  240. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L65" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    241. 

  241. 

  242.   </dd>
    243. 

  243. </div>
    244. 

  244. <div id="IndexedDocs">
    245. 

  245.   <dt><pre><a href="rstgen.html#IndexedDocs"><span class="Identifier">IndexedDocs</span></a> <span class="Other">=</span> <a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">,</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">]</span><span class="Other">]</span></pre></dt>
    246. 

  246.   <dd>
    247. 

  247.     
    248. 

  248.     <p>
    249. 

  249. Contains the index sequences for doc types.</p>
    250. 

  250. <p>The key is a <em>fake</em> IndexEntry which will contain the title of the document in the <tt class="docutils literal"><span class="pre"><span class="Identifier">keyword</span></span></tt> field and <tt class="docutils literal"><span class="pre"><span class="Identifier">link</span></span></tt> will contain the html filename for the document. <tt class="docutils literal"><span class="pre"><span class="Identifier">linkTitle</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">linkDesc</span></span></tt> will be empty.</p>
    251. 

  251. <p>The value indexed by this IndexEntry is a sequence with the real index entries found in the <tt class="docutils literal"><span class="pre">.idx</span></tt> file.</p>
    252. 

  252. 

  253.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L394" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    254. 

  254. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L394" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    255. 

  255. 

  256.   </dd>
    257. 

  257. </div>
    258. 

  258. <div id="MetaEnum">
    259. 

  259.   <dt><pre><a href="rstgen.html#MetaEnum"><span class="Identifier">MetaEnum</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    260. 

  260.   <span class="Identifier">metaNone</span><span class="Other">,</span> <span class="Identifier">metaTitleRaw</span><span class="Other">,</span> <span class="Identifier">metaTitle</span><span class="Other">,</span> <span class="Identifier">metaSubtitle</span><span class="Other">,</span> <span class="Identifier">metaAuthor</span><span class="Other">,</span> <span class="Identifier">metaVersion</span></pre></dt>
    261. 

  261.   <dd>
    262. 

  262.     
    263. 

  263.     
    264. 

  264.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L62" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    265. 

  265. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L62" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    266. 

  266. 

  267.   </dd>
    268. 

  268. </div>
    269. 

  269. <div id="OutputTarget">
    270. 

  270.   <dt><pre><a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    271. 

  271.   <span class="Identifier">outHtml</span><span class="Other">,</span> <span class="Identifier">outLatex</span></pre></dt>
    272. 

  272.   <dd>
    273. 

  273.     
    274. 

  274.     which document type to generate
    275. 

  275.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L58" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    276. 

  276. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L58" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    277. 

  277. 

  278.   </dd>
    279. 

  279. </div>
    280. 

  280. <div id="RstGenerator">
    281. 

  281.   <dt><pre><a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a>
    282. 

  282.   <span class="Identifier">target</span><span class="Operator">*</span><span class="Other">:</span> <a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a>
    283. 

  283.   <span class="Identifier">config</span><span class="Operator">*</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a>
    284. 

  284.   <span class="Identifier">splitAfter</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>
    285. 

  285.   <span class="Identifier">listingCounter</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>
    286. 

  286.   <span class="Identifier">tocPart</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">]</span>
    287. 

  287.   <span class="Identifier">hasToc</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a>
    288. 

  288.   <span class="Identifier">findFile</span><span class="Operator">*</span><span class="Other">:</span> <a href="rst.html#FindFileHandler"><span class="Identifier">FindFileHandler</span></a>
    289. 

  289.   <span class="Identifier">msgHandler</span><span class="Operator">*</span><span class="Other">:</span> <a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a>
    290. 

  290.   <span class="Identifier">outDir</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>            <span class="Comment">## output directory, initialized by docgen.nim</span>
    291. 

  291.   <span class="Identifier">destFile</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>          <span class="Comment">## output (HTML) file, initialized by docgen.nim</span>
    292. 

  292.   <span class="Identifier">filenames</span><span class="Operator">*</span><span class="Other">:</span> <a href="rst.html#RstFileTable"><span class="Identifier">RstFileTable</span></a>
    293. 

  293.   <span class="Identifier">filename</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>          <span class="Comment">## source Nim or Rst file</span>
    294. 

  294.   <span class="Identifier">meta</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">MetaEnum</span><span class="Other">,</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span>
    295. 

  295.   <span class="Comment">## \</span>
    296. 

  296.   <span class="Comment">## Stores the empty string or the last headline/overline found in the rst</span>
    297. 

  297.   <span class="Comment">## document, so it can be used as a prettier name for term index generation.</span>
    298. 

  298.   <span class="Comment">## \</span>
    299. 

  299.   <span class="Comment">## Keeps count of same text index terms to generate different identifiers</span>
    300. 

  300.   <span class="Comment">## for hyperlinks. See renderIndexTerm proc for details.</span>
    301. 

  301.   <span class="Identifier">id</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a>                   <span class="Comment">## A counter useful for generating IDs.</span>
    302. 

  302.   <span class="Identifier">onTestSnippet</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">,</span> <span class="Identifier">cmd</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">status</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span>
    303. 

  303.                         <span class="Identifier">content</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}
    304. 

  304.   <span class="Identifier">escMode</span><span class="Operator">*</span><span class="Other">:</span> <a href="rstgen.html#EscapeMode"><span class="Identifier">EscapeMode</span></a></pre></dt>
    305. 

  305.   <dd>
    306. 

  306.     
    307. 

  307.     
    308. 

  308.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L69" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    309. 

  309. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L69" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    310. 

  310. 

  311.   </dd>
    312. 

  312. </div>
    313. 

  313. 

  314.   </dl>
    315. 

  315. </div>
    316. 

  316. <div class="section" id="10">
    317. 

  317.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    318. 

  318.   <dl class="item">
    319. 

  319.     <div id="IndexExt">
    320. 

  320.   <dt><pre><a href="rstgen.html#IndexExt"><span class="Identifier">IndexExt</span></a> <span class="Other">=</span> <span class="StringLit">&quot;.idx&quot;</span></pre></dt>
    321. 

  321.   <dd>
    322. 

  322.     
    323. 

  323.     
    324. 

  324.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L55" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    325. 

  325. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L55" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    326. 

  326. 

  327.   </dd>
    328. 

  328. </div>
    329. 

  329. 

  330.   </dl>
    331. 

  331. </div>
    332. 

  332. <div class="section" id="12">
    333. 

  333.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    334. 

  334.   <dl class="item">
    335. 

  335.     <div id="defaultConfig-procs-all">
    336. 

  336.   <div id="defaultConfig">
    337. 

  337.   <dt><pre><span class="Keyword">proc</span> <a href="#defaultConfig"><span class="Identifier">defaultConfig</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    338. 

  338.   <dd>
    339. 

  339.     
    340. 

  340.     <p>Returns a default configuration for embedded HTML generation.</p>
    341. 

  341. <p>The returned <tt class="docutils literal"><span class="pre">StringTableRef</span></tt> contains the parameters used by the HTML engine to build the final output. For information on what these parameters are and their purpose, please look up the file <tt class="docutils literal"><span class="pre">config/nimdoc.cfg</span></tt> bundled with the compiler.</p>
    342. 

  342. <p>The only difference between the contents of that file and the values provided by this proc is the <tt class="docutils literal"><span class="pre">doc.file</span></tt> variable. The <tt class="docutils literal"><span class="pre">doc.file</span></tt> variable of the configuration file contains HTML to build standalone pages, while this proc returns just the content for procs like <tt class="docutils literal"><span class="pre">rstToHtml</span></tt> to generate the bare minimum HTML.</p>
    343. 

  343. 

  344.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L1445" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    345. 

  345. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L1445" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    346. 

  346. 

  347.   </dd>
    348. 

  348. </div>
    349. 

  349. 

  350. </div>
    351. 

  351. <div id="esc-procs-all">
    352. 

  352.   <div id="esc,OutputTarget,string,int">
    353. 

  353.   <dt><pre><span class="Keyword">proc</span> <a href="#esc%2COutputTarget%2Cstring%2Cint"><span class="Identifier">esc</span></a><span class="Other">(</span><span class="Identifier">target</span><span class="Other">:</span> <a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a><span class="Other">;</span> <span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">splitAfter</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span> <span class="Identifier">escMode</span> <span class="Other">=</span> <span class="Identifier">emText</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    354. 

  354.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    355. 

  355.   <dd>
    356. 

  356.     
    357. 

  357.     Escapes the HTML.
    358. 

  358.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L252" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    359. 

  359. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L252" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    360. 

  360. 

  361.   </dd>
    362. 

  362. </div>
    363. 

  363. 

  364. </div>
    365. 

  365. <div id="escChar-procs-all">
    366. 

  366.   <div id="escChar,OutputTarget,string,char,EscapeMode">
    367. 

  367.   <dt><pre><span class="Keyword">proc</span> <a href="#escChar%2COutputTarget%2Cstring%2Cchar%2CEscapeMode"><span class="Identifier">escChar</span></a><span class="Other">(</span><span class="Identifier">target</span><span class="Other">:</span> <a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a><span class="Other">;</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">c</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">;</span>
    368. 

  368.              <span class="Identifier">escMode</span><span class="Other">:</span> <a href="rstgen.html#EscapeMode"><span class="Identifier">EscapeMode</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    369. 

  369.   <dd>
    370. 

  370.     
    371. 

  371.     
    372. 

  372.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L229" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    373. 

  373. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L229" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    374. 

  374. 

  375.   </dd>
    376. 

  376. </div>
    377. 

  377. 

  378. </div>
    379. 

  379. <div id="formatNamedVars-procs-all">
    380. 

  380.   <div id="formatNamedVars,string,openArray[string],openArray[string]">
    381. 

  381.   <dt><pre><span class="Keyword">proc</span> <a href="#formatNamedVars%2Cstring%2CopenArray%5Bstring%5D%2CopenArray%5Bstring%5D"><span class="Identifier">formatNamedVars</span></a><span class="Other">(</span><span class="Identifier">frmt</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">varnames</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">;</span>
    382. 

  382.                      <span class="Identifier">varvalues</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    383. 

  383.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    384. 

  384.   <dd>
    385. 

  385.     
    386. 

  386.     
    387. 

  387.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L1384" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    388. 

  388. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L1384" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    389. 

  389. 

  390.   </dd>
    391. 

  391. </div>
    392. 

  392. 

  393. </div>
    394. 

  394. <div id="initRstGenerator-procs-all">
    395. 

  395.   <div id="initRstGenerator,RstGenerator,OutputTarget,StringTableRef,string,FindFileHandler,MsgHandler">
    396. 

  396.   <dt><pre><span class="Keyword">proc</span> <a href="#initRstGenerator%2CRstGenerator%2COutputTarget%2CStringTableRef%2Cstring%2CFindFileHandler%2CMsgHandler"><span class="Identifier">initRstGenerator</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a><span class="Other">;</span> <span class="Identifier">target</span><span class="Other">:</span> <a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a><span class="Other">;</span>
    397. 

  397.                       <span class="Identifier">config</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    398. 

  398.                       <span class="Identifier">findFile</span><span class="Other">:</span> <a href="rst.html#FindFileHandler"><span class="Identifier">FindFileHandler</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    399. 

  399.                       <span class="Identifier">msgHandler</span><span class="Other">:</span> <a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    400. 

  400.                       <span class="Identifier">filenames</span> <span class="Other">=</span> <span class="Identifier">default</span><span class="Other">(</span><a href="rst.html#RstFileTable"><span class="Identifier">RstFileTable</span></a><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">hasToc</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> {.
    401. 

  401.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    402. 

  402.   <dd>
    403. 

  403.     
    404. 

  404.     <p>Initializes a <tt class="docutils literal"><span class="pre">RstGenerator</span></tt>.</p>
    405. 

  405. <p>You need to call this before using a <tt class="docutils literal"><span class="pre">RstGenerator</span></tt> with any other procs in this module. Pass a non <tt class="docutils literal"><span class="pre">nil</span></tt> <tt class="docutils literal"><span class="pre">StringTableRef</span></tt> value as <tt class="docutils literal"><span class="pre"><span class="Identifier">config</span></span></tt> with parameters used by the HTML output generator.  If you don't know what to use, pass the results of the <tt class="docutils literal"><span class="pre"><span class="Identifier">defaultConfig</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">&lt;</span><span class="Comment">#defaultConfig&gt;_</span></span></tt> proc.</p>
    406. 

  406. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> parameter will be used for error reporting and creating index hyperlinks to the file, but you can pass an empty string here if you are parsing a stream in memory. If <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> ends with the <tt class="docutils literal"><span class="pre">.nim</span></tt> extension, the title for the document will be set by default to <tt class="docutils literal"><span class="pre">Module filename</span></tt>.  This default title can be overridden by the embedded rst, but it helps to prettify the generated index if no title is found.</p>
    407. 

  407. <p>The <tt class="docutils literal"><span class="pre">RstParseOptions</span></tt>, <tt class="docutils literal"><span class="pre">FindFileHandler</span></tt> and <tt class="docutils literal"><span class="pre">MsgHandler</span></tt> types are defined in the <a class="reference external" href="rst.html">packages/docutils/rst module</a>. <tt class="docutils literal"><span class="pre">options</span></tt> selects the behaviour of the rst parser.</p>
    408. 

  408. <p><tt class="docutils literal"><span class="pre">findFile</span></tt> is a proc used by the rst <tt class="docutils literal"><span class="pre">include</span></tt> directive among others. The purpose of this proc is to mangle or filter paths. It receives paths specified in the rst document and has to return a valid path to existing files or the empty string otherwise.  If you pass <tt class="docutils literal"><span class="pre">nil</span></tt>, a default proc will be used which given a path returns the input path only if the file exists. One use for this proc is to transform relative paths found in the document to absolute path, useful if the rst file and the resources it references are not in the same directory as the current working directory.</p>
    409. 

  409. <p>The <tt class="docutils literal"><span class="pre">msgHandler</span></tt> is a proc used for user error reporting. It will be called with the filename, line, col, and type of any error found during parsing. If you pass <tt class="docutils literal"><span class="pre">nil</span></tt>, a default message handler will be used which writes the messages to the standard output.</p>
    410. 

  410. <p>Example:</p>
    411. 

  411. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">packages</span><span class="Operator">/</span><span class="Identifier">docutils</span><span class="Operator">/</span><span class="Identifier">rstgen</span>
    412. 

  412. 

  413. <span class="Keyword">var</span> <span class="Identifier">gen</span><span class="Punctuation">:</span> <span class="Identifier">RstGenerator</span>
    414. 

  414. <span class="Identifier">gen</span><span class="Operator">.</span><span class="Identifier">initRstGenerator</span><span class="Punctuation">(</span><span class="Identifier">outHtml</span><span class="Punctuation">,</span> <span class="Identifier">defaultConfig</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="StringLit">&quot;filename&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">}</span><span class="Punctuation">)</span></pre></p>
    415. 

  415. 

  416.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L116" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    417. 

  417. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L116" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    418. 

  418. 

  419.   </dd>
    420. 

  420. </div>
    421. 

  421. 

  422. </div>
    423. 

  423. <div id="mergeIndexes-procs-all">
    424. 

  424.   <div id="mergeIndexes,string">
    425. 

  425.   <dt><pre><span class="Keyword">proc</span> <a href="#mergeIndexes%2Cstring"><span class="Identifier">mergeIndexes</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    426. 

  426.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    427. 

  427.   <dd>
    428. 

  428.     
    429. 

  429.     <p>Merges all index files in <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> and returns the generated index as HTML.</p>
    430. 

  430. <p>This proc will first scan <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> for index files with the <tt class="docutils literal"><span class="pre">.idx</span></tt> extension previously created by commands like <tt class="docutils literal"><span class="pre">nim doc|rst2html</span></tt> which use the <tt class="docutils literal"><span class="pre">--index:on</span></tt> switch. These index files are the result of calls to <a class="reference external" href="#setIndexTerm,RstGenerator,string,string,string,string,string">setIndexTerm()</a> and <a class="reference external" href="#writeIndexFile,RstGenerator,string">writeIndexFile()</a>, so they are simple tab separated files.</p>
    431. 

  431. <p>As convention this proc will split index files into two categories: documentation and API. API indices will be all joined together into a single big sorted index, making the bulk of the final index. This is good for API documentation because many symbols are repeated in different modules. On the other hand, documentation indices are essentially table of contents plus a few special markers. These documents will be rendered in a separate section which tries to maintain the order and hierarchy of the symbols in the index file.</p>
    432. 

  432. <p>To differentiate between a documentation and API file a convention is used: indices which contain one entry without the HTML hash character (#) will be considered <tt class="docutils literal"><span class="pre"><span class="Identifier">documentation</span></span></tt>, since this hash-less entry is the explicit title of the document.  Indices without this explicit entry will be considered <tt class="docutils literal"><span class="pre"><span class="Identifier">generated</span> <span class="Identifier">API</span></span></tt> extracted out of a source <tt class="docutils literal"><span class="pre">.nim</span></tt> file.</p>
    433. 

  433. <p>Returns the merged and sorted indices into a single HTML block which can be further embedded into nimdoc templates.</p>
    434. 

  434. 

  435.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L624" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    436. 

  436. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L624" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    437. 

  437. 

  438.   </dd>
    439. 

  439. </div>
    440. 

  440. 

  441. </div>
    442. 

  442. <div id="nextSplitPoint-procs-all">
    443. 

  443.   <div id="nextSplitPoint,string,int">
    444. 

  444.   <dt><pre><span class="Keyword">proc</span> <a href="#nextSplitPoint%2Cstring%2Cint"><span class="Identifier">nextSplitPoint</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    445. 

  445.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    446. 

  446.   <dd>
    447. 

  447.     
    448. 

  448.     
    449. 

  449.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L240" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    450. 

  450. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L240" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    451. 

  451. 

  452.   </dd>
    453. 

  453. </div>
    454. 

  454. 

  455. </div>
    456. 

  456. <div id="prettyLink-procs-all">
    457. 

  457.   <div id="prettyLink,string">
    458. 

  458.   <dt><pre><span class="Keyword">proc</span> <a href="#prettyLink%2Cstring"><span class="Identifier">prettyLink</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    459. 

  459.   <dd>
    460. 

  460.     
    461. 

  461.     
    462. 

  462.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    463. 

  463. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    464. 

  464. 

  465.   </dd>
    466. 

  466. </div>
    467. 

  467. 

  468. </div>
    469. 

  469. <div id="readIndexDir-procs-all">
    470. 

  470.   <div id="readIndexDir,string">
    471. 

  471.   <dt><pre><span class="Keyword">proc</span> <a href="#readIndexDir%2Cstring"><span class="Identifier">readIndexDir</span></a><span class="Other">(</span><span class="Identifier">dir</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">modules</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">,</span>
    472. 

  472.                                       <span class="Identifier">symbols</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="rstidx.html#IndexEntry"><span class="Identifier">IndexEntry</span></a><span class="Other">]</span><span class="Other">,</span>
    473. 

  473.                                       <span class="Identifier">docs</span><span class="Other">:</span> <a href="rstgen.html#IndexedDocs"><span class="Identifier">IndexedDocs</span></a><span class="Other">]</span> {.
    474. 

  474.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    475. 

  475.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    476. 

  476.   <dd>
    477. 

  477.     
    478. 

  478.     <p>Walks <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> reading <tt class="docutils literal"><span class="pre">.idx</span></tt> files converting them in IndexEntry items.</p>
    479. 

  479. <p>Returns the list of found module names, the list of free symbol entries and the different documentation indexes. The list of modules is sorted. See the documentation of <tt class="docutils literal"><span class="pre">mergeIndexes</span></tt> for details.</p>
    480. 

  480. 

  481.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L577" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    482. 

  482. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L577" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    483. 

  483. 

  484.   </dd>
    485. 

  485. </div>
    486. 

  486. 

  487. </div>
    488. 

  488. <div id="renderCodeLang-procs-all">
    489. 

  489.   <div id="renderCodeLang,string,SourceLanguage,string,OutputTarget">
    490. 

  490.   <dt><pre><span class="Keyword">proc</span> <a href="#renderCodeLang%2Cstring%2CSourceLanguage%2Cstring%2COutputTarget"><span class="Identifier">renderCodeLang</span></a><span class="Other">(</span><span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">lang</span><span class="Other">:</span> <a href="highlite.html#SourceLanguage"><span class="Identifier">SourceLanguage</span></a><span class="Other">;</span> <span class="Identifier">code</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    491. 

  491.                     <span class="Identifier">target</span><span class="Other">:</span> <a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    492. 

  492.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    493. 

  493.   <dd>
    494. 

  494.     
    495. 

  495.     
    496. 

  496.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L919" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    497. 

  497. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L919" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    498. 

  498. 

  499.   </dd>
    500. 

  500. </div>
    501. 

  501. 

  502. </div>
    503. 

  503. <div id="renderIndexTerm-procs-all">
    504. 

  504.   <div id="renderIndexTerm,PDoc,PRstNode,string">
    505. 

  505.   <dt><pre><span class="Keyword">proc</span> <a href="#renderIndexTerm%2CPDoc%2CPRstNode%2Cstring"><span class="Identifier">renderIndexTerm</span></a><span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <span class="Identifier">PDoc</span><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">;</span> <span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    506. 

  506.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    507. 

  507.   <dd>
    508. 

  508.     
    509. 

  509.     <p>Renders the string decorated within `foobar`:idx: markers.</p>
    510. 

  510. <p>Additionally adds the enclosed text to the index as a term. Since we are interested in different instances of the same term to have different entries, a table is used to keep track of the amount of times a term has previously appeared to give a different identifier value for each.</p>
    511. 

  511. 

  512.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L372" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    513. 

  513. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L372" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    514. 

  514. 

  515.   </dd>
    516. 

  516. </div>
    517. 

  517. 

  518. </div>
    519. 

  519. <div id="renderNimCode-procs-all">
    520. 

  520.   <div id="renderNimCode,string,string,OutputTarget">
    521. 

  521.   <dt><pre><span class="Keyword">proc</span> <a href="#renderNimCode%2Cstring%2Cstring%2COutputTarget"><span class="Identifier">renderNimCode</span></a><span class="Other">(</span><span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">code</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">target</span><span class="Other">:</span> <a href="rstgen.html#OutputTarget"><span class="Identifier">OutputTarget</span></a><span class="Other">)</span> {.
    522. 

  522.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    523. 

  523.   <dd>
    524. 

  524.     
    525. 

  525.     
    526. 

  526.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L935" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    527. 

  527. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L935" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    528. 

  528. 

  529.   </dd>
    530. 

  530. </div>
    531. 

  531. 

  532. </div>
    533. 

  533. <div id="renderRstToOut-procs-all">
    534. 

  534.   <div id="renderRstToOut,RstGenerator,PRstNode,string">
    535. 

  535.   <dt><pre><span class="Keyword">proc</span> <a href="#renderRstToOut%2CRstGenerator%2CPRstNode%2Cstring"><span class="Identifier">renderRstToOut</span></a><span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">;</span> <span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    536. 

  536.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    537. 

  537.   <dd>
    538. 

  538.     
    539. 

  539.     <p>Writes into <tt class="docutils literal"><span class="pre">result</span></tt> the rst ast <tt class="docutils literal"><span class="pre">n</span></tt> using the <tt class="docutils literal"><span class="pre">d</span></tt> configuration.</p>
    540. 

  540. <p>Before using this proc you need to initialise a <tt class="docutils literal"><span class="pre">RstGenerator</span></tt> with <tt class="docutils literal"><span class="pre">initRstGenerator</span></tt> and parse a rst file with <tt class="docutils literal"><span class="pre">rstParse</span></tt> from the <a class="reference external" href="rst.html">packages/docutils/rst module</a>. Example:</p>
    541. 

  541. <p><pre class="listing"><span class="Comment"># ...configure gen and rst vars...</span>
    542. 

  542. <span class="Keyword">var</span> <span class="Identifier">generatedHtml</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    543. 

  543. <span class="Identifier">renderRstToOut</span><span class="Punctuation">(</span><span class="Identifier">gen</span><span class="Punctuation">,</span> <span class="Identifier">rst</span><span class="Punctuation">,</span> <span class="Identifier">generatedHtml</span><span class="Punctuation">)</span>
    544. 

  544. <span class="Identifier">echo</span> <span class="Identifier">generatedHtml</span></pre></p>
    545. 

  545. 

  546.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L287" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    547. 

  547. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L287" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    548. 

  548. 

  549.   </dd>
    550. 

  550. </div>
    551. 

  551. 

  552. </div>
    553. 

  553. <div id="renderTocEntries-procs-all">
    554. 

  554.   <div id="renderTocEntries,RstGenerator,int,int,string">
    555. 

  555.   <dt><pre><span class="Keyword">proc</span> <a href="#renderTocEntries%2CRstGenerator%2Cint%2Cint%2Cstring"><span class="Identifier">renderTocEntries</span></a><span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a><span class="Other">;</span> <span class="Identifier">j</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">lvl</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span>
    556. 

  556.                       <span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    557. 

  557.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    558. 

  558.   <dd>
    559. 

  559.     
    560. 

  560.     
    561. 

  561.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L732" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    562. 

  562. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L732" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    563. 

  563. 

  564.   </dd>
    565. 

  565. </div>
    566. 

  566. 

  567. </div>
    568. 

  568. <div id="rstToHtml-procs-all">
    569. 

  569.   <div id="rstToHtml,string,RstParseOptions,StringTableRef,MsgHandler">
    570. 

  570.   <dt><pre><span class="Keyword">proc</span> <a href="#rstToHtml%2Cstring%2CRstParseOptions%2CStringTableRef%2CMsgHandler"><span class="Identifier">rstToHtml</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">options</span><span class="Other">:</span> <a href="rst.html#RstParseOptions"><span class="Identifier">RstParseOptions</span></a><span class="Other">;</span> <span class="Identifier">config</span><span class="Other">:</span> <a href="strtabs.html#StringTableRef"><span class="Identifier">StringTableRef</span></a><span class="Other">;</span>
    571. 

  571.                <span class="Identifier">msgHandler</span><span class="Other">:</span> <a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a> <span class="Other">=</span> <span class="Identifier">rst</span><span class="Other">.</span><span class="Identifier">defaultMsgHandler</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    572. 

  572.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    573. 

  573.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    574. 

  574.   <dd>
    575. 

  575.     
    576. 

  576.     <p>Converts an input rst string into embeddable HTML.</p>
    577. 

  577. <p>This convenience proc parses any input string using rst markup (it doesn't have to be a full document!) and returns an embeddable piece of HTML. The proc is meant to be used in <em>online</em> environments without access to a meaningful filesystem, and therefore rst <tt class="docutils literal"><span class="pre">include</span></tt> like directives won't work. For an explanation of the <tt class="docutils literal"><span class="pre">config</span></tt> parameter see the <tt class="docutils literal"><span class="pre">initRstGenerator</span></tt> proc. Example:</p>
    578. 

  578. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">packages</span><span class="Operator">/</span><span class="Identifier">docutils</span><span class="Operator">/</span><span class="Identifier">rstgen</span><span class="Punctuation">,</span> <span class="Identifier">strtabs</span>
    579. 

  579. 

  580. <span class="Identifier">echo</span> <span class="Identifier">rstToHtml</span><span class="Punctuation">(</span><span class="StringLit">&quot;*Hello* **world**!&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">}</span><span class="Punctuation">,</span>
    581. 

  581.   <span class="Identifier">newStringTable</span><span class="Punctuation">(</span><span class="Identifier">modeStyleInsensitive</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    582. 

  582. <span class="Comment"># --&gt; &lt;em&gt;Hello&lt;/em&gt; &lt;strong&gt;world&lt;/strong&gt;!</span></pre></p>
    583. 

  583. <p>If you need to allow the rst <tt class="docutils literal"><span class="pre">include</span></tt> directive or tweak the generated output you have to create your own <tt class="docutils literal"><span class="pre">RstGenerator</span></tt> with <tt class="docutils literal"><span class="pre">initRstGenerator</span></tt> and related procs.</p>
    584. 

  584. 

  585.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L1513" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    586. 

  586. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L1513" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    587. 

  587. 

  588.   </dd>
    589. 

  589. </div>
    590. 

  590. 

  591. </div>
    592. 

  592. <div id="rstToLatex-procs-all">
    593. 

  593.   <div id="rstToLatex,string,RstParseOptions">
    594. 

  594.   <dt><pre><span class="Keyword">proc</span> <a href="#rstToLatex%2Cstring%2CRstParseOptions"><span class="Identifier">rstToLatex</span></a><span class="Other">(</span><span class="Identifier">rstSource</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">options</span><span class="Other">:</span> <a href="rst.html#RstParseOptions"><span class="Identifier">RstParseOptions</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span>
    595. 

  595.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    596. 

  596.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    597. 

  597.   <dd>
    598. 

  598.     
    599. 

  599.     Convenience proc for <tt class="docutils literal"><span class="pre"><span class="Identifier">renderRstToOut</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">initRstGenerator</span></span></tt>.
    600. 

  600. <p><strong class="examples_text">Example:</strong></p>
    601. 

  601. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">rstToLatex</span><span class="Punctuation">(</span><span class="StringLit">&quot;*Hello* **world**&quot;</span><span class="Punctuation">,</span> <span class="Punctuation">{</span><span class="Punctuation">}</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;\emph{Hello} \textbf{world}&quot;&quot;&quot;</span></pre>
    602. 

  602.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L1555" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    603. 

  603. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L1555" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    604. 

  604. 

  605.   </dd>
    606. 

  606. </div>
    607. 

  607. 

  608. </div>
    609. 

  609. <div id="setIndexTerm-procs-all">
    610. 

  610.   <div id="setIndexTerm,RstGenerator,IndexEntryKind,string,string,string,string,string,int">
    611. 

  611.   <dt><pre><span class="Keyword">proc</span> <a href="#setIndexTerm%2CRstGenerator%2CIndexEntryKind%2Cstring%2Cstring%2Cstring%2Cstring%2Cstring%2Cint"><span class="Identifier">setIndexTerm</span></a><span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a><span class="Other">;</span> <span class="Identifier">k</span><span class="Other">:</span> <a href="rstidx.html#IndexEntryKind"><span class="Identifier">IndexEntryKind</span></a><span class="Other">;</span>
    612. 

  612.                   <span class="Identifier">htmlFile</span><span class="Other">,</span> <span class="Identifier">id</span><span class="Other">,</span> <span class="Identifier">term</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">linkTitle</span><span class="Other">,</span> <span class="Identifier">linkDesc</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">line</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span> {.
    613. 

  613.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    614. 

  614.   <dd>
    615. 

  615.     
    616. 

  616.     <p>Adds a <tt class="docutils literal"><span class="pre"><span class="Identifier">term</span></span></tt> to the index using the specified hyperlink identifier.</p>
    617. 

  617. <p>A new entry will be added to the index using the format <tt class="docutils literal"><span class="pre">term&lt;tab&gt;file#id</span></tt>. The file part will come from the <tt class="docutils literal"><span class="pre"><span class="Identifier">htmlFile</span></span></tt> parameter.</p>
    618. 

  618. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">id</span></span></tt> will be appended with a hash character only if its length is not zero, otherwise no specific anchor will be generated. In general you should only pass an empty <tt class="docutils literal"><span class="pre"><span class="Identifier">id</span></span></tt> value for the title of standalone rst documents (they are special for the <a class="reference external" href="#mergeIndexes,string">mergeIndexes()</a> proc, see <a class="reference external" href="docgen.html#index-idx-file-format">Index (idx) file format</a> for more information). Unlike other index terms, title entries are inserted at the beginning of the accumulated buffer to maintain a logical order of entries.</p>
    619. 

  619. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">linkTitle</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">linkDesc</span></span></tt> are not the empty string, two additional columns with their contents will be added.</p>
    620. 

  620. <p>The index won't be written to disk unless you call <a class="reference external" href="#writeIndexFile,RstGenerator,string">writeIndexFile()</a>. The purpose of the index is documented in the <a class="reference external" href="docgen.html#related-options-index-switch">docgen tools guide</a>.</p>
    621. 

  621. 

  622.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L325" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    623. 

  623. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L325" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    624. 

  624. 

  625.   </dd>
    626. 

  626. </div>
    627. 

  627. 

  628. </div>
    629. 

  629. <div id="traverseForIndex-procs-all">
    630. 

  630.   <div id="traverseForIndex,PDoc,PRstNode">
    631. 

  631.   <dt><pre><span class="Keyword">proc</span> <a href="#traverseForIndex%2CPDoc%2CPRstNode"><span class="Identifier">traverseForIndex</span></a><span class="Other">(</span><span class="Identifier">d</span><span class="Other">:</span> <span class="Identifier">PDoc</span><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    632. 

  632.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    633. 

  633.   <dd>
    634. 

  634.     
    635. 

  635.     A version of <a class="reference internal nimdoc" title="proc renderRstToOut(d: var RstGenerator; n: PRstNode; result: var string)" href="#renderRstToOut,RstGenerator,PRstNode,string">renderRstToOut</a> that only fills entries for <tt class="docutils literal"><span class="pre">.idx</span></tt> files.
    636. 

  636.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L1108" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    637. 

  637. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L1108" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    638. 

  638. 

  639.   </dd>
    640. 

  640. </div>
    641. 

  641. 

  642. </div>
    643. 

  643. <div id="writeIndexFile-procs-all">
    644. 

  644.   <div id="writeIndexFile,RstGenerator,string">
    645. 

  645.   <dt><pre><span class="Keyword">proc</span> <a href="#writeIndexFile%2CRstGenerator%2Cstring"><span class="Identifier">writeIndexFile</span></a><span class="Other">(</span><span class="Identifier">g</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rstgen.html#RstGenerator"><span class="Identifier">RstGenerator</span></a><span class="Other">;</span> <span class="Identifier">outfile</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    646. 

  646.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    647. 

  647.   <dd>
    648. 

  648.     
    649. 

  649.     <p>Writes the current index buffer to the specified output file.</p>
    650. 

  650. <p>You previously need to add entries to the index with the <a class="reference external" href="#setIndexTerm,RstGenerator,string,string,string,string,string">setIndexTerm()</a> proc. If the index is empty the file won't be created.</p>
    651. 

  651. 

  652.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rstgen.nim#L186" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    653. 

  653. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rstgen.nim#L186" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    654. 

  654. 

  655.   </dd>
    656. 

  656. </div>
    657. 

  657. 

  658. </div>
    659. 

  659. 

  660.   </dl>
    661. 

  661. </div>
    662. 

  662. 

  663.   </div>
    664. 

  664. </div>
    665. 

  665. 

  666.       <div class="twelve-columns footer">
    667. 

  667.         <span class="nim-sprite"></span>
    668. 

  668.         <br>
    669. 

  669.         <small style="color: var(--hint);">Made with Nim. Generated: 2024-12-25 13:27:44 UTC</small>
    670. 

  670.       </div>
    671. 

  671.     </div>
    672. 

  672.   </div>
    673. 

  673.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    674. 

  674.     
    675. 

  675. </body>
    676. 

  676. </html>
    677. 

  677.