/plugins/LaTeXTools/branches/stable_0-5/latextools/config/index.html

# · HTML · 261 lines · 197 code · 61 blank · 3 comment · 0 complexity · d826cfe23ab02d881d0554b5cf6306c4 MD5 · raw file 

    

  1. <!-- :wrap=soft: -->
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    3. 

  3. "http://www.w3.org/TR/html4/loose.dtd">
    4. 

  4. <html>
    5. 

  5. <head>
    6. 

  6. <meta name="generator" content="HTML Tidy, see www.w3.org">
    7. 

  7. <title>LaTeX Tools Plugin</title>
    8. 

  8. <meta http-equiv="Content-Type" content=
    9. 

  9. "text/html; charset=utf-8">
    10. 

  10. <link rel="Stylesheet" type="text/css" href="latex.css">
    11. 

  11. <link href="history.html" rel="next">
    12. 

  12. <link href="featurereq.html" rel="last">
    13. 

  13. <link href="bugs.html" rel="Notes" title="Bugs">
    14. 

  14. <link href="featurereq.html" rel="Notes" title="Feature Requests">
    15. 

  15. <link href="history.html" rel="Notes" title="History">
    16. 

  16. </head>
    17. 

  17. <body>
    18. 

  18. <h1>LaTeX Tools Plugin.</h1>
    19. 

  19. 

  20. <p>This plugin is a collection of tools to make LaTeX editing an
    21. 

  21. easier and quicker task. The tools are generally inactive unless
    22. 

  22. the current buffer is a LaTeX file. The tools available at
    23. 

  23. present include the following:</p>
    24. 

  24. 

  25. <ul>
    26. 

  26. <li><a href="#project">Project Management</a></li>
    27. 

  27. 

  28. <li><a href="#commands">Useful Commands</a></li>
    29. 

  29. 

  30. <li><a href="#bibtex">BibTeX completion</a></li>
    31. 

  31. 

  32. <li><a href="#label">Reference Completion</a></li>
    33. 

  33. 

  34. <li><a href="#nav">LaTeX Navigator</a></li>
    35. 

  35. 

  36. <li><a href="history.html">Release Notes</a></li>
    37. 

  37. <!-- <li><a href="bugs.html">Bugs List</a></li>
    38. 

  38. <li><a href="featurereq.html">Feature Requests</a></li>
    39. 

  39.  --></ul>
    40. 

  40.  
    41. 

  41. <a name="project"></a>
    42. 

  42. 

  43. <h2>Project Management</h2>
    44. 

  44. 

  45. <P>A main file can be specified either globally or locally. The global setting is done through the plugin menu, where <em>Set Main File</em> sets the global main file to the current file, and <em>Reset Main File</em> removes the global property. The local setting is achieved by adding somewhere in the first 5 lines of the file the string <CODE>:latex.root=<em>Absolute or relative path to Main file</em>:</CODE>. The menu command <em>Show Main File</em> displays the path to the main file in a pop up box. Note that if present, the locally defined Main file has priority, followed by the globally defined property. If no global property has been set, then the current buffer is deemed to be the Main file.
    46. 

  46. </P>
    47. 

  47. 

  48. <P>The main file is used by several other commands, such as the two <em>Compile</em> commands, the <em>BiBTex</em>  command and the <em>Erase Working Files...</em> command. It is also used by the Label Navigator and the BibTeX Navigator in order to correctly parse information. <em>The project files</em> is a term used in these instructions to refer to the set of files that include the Main file and all files imported by files in the set.
    49. 

  49. </P>
    50. 

  50. 

  51.  
    52. 

  52. <a name="commands"></a>
    53. 

  53. 

  54. <h2>Useful Commands</h2>
    55. 

  55. 

  56. Various utility commands are included, accessible through the Plugins menu. These are catagorized as follows:
    57. 

  57. 

  58. <h3>Navigation</h3>
    59. 

  59. 

  60. <p>The commands <em>BibTeX Navigator</em>, <em>Label Navigator</em> and <em>Structure Browser</em>   simply open the relevant navigation windows. <em>Display Image</em> looks under the caret to see if a graphics object is present. If it is, then it tries to display the image in a (dockable) window.
    61. 

  61. </p>
    62. 

  62. 

  63. <p>
    64. 

  64. <em>Open Main File</em> simply opens the Main file as the current buffer. 
    65. 

  65. <em>Open Import</em> looks to see if there is an import statement under the caret, and if so tries to open the import file.
    66. 

  66. </p>
    67. 

  67. 

  68. <h3>Compilation</h3>
    69. 

  69. 

  70. There are four commands here. <em>Compile</em> runs the default compilation command on the current buffer using the Console plugin. The <em>Compile...</em> command allows the user to specify the compilation command in a text box (which maintains a history of commands). <em>BibTeX</em> runs BibTeX on the current buffer, again through the Console. <em>Erase Working Files...</em> displays a checkbox list of file extensions, and deletes all files in the same directory as the Main file with those extensions (giving plenty of opportunity to pull out at the last minute!).
    71. 

  71. 

  72. <h3>Project Management</h3>
    73. 

  73. 

  74. These are the commands <em>Set Main File</em>, <em>Reset Main File</em> and  <em>Show Main File Path</em>. These are described in <a href="#project">Project Management</a> above. 
    75. 

  75. 

  76. <h3>Text Insertion</h3>
    77. 

  77. 

  78. These are various shortcuts to manipulate text. They are pretty self explanatory so play around...
    79. 

  79. 

  80. <a name="bibtex"></a>
    81. 

  81. 

  82. <h2>BibTeX Completion</h2>
    83. 

  83. 

  84. <p>This tool searches the project files for a <code>\begin{thebibliography}</code>
    85. 

  85. environment, or  a
    86. 

  86. <code>\bibliography{}</code> command. If the former is found, the
    87. 

  87. current file is searched for <code>\bibitem</code> commands, and
    88. 

  88. compiles a list of such entries. If the latter is found, then all
    89. 

  89. referenced bib files are searched for the reference names and
    90. 

  90. reference titles, and a table compiled containing these.</p>
    91. 

  91. 

  92. <p>A dialog is displayed, from which a selection (or selections
    93. 

  93. if the ALT or CTRL keys are held down whilst clicking on table
    94. 

  94. entries) can be made. Once ENTER is pressed, all entries are
    95. 

  95. entered at the cursor position in the current buffer as a comma
    96. 

  96. delimited list. The dialog is cancelled by pressing ESCAPE, by
    97. 

  97. closing the dialog window, or by hitting ENTER with no selections
    98. 

  98. made.</p>
    99. 

  99. 

  100. <h3>Options</h3>
    101. 

  101. 

  102. <ul>
    103. 

  103. <li>
    104. 

  104. <p>Include Tag. If this is selected, then the string \cite{ and }
    105. 

  105. are inserted around the citations on enter.</p>
    106. 

  106. </li>
    107. 

  107. 

  108. <li>
    109. 

  109. <p>Maximum Letters in Title. The integer value gives the maximum
    110. 

  110. number of letters per word in the title. If set to 0, the title
    111. 

  111. is left intact. For example, if the value is set to 3, then
    112. 

  112. &quot;The Users Guide to jEdit&quot; is abbreviated to &quot;The
    113. 

  113. Use Gui to jEd&quot;.</p>
    114. 

  114. </li>
    115. 

  115. 

  116. <li>
    117. 

  117. <p>Maximum Words in Title. The integer value gives the maximum
    118. 

  118. number of words in the title. For example, if the value is set to
    119. 

  119. 3, then &quot;The Users Guide to jEdit&quot; is abbreviated to
    120. 

  120. &quot;The Users Guide&quot;.</p>
    121. 

  121. </li>
    122. 

  122. </ul>
    123. 

  123. 

  124. <a name="label"></a>
    125. 

  125. 

  126. <h2>Reference Completion</h2>
    127. 

  127. 

  128. <p>When activated, this tool simply searches the project files
    129. 

  129. for <code>\label{}</code> commands, and displays the results in a
    130. 

  130. dialog. Only single label can be selected (multiple
    131. 

  131. references in a single <code>\ref</code> are not supported in
    132. 

  132. LaTeX as they are in <code>\cite</code> commands).</p>
    133. 

  133. 

  134. <p>
    135. 

  135. Clicking a label has the following effects:
    136. 

  136. 

  137. <ul>
    138. 

  138. <li><strong>Single Click</strong>: scrolls to the label in the appropriate buffer. Note that this may change the current buffer.</li>
    139. 

  139. <li><strong>Double Click</strong>: inserts a reference to the label at the cursor position in the current buffer.</li>
    140. 

  140. <li><strong>ALT-Click</strong>: "locks" the insertion point for the reference to the cursor position of the current buffer, and then acts like the Single Click above. The lock is released when a click is performed without the ALT key and when the mouse leaves the navigator window.</li>
    141. 

  141. </ul>
    142. 

  142. 

  143. The ALT-Click locking mechanism allows the entire list of labels to be explored by keeping ALT held down and clicking the labels to view their positions. Double clicking a reference (with or without the ALT key) will insert the reference at the saved cursor location.
    144. 

  144. </p>
    145. 

  145. 

  146. <h3>Options</h3>
    147. 

  147. 

  148. <ul>
    149. 

  149. <li>
    150. 

  150. <p>Include Tag. If this is selected, then the string \ref{ and }
    151. 

  151. are inserted around the citations on enter.</p>
    152. 

  152. </li>
    153. 

  153. </ul>
    154. 

  154. 

  155. <a name="nav"></a>
    156. 

  156. 

  157. <h2>LaTeX Navigator</h2>
    158. 

  158. 

  159. <p>This feature implements a document navigator. By default all special
    160. 

  160. elements of the document are displayed in the SideKick structure browser.
    161. 

  161. A separate (dockable) dialog has controls for selecting the document
    162. 

  162. elements to parse - a few are predefined, but user defined lists can add to
    163. 

  163. or replace these, as described below.
    164. 

  164. </p>
    165. 

  165. 

  166. <h3>Suggested use.</h3>
    167. 

  167. 

  168. The way I use the document navigator is to have the Structure Browser docked to the right, and the Navigation Toolbar docked at the top (it is one line deep, so doesn't take much space). This way it is easy to select the features of the document you wish to see. If you simply want all of the main elements displayed, don't bother with the toolbar - it is the default parser.
    169. 

  169. 

  170. <h3>User defined Navigation Lists.</h3>
    171. 

  171. 

  172. <p>User defined navigation lists are text files containing search
    173. 

  173. data for parsing the document, and are placed in the directory
    174. 

  174. specified in the Global Options for the LaTeX Navigator. They
    175. 

  175. have the following syntax:</p>
    176. 

  176. 

  177. <p>Navigation lists must have a title as the first line of the
    178. 

  178. list, of the format, &quot;@<i>title</i><b>n</b>&quot;.
    179. 

  179. <i>title</i> is the name displayed in the combo box; <b>n</b> is
    180. 

  180. a single digit, giving the preferred position in the combo box (1
    181. 

  181. being the top, 9 being the bottom) or 0 if it should not appear
    182. 

  182. at all. Users can override default lists by adding a new list of
    183. 

  183. the same name to a user list - user lists take precedent over the
    184. 

  184. defaults.</p>
    185. 

  185. 

  186. <p>Following the title tag are the lines defining the search
    187. 

  187. strings to look for in the text. These must be of the format,
    188. 

  188. &quot;<strong>N:search string:replace string:I</strong> &quot;. where <strong>N</strong>  is the nesting level of the search string, and <strong>I</strong>  is the icon to use in the sidekick tree.
    189. 

  189. </p>
    190. 

  190. <p>
    191. 

  191.  The <strong>search string</strong>  is parsed as a regular expression (so if simple definitions are required, remember to escape special characters). </p>
    192. 

  192.  <p>
    193. 

  193.  The <strong>replace string</strong>  is an ordinary string, but the strings $1, $2, etc can be used to refer to captured groups in the search string. If the replace string is simply a "&nbsp;" (space) character, then any captured groups are concatenated and used as the text in the tree, or if no capturing groups are present, then the whole found string (group $0) is used as the tree text. Either a replace expression, or single space should be used as the replace string - other strings may have unpredictable results. Note also that if the ':' symbol is required in either search or replace string, the unicode escape \u003A should be used, or the navigation item will not be parsed correctly. An
    194. 

  194. example from the default navigation file follows:</p>
    195. 

  195. 

  196. <br>
    197. 

  197. 

  198. <div style="padding-left:4em;background:#dddddd">
    199. 

  199. <pre>
    200. 

  200. @Sections2
    201. 

  201. 1:\\chapter\{(.+?)\}: :1
    202. 

  202. 2:\\section\{(.+?)\}: :1
    203. 

  203. 3:\\subsection\{(.+?)\}: :1
    204. 

  204. 4:\\subsubsection\{(.+?)\}: :1
    205. 

  205. 5:\\paragraph\{(.+?)\}: :1
    206. 

  206. 

  207. @Theorems4
    208. 

  208. 1:\\begin\{theorem\}(\[.+?\])?:Thm\u003A $1:3
    209. 

  209. 1:\\begin\{lemma\}(\[.+?\])?:Lem\u003A $1:3
    210. 

  210. 1:\\begin\{proposition\}(\[.+?\])?:Prp\u003A $1:3
    211. 

  211. 1:\\begin\{definition\}(\[.+?\])?:Dfn\u003A $1:3
    212. 

  212. 1:\\begin\{corollary\}(\[.+?\])?:Cor\u003A $1:3
    213. 

  213. 2:\\begin\{proof\}(\[.+?\])?:Proof\u003A $1:0
    214. 

  214. 

  215. </pre>
    216. 

  216. </div>
    217. 

  217. <p>
    218. 

  218. Note that the Sections group in this example will only print the section title in the tree. The strings "Thm" etc will be displayed in the case of the Theorems group, along with the description if present.
    219. 

  219. </p>
    220. 

  220. 

  221. <p>The integers for various icons are as follows:</p>
    222. 

  222. 

  223. <table width="50%">
    224. 

  224. <tr>
    225. 

  225. <td><img alt="default" src="images/default.png"></td><td>Default</td><td>0</td>
    226. 

  226. </tr>
    227. 

  227. <tr>
    228. 

  228. <td><img alt="section" src="images/sections.png"></td><td>Section</td><td>1</td>
    229. 

  229. </tr>
    230. 

  230. <tr>
    231. 

  231. <td><img alt="graphics" src="images/graphics.png"></td><td>Graphics</td><td>2</td>
    232. 

  232. </tr>
    233. 

  233. <tr>
    234. 

  234. <td><img alt="theorem" src="images/theorem.png"></td><td>Theorem</td><td>3</td>
    235. 

  235. </tr>
    236. 

  236. <tr>
    237. 

  237. <td><img alt="table" src="images/table.png"></td><td>Table</td><td>4</td>
    238. 

  238. </tr>
    239. 

  239. <tr>
    240. 

  240. <td><img alt="list" src="images/list.png"></td><td>List</td><td>5</td>
    241. 

  241. </tr>
    242. 

  242. <tr>
    243. 

  243. <td><img alt="list" src="images/verbatim.png"></td><td>Verbatim</td><td>6</td>
    244. 

  244. </tr>
    245. 

  245. </table>
    246. 

  246. Any other integer value will display no image at all.
    247. 

  247. 

  248. 

  249. <br>
    250. 

  250. <a href="history.html">View Release Notes</a>
    251. 

  251. <br>
    252. 

  252. 

  253. 

  254. <hr>
    255. 

  255. <i>LaTeX Tools</i>
    256. 

  256. <p>Plugin maintained by <b>Anthony Roy</b> (<a href=
    257. 

  257. "home@antroy.co.uk">home@antroy.co.uk</a>).<span align="right">Last Modified: Sunday 28 December, 2003</span></p>
    258. 

  258. </body>
    259. 

  259. </html>
    260.