PageRenderTime 46ms CodeModel.GetById 12ms RepoModel.GetById 1ms app.codeStats 0ms

/bundles/plugins-trunk/XInsert/xinsert.html

#
HTML | 505 lines | 321 code | 110 blank | 74 comment | 0 complexity | e84c4fd8f0b61932fddae22b576a1cd3 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

    2. 

  2. 

    3. 

  3. <html>

    4. 

  4. <head>

    5. 

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

    6. 

  6. 

    7. 

  7. <title>XInsert Plugin</title>

    8. 

  8. 

    9. 

  9. <style type="text/css">

    10. 

  10. <!--

    11. 

  11. .syntax0 {}

    12. 

  12. 

    13. 

  13. .syntax1 {

    14. 

  14. 	color: #990033;

    15. 

  15. 	}

    16. 

  16. 

    17. 

  17. .syntax2 {

    18. 

  18. 	color: #990033;

    19. 

  19. 	font-style: italic;

    20. 

  20. 	}

    21. 

  21. 

    22. 

  22. .syntax3 {

    23. 

  23. 	color: #650099;

    24. 

  24. 	}

    25. 

  25. 

    26. 

  26. .syntax4 {

    27. 

  27. 	color: #650099;

    28. 

  28. 	font-weight: bold;

    29. 

  29. 	}

    30. 

  30. 

    31. 

  31. .syntax5 {

    32. 

  32. 	color: #3366ff;

    33. 

  33. 	font-weight: bold;

    34. 

  34. 	}

    35. 

  35. 

    36. 

  36. .syntax6 {

    37. 

  37. 	color: #000000;

    38. 

  38. 	font-weight: bold;

    39. 

  39. 	}

    40. 

  40. 

    41. 

  41. .syntax7 {

    42. 

  42. 	color: #0033ff;

    43. 

  43. 	}

    44. 

  44. 

    45. 

  45. .syntax8 {

    46. 

  46. 	color: #009600;

    47. 

  47. 	}

    48. 

  48. 

    49. 

  49. .syntax9 {

    50. 

  50. 	color: #990033;

    51. 

  51. 	}

    52. 

  52. 

    53. 

  53. .syntax10 {

    54. 

  54. 	color: #5e5e5e;

    55. 

  55. 	font-weight: bold;

    56. 

  56. 	}

    57. 

  57. 

    58. 

  58. .syntax11 {

    59. 

  59. 	color: #000000;

    60. 

  60. 	font-weight: bold;

    61. 

  61. 	}

    62. 

  62. 

    63. 

  63. .syntax12 {

    64. 

  64. 	color: #009191;

    65. 

  65. 	}

    66. 

  66. 

    67. 

  67. .syntax13 {

    68. 

  68. 	color: #ff0000;

    69. 

  69. 	font-weight: bold;

    70. 

  70. 	}

    71. 

  71. 

    72. 

  72. .gutter {

    73. 

  73. 	background: #ffffff;

    74. 

  74. 	color: #8080c0;

    75. 

  75. 	width: 2em

    76. 

  76. 	}

    77. 

  77. 

    78. 

  78. .gutterH {

    79. 

  79. 	background: #ffffff;

    80. 

  80. 	color: #000000;

    81. 

  81. 	}

    82. 

  82. 

    83. 

  83. -->

    84. 

  84. 

    85. 

  85. </style>

    86. 

  86. </head>

    87. 

  87. <body>

    88. 

  88. <table style="background:#ccccff" border="0" width="100%" cellspacing="0" cellpadding="0">

    89. 

  89. <tr width="100%">

    90. 

  90. 	<td><h1>XInsert Plugin</h1></td>

    91. 

  91. 	<td align="right">

    92. 

  92. 	<font size="-1">By Dominic Stolerman and Romain Guy<br>

    93. 

  93. 	<i>dstolerman@jedit.org and guy.romain@bigfoot.com</i></font>

    94. 

  94. 	</td>

    95. 

  95. </tr>

    96. 

  96. </table>

    97. 

  97. 

    98. 

  98. <hr>

    99. 

  99. <h2>Introduction</h2>

    100. 

  100. 

    101. 

  101. <p>XInsert is a plugin that will insert a section of code/text

    102. 

  102. from a library into the current buffer, using a graphical tree

    103. 

  103. view. It also has the ability to run simple scripts in a native

    104. 

  104. format as well as BeanShell scripts.</p>

    105. 

  105. 

    106. 

  106. <p>XInsert started off as an adition to/part of the Jext text

    107. 

  107. editor written by Romain Guy. It was then modified to form a

    108. 

  108. plugin for jEdit by Romain as version 1.0.</p>

    109. 

  109. 

    110. 

  110. <p>Since then it has evolved into a plugin that is has a much

    111. 

  111. higher level of integration with jEdit through the work of

    112. 

  112. Dominic Stolerman.</p>

    113. 

  113. 

    114. 

  114. <p>Actions for easy navigation and inserting with the keyboard were

    115. 

  115. added by Martin Raspe (hertzhaft@biblhertz.it). He added

    116. 

  116. node references and re-styled the code. Martin is the current 

    117. 

  117. maintainer of the plugin.</p>

    118. 

  118. 

    119. 

  119. <h2>Inserting clips</h2>

    120. 

  120. 

    121. 

  121. <p>XInsert clips can be added in two ways: Either double click on

    122. 

  122. the desired item in the expanded branch, or select the desired

    123. 

  123. item in the tree and hit Enter or Space while the XInsert pane is

    124. 

  124. focused. For convenience two actions were added that can be bound to keystroke

    125. 

  125. combinations using the Utilities/Global Options/Shortcuts menu (A+F12).</p>

    126. 

  126. 

    127. 

  127. <ul>

    128. 

  128. <li><b>Focus XInsert</b> - focuses the XInsert pane, allowing

    129. 

  129. tree navigation by keyboard. Recommended shortcut:

    130. 

  130. CS-Insert.</li>

    131. 

  131. 

    132. 

  132. <li><b>Insert Selected Item</b> - Inserts the currently selected

    133. 

  133. item from the XInsert tree. Multiple inserts of the

    134. 

  134. same item are possible without having to re-enter the XInsert

    135. 

  135. pane. This action works even if the XInsert pane is not visible

    136. 

  136. or focused (it must be docked, though). Recommended shortcut: C-Insert 

    137. 

  137. (if you don't use this key combination for pasting from the clipboard).</li>

    138. 

  138. </ul>

    139. 

  139. 

    140. 

  140. <p>This way you have to remember just one keyboard shortcut to insert an item

    141. 

  141. or run a macro. Bring the XInsert pane into focus, then navigate

    142. 

  142. to the desired clip using the arrow keys. Press Enter or Space to reset the 

    143. 

  143. focus to the text area and insert the item. The selected item can be inserted

    144. 

  144. over again using another keyboard shortcut.</p>

    145. 

  145. 

    146. 

  146. <h2>XInsert Files</h2>

    147. 

  147. 

    148. 

  148. <p>Some XInsert files are supplied with XInsert, these include

    149. 

  149. Java, HTML, JavaScript and SSI inserts. These catagories appear

    150. 

  150. in the tree view by default but can be turned off using the

    151. 

  151. plugin options dialog box.Also all files with the name

    152. 

  152. *.insert.xml are loaded from the directory specified in the

    153. 

  153. plugin options. The default directory is .jedit/XInsert, although

    154. 

  154. this can be changed from the plugin settings dialog.</p>

    155. 

  155. 

    156. 

  156. <p><b>For settings set in the plugin options to take effect the

    157. 

  157. reload button on the tree view must be pressed</b></p>

    158. 

  158. 

    159. 

  159. <h2>Options</h2>

    160. 

  160. 

    161. 

  161. <h3>From the Plugin Options--&gt;XInsert Dialog:</h3>

    162. 

  162. 

    163. 

  163. <p><b>Display Default Inserts</b> - Enable/Disable displaying the

    164. 

  164. inserts in the jar file. Pressing "None" will hide them all

    165. 

  165. without losing your current settings.</p>

    166. 

  166. 

    167. 

  167. <p><b>Inserts directory</b> - The directory that will be searched

    168. 

  168. for additional insert files.</p>

    169. 

  169. 

    170. 

  170. <p><b>Global Variables</b> - Variables that will be used

    171. 

  171. throughout all of XInsert. I recomend you set these variables:

    172. 

  172. author, email webaddress</p>

    173. 

  173. 

    174. 

  174. <h3>On the XInsert Dialog</h3>

    175. 

  175. 

    176. 

  176. <p><b>Carriage Return</b> - If selected will add a new line after

    177. 

  177. all inserts.</p>

    178. 

  178. 

    179. 

  179. <p><b>Execute Scripts</b> - If selected will cause all inserts

    180. 

  180. with the <code>script</code> attribute to be executed. If it is

    181. 

  181. not selected script source will be inserted.</p>

    182. 

  182. 

    183. 

  183. <h2>XInsert File Format</h2>

    184. 

  184. 

    185. 

  185. <pre><font color="#000000"><font color="#0099ff"><strong>&lt;?</strong></font><font color="#0099ff"><strong>xml</strong></font><font color="#0099ff"><strong> </strong></font><font color="#0099ff"><strong>version=</strong></font><font color="#0099ff"><strong> </strong></font><font color="#0099ff"><strong>&quot;1.0&quot;</strong></font><font color="#0099ff"><strong> </strong></font><font color="#0099ff"><strong>encoding=</strong></font><font color="#0099ff"><strong> </strong></font><font color="#0099ff"><strong>&quot;ISO-8859-1&quot;?</strong></font><font color="#0099ff"><strong>&gt;</strong></font>

    186. 

  186. <font color="#009966"><strong>&lt;!</strong></font><font color="#009966"><strong>DOCTYPE</strong></font><font color="#009966"><strong> </strong></font><font color="#009966"><strong>xinsert</strong></font><font color="#009966"><strong> </strong></font><font color="#009966"><strong>SYSTEM</strong></font><font color="#009966"><strong> </strong></font><font color="#ff00cc">&quot;</font><font color="#ff00cc">jeditresource:/XInsert.jar!/xinsert.dtd</font><font color="#ff00cc">&quot;</font><font color="#009966"><strong>&gt;</strong></font>

    187. 

  187. <font color="#0000ff">&lt;</font><font color="#0000ff">xinsert</font><font color="#0000ff">&gt;</font>

    188. 

  188.   <font color="#0000ff">&lt;</font><font color="#0000ff">menu</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">[menu</font><font color="#ff00cc"> </font><font color="#ff00cc">name]</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>

    189. 

  189.     <font color="#0000ff">&lt;</font><font color="#0000ff">variable</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">foo</font><font color="#ff00cc">&quot;</font><font color="#0000ff"> </font><font color="#0000ff">value</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">bar</font><font color="#ff00cc">&quot;</font><font color="#0000ff">/</font><font color="#0000ff">&gt;</font>

    190. 

  190.     <font color="#0000ff">&lt;</font><font color="#0000ff">item</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">[Item</font><font color="#ff00cc"> </font><font color="#ff00cc">name]</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>[contents]<font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">item</font><font color="#0000ff">&gt;</font>

    191. 

  191.     <font color="#0000ff">&lt;</font><font color="#0000ff">item</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">foo</font><font color="#ff00cc"> </font><font color="#ff00cc">value</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>$foo<font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">item</font><font color="#0000ff">&gt;</font>

    192. 

  192.     <font color="#0000ff">&lt;</font><font color="#0000ff">item</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">[script</font><font color="#ff00cc"> </font><font color="#ff00cc">name]</font><font color="#ff00cc">&quot;</font><font color="#0000ff"> </font><font color="#0000ff">type</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">xinsert_script</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>[contents]<font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">item</font><font color="#0000ff">&gt;</font>

    193. 

  193.     <font color="#0000ff">&lt;</font><font color="#0000ff">item</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">[macro</font><font color="#ff00cc"> </font><font color="#ff00cc">name]</font><font color="#ff00cc">&quot;</font><font color="#0000ff"> </font><font color="#0000ff">type</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">macro</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>[contents]<font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">item</font><font color="#0000ff">&gt;</font>

    194. 

  194.     <font color="#0000ff">&lt;</font><font color="#0000ff">item</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">[macro</font><font color="#ff00cc"> </font><font color="#ff00cc">file</font><font color="#ff00cc"> </font><font color="#ff00cc">name]</font><font color="#ff00cc">&quot;</font><font color="#0000ff"> </font><font color="#0000ff">type</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">named_macro</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>[file_name]<font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">item</font><font color="#0000ff">&gt;</font>

    195. 

  195.     <font color="#0000ff">&lt;</font><font color="#0000ff">menu</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">sub</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>

    196. 

  196.       <font color="#0000ff">&lt;</font><font color="#0000ff">variable</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">foo</font><font color="#ff00cc">&quot;</font><font color="#0000ff"> </font><font color="#0000ff">value</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">bar2</font><font color="#ff00cc">&quot;</font><font color="#0000ff">/</font><font color="#0000ff">&gt;</font>

    197. 

  197.       <font color="#0000ff">&lt;</font><font color="#0000ff">item</font><font color="#0000ff"> </font><font color="#0000ff">name</font><font color="#0000ff">=</font><font color="#ff00cc">&quot;</font><font color="#ff00cc">foo</font><font color="#ff00cc"> </font><font color="#ff00cc">value</font><font color="#ff00cc">&quot;</font><font color="#0000ff">&gt;</font>$foo<font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">item</font><font color="#0000ff">&gt;</font>

    198. 

  198.     <font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">menu</font><font color="#0000ff">&gt;</font>

    199. 

  199.   <font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">menu</font><font color="#0000ff">&gt;</font>

    200. 

  200. <font color="#0000ff">&lt;</font><font color="#0000ff">/</font><font color="#0000ff">xinsert</font><font color="#0000ff">&gt;</font> 

    201. 

  201. </font></pre>

    202. 

  202. 

    203. 

  203. <p>XInsert files can have more than one <code>&lt;menu&gt;</code>

    204. 

  204. tag per file, can have <code>&lt;item&gt;</code> tags in the

    205. 

  205. <code>&lt;menu&gt;</code> tag. Unlimited nesting of

    206. 

  206. <code>&lt;menu&gt;</code> tags is supported.</p>

    207. 

  207. 

    208. 

  208. <p>Menu tags can also contain "variable" tags. When variables are

    209. 

  209. substituted into the insert the closest variable tag in the tree

    210. 

  210. hierachy is used.</p>

    211. 

  211. 

    212. 

  212. <p>Item tags can have one of five types (specified with the type

    213. 

  213. attribute):</p>

    214. 

  214. 

    215. 

  215. <dl compact>

    216. 

  216. <dt>text (default)</dt>

    217. 

  217. 

    218. 

  218. <dd>The text is inserted normally, with variable replacement etc.</dd>

    219. 

  219. 

    220. 

  220. <dt>macro</dt>

    221. 

  221. 

    222. 

  222. <dd>The content is run as a BeanShell macro script.</dd>

    223. 

  223. 

    224. 

  224. <dt>named_macro</dt>

    225. 

  225. 

    226. 

  226. <dd>The content is the name of a file that is run as a BeanShell script.</dd>

    227. 

  227. 

    228. 

  228. <dt>xinsert_script</dt>

    229. 

  229. 

    230. 

  230. <dd>The content is treated as an <a href="#script">xinsert script</a>.</dd>

    231. 

  231. 

    232. 

  232. <dt>action</dt>

    233. 

  233. 

    234. 

  234. <dd>The content is treated as the name of a jEdit action.</dd>

    235. 

  235. 

    236. 

  236. <dt>reference</dt>

    237. 

  237. 

    238. 

  238. <dd>The content is a path to another entry in the XInsert tree. It is constructed by 

    239. 

  239. concatenating the node names with slashes. The tree root is represented by "/". 

    240. 

  240. Example: "/Java/Javadoc/author". In this way you can reference a single item from plusieurs

    241. 

  241. places in the hierarchy. Chained or circular references are detected and do not work.

    242. 

  242. </dd>

    243. 

  243. </dl>

    244. 

  244. 

    245. 

  245. <p>When a named_macro item is encountered, XInsert searches for

    246. 

  246. the script file using the following protocol:</p>

    247. 

  247. 

    248. 

  248. <blockquote>

    249. 

  249. <p>1.&nbsp; If the file name has no extension, XInsert adds the

    250. 

  250. conventional BeanShell extension ".bsh";</p>

    251. 

  251. 

    252. 

  252. <p>2.&nbsp; If the full path name is not specified, XInsert

    253. 

  253. treats the file name as a relative path specification and looks

    254. 

  254. for the file in (a) the current working directory, (b) the

    255. 

  255. "macros" subdirectory of the jEdit home directory and (c) the

    256. 

  256. "macros" subdirectory of the jEdit user settings directory.</p>

    257. 

  257. </blockquote>

    258. 

  258. 

    259. 

  259. <p>If you make your own XInsert files, or if you copy the default

    260. 

  260. data files contained in the .jar file to the "Inserts Directory"

    261. 

  261. specified in the "Options" dialog, you can add the following

    262. 

  262. macro item to allow for easy editing of an XInsert file within

    263. 

  263. jEdit:</p>

    264. 

  264. 

    265. 

  265. <pre>

    266. 

  266. <span class="gutter">&nbsp;1:</span> <span class="syntax11">&lt;</span>item name="Open XInsert file" type="macro"&gt;

    267. 

  267. 

    268. 

  268. <span class="gutter">&nbsp;2:</span> jEdit.openFile(view,

    269. 

  269. 

    270. 

  270. <span class="gutter">&nbsp;3:</span>               jEdit.getProperty("xinsert.inserts-directory")

    271. 

  271. 

    272. 

  272. <span class="gutter">&nbsp;4:</span>                  + File.separator

    273. 

  273. 

    274. 

  274. <span class="gutter">&nbsp;5:</span>                  + "foo.insert.xml");

    275. 

  275. 

    276. 

  276. <span class="gutter">&nbsp;6:</span> <span class="syntax11">&lt;/</span>item&gt;

    277. 

  277. 

    278. 

  278. </pre>

    279. 

  279. 

    280. 

  280. <p>After making any changes to the file, save it within jEdit and

    281. 

  281. press the reload button on the XInsert tree view.&nbsp; The

    282. 

  282. changes will be immediately available.</p>

    283. 

  283. 

    284. 

  284. <p>As the XInsert files are xml the item contents and names must

    285. 

  285. not contain &lt; or &amp; symbols, but the HTML codescan be used,

    286. 

  286. <code>&amp;lt;,&amp;amp;</code>. Some special characters can be

    287. 

  287. used in the <code>ITEM_CONTENTS</code></p>

    288. 

  288. 

    289. 

  289. <dl>

    290. 

  290. <dt>\n</dt>

    291. 

  291. 

    292. 

  292. <dd>Inserts a new line.</dd>

    293. 

  293. 

    294. 

  294. <dt>\t</dt>

    295. 

  295. 

    296. 

  296. <dd>Inserts a tab (or spaces) of length set in the buffer

    297. 

  297. options.</dd>

    298. 

  298. 

    299. 

  299. <dt>|</dt>

    300. 

  300. 

    301. 

  301. <dd>Positions the cursor at this point, or inserts any text

    302. 

  302. selected at this point. If text is selected but there is no |

    303. 

  303. character then the selected text is replaced.</dd>

    304. 

  304. 

    305. 

  305. <dt>||</dt>

    306. 

  306. 

    307. 

  307. <dd>Inserts a | character.</dd>

    308. 

  308. 

    309. 

  309. <dt>\$</dt>

    310. 

  310. 

    311. 

  311. <dd>Inserts a $ character.</dd>

    312. 

  312. 

    313. 

  313. <dt>$foo</dt>

    314. 

  314. 

    315. 

  315. <dd>Inserts the variable neamed foo.</dd>

    316. 

  316. 

    317. 

  317. <dd>

    318. 

  318. <p>There are also some special variables:</p>

    319. 

  319. 

    320. 

  320. <dl compact>

    321. 

  321. <dt>$path</dt>

    322. 

  322. 

    323. 

  323. <dd>The path of the current buffer.</dd>

    324. 

  324. 

    325. 

  325. <dt>$filename</dt>

    326. 

  326. 

    327. 

  327. <dd>The filname of the current buffer.</dd>

    328. 

  328. 

    329. 

  329. <dt>$date</dt>

    330. 

  330. 

    331. 

  331. <dd>The current date.</dd>

    332. 

  332. 

    333. 

  333. <dt>$time</dt>

    334. 

  334. 

    335. 

  335. <dd>The current time.</dd>

    336. 

  336. 

    337. 

  337. <dt>$datetime</dt>

    338. 

  338. 

    339. 

  339. <dd>The current date and time.</dd>

    340. 

  340. 

    341. 

  341. <dt>$selected</dt>

    342. 

  342. 

    343. 

  343. <dd>The currently selected text in the buffer.</dd>

    344. 

  344. </dl>

    345. 

  345. </dd>

    346. 

  346. </dl>

    347. 

  347. 

    348. 

  348. <h2>XInsert Scripts</h2>

    349. 

  349. 

    350. 

  350. <p>XInsert has a built-in scripting language designed to add

    351. 

  351. certain functionality to text inserts such as showing dialog

    352. 

  352. boxes for inputs. It is not designed as a complete scripting

    353. 

  353. language.</p>

    354. 

  354. 

    355. 

  355. <p>All text in an &lt;item&gt; of type "xinsert_script" will be inserted

    356. 

  356. into the active buffer, except for embedded commands. Commands are just run,

    357. 

  357. their results are not inserted into the buffer.</p>

    358. 

  358. 

    359. 

  359. <p>Commands are surrounded by curly braces. The opening brace 

    360. 

  360. must be followed immediately by a "$", "@", "%", or "!", otherwise the text

    361. 

  361. is inserted literally. If you need to use a closing brace 

    362. 

  362. inside a command, escape it with a backslash. 

    363. 

  363. If all you want is to execute a command without inserting any 

    364. 

  364. additional text, be sure to leave no space between the &lt;item&gt; tags 

    365. 

  365. and the braces.</p>

    366. 

  366. 

    367. 

  367. <p>Note that all the commands are run in the order that

    368. 

  368. they appear in the script. This means you must set any variables 

    369. 

  369. before you attempt to use them.</p>

    370. 

  370. 

    371. 

  371. <p>For more help with XInsert scripts look at the scripts used in

    372. 

  372. the built-in insert files in

    373. 

  373. $jEditHome/jars/xinsert/net/sourceforge/jedit/xinsert</p>

    374. 

  374. 

    375. 

  375. <h3>Insert Variable <code>{$.....}</code></h3>

    376. 

  376. 

    377. 

  377. <blockquote>

    378. 

  378. <p>This command inserts variables similar to just

    379. 

  379. <code>$[variable name]</code> in a plain text insert.</p>

    380. 

  380. 

    381. 

  381. <p>This command has three forms:<br>

    382. 

  382.  <code>{$$[variable name]}</code> - the variable value is

    383. 

  383. inserted if found. Otherwise $[variable name] is inserted.<br>

    384. 

  384.  <code>{$=[variable name]}</code> - the variable value is

    385. 

  385. inserted if found. Otherwise nothing is inserted.<br>

    386. 

  386.  <code>{$?[variable name]}</code> - the variable value is

    387. 

  387. inserted if found. Otherwise a dialog box is displayed, prompting the

    388. 

  388. user to enter a value.</p>

    389. 

  389. </blockquote>

    390. 

  390. 

    391. 

  391. <h3>Set Variable <code>{%.....}</code></h3>

    392. 

  392. 

    393. 

  393. <blockquote>

    394. 

  394. <p>This is used to set a variable valid for the &lt;item&gt; it

    395. 

  395. is in. The general syntax is {%[variable name] ..... }. There are

    396. 

  396. two main variations:</p>

    397. 

  397. 

    398. 

  398. <p><code>{%[name] %set [value]}</code> - sets the variable to the

    399. 

  399. variable [name] to [value].</p>

    400. 

  400. 

    401. 

  401. <p>The other variation shows a prompt box to the user:<br>

    402. 

  402.  <code>{%[name] [list]}</code> - where [list] is a list of terms

    403. 

  403. in double quotes. The order and number of terms is important.</p>

    404. 

  404. 

    405. 

  405. <blockquote>

    406. 

  406. <table width="95%" border="1" cellspacing="0" cellpadding="0">

    407. 

  407. <tr>

    408. 

  408. <td width="19%"><b>No Of Terms</b></td>

    409. 

  409. <td width="81%"><b>Effect</b></td>

    410. 

  410. </tr>

    411. 

  411. 

    412. 

  412. <tr>

    413. 

  413. <td width="19%">none</td>

    414. 

  414. <td width="81%">Dialog box with default message shown</td>

    415. 

  415. </tr>

    416. 

  416. 

    417. 

  417. <tr>

    418. 

  418. <td width="19%">one</td>

    419. 

  419. <td width="81%">The term is used as a message to show the user

    420. 

  420. (e.g "Enter email address:"). The first term is always used for

    421. 

  421. this purpose if present.</td>

    422. 

  422. </tr>

    423. 

  423. 

    424. 

  424. <tr>

    425. 

  425. <td width="19%">two</td>

    426. 

  426. <td width="81%">The second term is used as a default value in the

    427. 

  427. dialog box<br>

    428. 

  428.  (e.g. "Enter email address:" "dds26@cam.ac.uk")</td>

    429. 

  429. </tr>

    430. 

  430. 

    431. 

  431. <tr>

    432. 

  432. <td width="19%">more than two</td>

    433. 

  433. <td width="81%">

    434. 

  434. <p>A dialog box with a choice of values is shown.<br>

    435. 

  435.  (e.g. "Enter email address:" "dds26@cam.ac.uk"

    436. 

  436. "another@email.com" "another email")<br>

    437. 

  437.  If after the last term there is a "?" then the user will be

    438. 

  438. allowed to enter thier own value as well.<br>

    439. 

  439.  (e.g. "Enter email address:" "dds26@cam.ac.uk"

    440. 

  440. "another@email.com" "another email" ?)</p>

    441. 

  441. </td>

    442. 

  442. </tr>

    443. 

  443. </table>

    444. 

  444. </blockquote>

    445. 

  445. </blockquote>

    446. 

  446. 

    447. 

  447. <h3>Run BeanShell Macro Command

    448. 

  448. <code>{@.....}</code></h1>

    449. 

  449. 

    450. 

  450. <blockquote>

    451. 

  451. <p>This runs the content of the braces as a BeanShell macro command.

    452. 

  452. <code>{@ jEdit.getAction("plugin-manager").invoke(view) }</code>

    453. 

  453. Multiple commands can be put into a single pair of braces, separated

    454. 

  454. by semicolons, or chained, e.g.: 

    455. 

  455. <code>{@ buffer.setMode("xml") }{@ textArea.setCaretPosition(0) }</code></p>

    456. 

  456. 

    457. 

  457. <p>Note that as the commands are run in order you can use a macro

    458. 

  458. command that will modify text inserted before it but not after

    459. 

  459. it.</p>

    460. 

  460. </blockquote>

    461. 

  461. 

    462. 

  462. <h3>Run Java Method Command

    463. 

  463. <code>{!.....}</code></h3>

    464. 

  464. 

    465. 

  465. <blockquote>

    466. 

  466. <p>This will run any <b>public static</b> java function in a

    467. 

  467. class that is in the classpath when jEdit is run. If the function

    468. 

  468. returns a string it will be inserted into the buffer. This

    469. 

  469. command allows the scripts to become as complicated as you may

    470. 

  470. wish, by writing the action you wish the script to perform in

    471. 

  471. Java, using all the features of Java, then calling it from

    472. 

  472. XInsert.</p>

    473. 

  473. 

    474. 

  474. <p>e.g:<br>

    475. 

  475.  <code>{!com.mypackage.MyClass.MyMethod()}</code> will invoke the

    476. 

  476. method <i>MyMethod()</i> in class

    477. 

  477. <i>com.mypackage.MyClass</i>.<br>

    478. 

  478.  <code>{!com.mypackage.MyClass.MyMethod([some text})}</code> will

    479. 

  479. invoke the method <i>MyMethod(String arg)</i> in class

    480. 

  480. <i>com.mypackage.MyClass</i> where the argument is [some

    481. 

  481. text].</p>

    482. 

  482. </blockquote>

    483. 

  483. 

    484. 

  484. <h2>Feedback</h2>

    485. 

  485. 

    486. 

  486. <ul>

    487. 

  487. <li>For bug reports use the Sourceforge Bug Tracker -

    488. 

  488. <a href="http://www.sourceforge.net/bugs/?group_id=588">http://www.sourceforge.net/bugs/?group_id=588</a>,

    489. 

  489. </li>

    490. 

  490. 

    491. 

  491. <li>or email the current maintainer Martin Raspe

    492. 

  492. (hertzhaft@biblhertz.it),

    493. 

  493. </li>

    494. 

  494. 

    495. 

  495. <li>or jEdit-users mailing-list

    496. 

  496. &lt;jedit-users@lists.sourceforge.net&gt;,

    497. 

  497. </li>

    498. 

  498. 

    499. 

  499. <li>or jEdit-devel mailing.list

    500. 

  500. &lt;jedit-devel@lists.sourceforge.net&gt;.

    501. 

  501. </li>

    502. 

  502. </ul>

    503. 

  503. </body>

    504. 

  504. </html>

    505. 

  505. 

    506. 

  506.