Changes between Version 1 and Version 2 of Documentation/Plugins/InsertSnippet2


Ignore:
Timestamp:
03/15/18 01:07:09 (5 weeks ago)
Author:
gogo
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/Plugins/InsertSnippet2

    v1 v2  
    4343                      <a href="Link1" class="Link1" tabindex="1"><span class="span_class"> Link1 </span></a> 
    4444                 </li> 
    45                  <li class="navi"> 
    46                       <a href="Link2" class="Link2" tabindex="2"><span class="span_class"> Link2 </span></a> 
    47                  </li> 
    48                  <li class="navi"> 
    49                       <a href="Link3" class="Link3" tabindex="3"><span class="span_class"> Link3 </span></a> 
    50                  </li> 
    51                  <li class="navi"> 
    52                       <a href="Link4" class="Link4" tabindex="4"><span class="span_class"> Link4 </span></a> 
    53                  </li> 
    54                  <li class="navi"> 
    55                       <a href="Link5" class="Link5" tabindex="5"><span class="span_class"> Link5 </span></a> 
    56                  </li> 
    5745              </ul> 
    5846            ]]> 
     
    6351 
    6452Obviously you can generate this file manually, or dynamically by whatever processes you desire, just specify the path to it in the configuration. 
     53 
     54  categories:: 
     55    An optional list of the categories to organise the snippets. 
     56 
     57  <c n="...">:: 
     58    The name of the category. 
     59 
     60  snippets:: 
     61    A list of each snippet (`<s>...</s>`), note that the contents of the snippet is not XML so we use CDATA or entisation to insert into the XML. 
     62     
     63  <s n="...">:: 
     64      The name of the snippet to display in the dialog. 
     65 
     66  <s c="...">:: 
     67      The category to place this snippet into. 
     68 
     69  <s v="...">:: 
     70      If supplied, this will be inserted instead of the snippet itself.  In other words the snippet becomes an "example of what this variable might look like" for the user, but the variable reference itself (v) is inserted. 
     71 
     72Don't ask me why the XML has one letter element and attribute names, historical? -- gogo