Difference between revisions of "Snippets syntax"

From Bluefish Wiki
Jump to: navigation, search
m
m
Line 26: Line 26:
 
# <nowiki><branch title="Facebook"></nowiki>
 
# <nowiki><branch title="Facebook"></nowiki>
 
# <nowiki><leaf type="insert" title="bold"><before></nowiki><span style="color:red">&amp;lt;</span><nowiki>b</nowiki><span style="color:red">&amp;gt;</span><nowiki></before><after></nowiki><span style="color:red">&amp;lt;</span><nowiki>/b</nowiki><span style="color:red">&amp;gt;</span><nowiki></after></leaf></nowiki>
 
# <nowiki><leaf type="insert" title="bold"><before></nowiki><span style="color:red">&amp;lt;</span><nowiki>b</nowiki><span style="color:red">&amp;gt;</span><nowiki></before><after></nowiki><span style="color:red">&amp;lt;</span><nowiki>/b</nowiki><span style="color:red">&amp;gt;</span><nowiki></after></leaf></nowiki>
# <nowiki><leaf type="insert" title="italic"><before></nowiki><span style="color:red">&amp;lt;</span><nowiki>i</nowiki><span style="color:red">&amp;gt;</span><nowiki></before><after></nowiki><span style="color:red">&amp;lt;</span><nowiki>/i</nowiki><span style="color:red">&amp;gt;</span><nowiki></after></leaf></nowiki>
+
# <nowiki><leaf type="insert" title="italic"</nowiki><span style="color:blue"> tooltip="insert an italic tag"</span><nowiki>><before></nowiki><span style="color:red">&amp;lt;</span><nowiki>i</nowiki><span style="color:red">&amp;gt;</span><nowiki></before><after></nowiki><span style="color:red">&amp;lt;</span><nowiki>/i</nowiki><span style="color:red">&amp;gt;</span><nowiki></after></leaf></nowiki>
# <nowiki><leaf type="insert" title="Hyperlink"><before></nowiki><span style="color:red">&amp;lt;</span><nowiki>a href="%0"</nowiki><span style="color:red">&amp;gt;</span><nowiki></before><after></nowiki><span style="color:red">&amp;lt;</span><nowiki>/a</nowiki><span style="color:red">&amp;gt;</span><nowiki></after></nowiki><span style="color:blue"><nowiki><param name="url"/></nowiki></span><nowiki></leaf></nowiki>
+
# <nowiki><leaf type="insert" title="Hyperlink"><before></nowiki><span style="color:red">&amp;lt;</span>a href="<span style="color:blue">%0</span>"<span style="color:red">&amp;gt;</span><nowiki></before><after></nowiki><span style="color:red">&amp;lt;</span><nowiki>/a</nowiki><span style="color:red">&amp;gt;</span><nowiki></after></nowiki><span style="color:blue"><nowiki><param name="url"/></nowiki></span><nowiki></leaf></nowiki>
 
# <nowiki><leaf type="insert" title="em-dash"><before></nowiki><span style="color:red">&</span><span style="color:red">amp;</span><nowiki>mdash;</before></nowiki><span style="color:blue"><nowiki><after></after></nowiki></span><nowiki></leaf></nowiki>
 
# <nowiki><leaf type="insert" title="em-dash"><before></nowiki><span style="color:red">&</span><span style="color:red">amp;</span><nowiki>mdash;</before></nowiki><span style="color:blue"><nowiki><after></after></nowiki></span><nowiki></leaf></nowiki>
 
# <nowiki></branch></nowiki>
 
# <nowiki></branch></nowiki>
 
# <nowiki></snippets></nowiki>
 
# <nowiki></snippets></nowiki>
 +
</ol>
 +
 +
;First and important, : if you want to insert any XML reserved characters ie: '''&lt; &gt; &amp;''' you have to escape them (red highlighted in example).
 +
* A leaf tag must have type and title attributes,
 +
* it also may have a tooltip attribute (line 5 of example).
 +
* Before tag is used for text to insert before, and after tag for text inserted after.
 +
* You have to add one or more param tags (with name attibute) if you want tu use parameters (line 6 of example).
 +
 
=== Search and replace snippets ===
 
=== Search and replace snippets ===
  
</ol>
+
 
  
 
{{Man2bottom
 
{{Man2bottom

Revision as of 19:27, 20 March 2010

this page is updated for Manual 2. It needs to be verified! once you have verified this page (and corrected if necessary) please modify the status to v (verified), i.e. st=v (see Guidelines for Writing this Manual)

Man2 icon 48.png
Chapter VII. More than a Text Editor
Prev 
Snippets syntax
 Next
 

The snippets are stored in ~/.bluefish/snippets. It is an XML file, like import and export snippets files.

  • The import file must have a valid XML syntax.
  • The document must include the header: <?xml version="1.0"?>.
  • The document must be included in the container: <snippets> <snippets>
  • Any snippet must be contained in a branch: <branch title="example"> </branch>
  • The branches may contain other branches.
  • Each snippet is described in a container: <leaf> </leaf>

Syntax examples

There are two types of snippets: insert and snr, aka Search N Replace.

Insert snippets

    1. <?xml version="1.0"?>
    2. <snippets>
    3. <branch title="Facebook">
    4. <leaf type="insert" title="bold"><before>&lt;b&gt;</before><after>&lt;/b&gt;</after></leaf>
    5. <leaf type="insert" title="italic" tooltip="insert an italic tag"><before>&lt;i&gt;</before><after>&lt;/i&gt;</after></leaf>
    6. <leaf type="insert" title="Hyperlink"><before>&lt;a href="%0"&gt;</before><after>&lt;/a&gt;</after><param name="url"/></leaf>
    7. <leaf type="insert" title="em-dash"><before>&amp;mdash;</before><after></after></leaf>
    8. </branch>
    9. </snippets>
First and important, 
if you want to insert any XML reserved characters ie: < > & you have to escape them (red highlighted in example).
  • A leaf tag must have type and title attributes,
  • it also may have a tooltip attribute (line 5 of example).
  • Before tag is used for text to insert before, and after tag for text inserted after.
  • You have to add one or more param tags (with name attibute) if you want tu use parameters (line 6 of example).

Search and replace snippets

Prev 
Up
 Next
7.Snippets plugin
Home | ToC
 Chapter VIII. Customising Bluefish