Snippets syntax: Difference between revisions

Latest revision as of 15:59, 16 November 2010

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

Bluefish has an excellent editor snippets. So it is useless to read this page unless you intend to create a large number of snippets from some documentation, eg: SVG, DOM, etc.

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

<?xml version="1.0"?>
<snippets>
<branch title="Facebook">
<leaf type="insert" title="bold"><before><b></before><after></b></after></leaf>
<leaf type="insert" title="italic" tooltip="insert an italic tag"><before><i></before><after></i></after></leaf>
<leaf type="insert" title="Hyperlink"><before><a href="%0"></before><after></a></after><param name="url"/></leaf>
<leaf type="insert" title="em-dash"><before>&mdash;</before><after></after></leaf>
</branch>
</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).
- multiline tooltip, Line Feed 
  , Carriage return , Tab 	
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).

<param num="1" name="image"/> The num attribute of param is not used, only the order of params declaration is used, first param for %0 etc.
<param name="source" is_file="1"/> If is_file is set, a Browse button is added in dialog.

Search and replace snippets

SnR snippets are a little more complex:

<leaf type="snr" title="replace 1" tooltip="introduce events" region="b" matchtype="normal" casesens="0" escapechars="0">
<searchpat>jpg</searchpat>
<replacepat>jpg" alt="" onmouseout="out(this);" onmouseover="popup(this,'th/</replacepat>
</leaf>

searchpat and replacepat tags,

are replacing before and after tags.

leaf tag have new attibutes,

region: values: b (Entire document), c (forword from cursor position), s (Selection), or a (All open files).
matchtype: values: normal, word, posix or perl.
casesens: values: 1 (set) or 0 (unset).
escapechars: values: 1 (set) or 0 (unset).

Shorthand character classes: you can use \w \W \s \S and . but not \d \D (use [0-9] and [^0-9] instead)

My stylesheet to snippets

todo: see in Category:Snippets repository Bluefish css2snippets snippets

@@ Line 15: / Line 15: @@
 * The import file must have a valid XML syntax.
-* The document must include the header: <nowiki><?xml version="1.0"?></nowiki>.
+* The document must include the header: <tt><nowiki><?xml version="1.0"?></nowiki></tt>.
-* The document must be included in the container: <nowiki><snippets> <snippets></nowiki>
+* The document must be included in the container: <tt><nowiki><snippets> <snippets></nowiki></tt>
-* Any snippet must be contained in a branch: <nowiki><branch title="example"> </branch></nowiki>
+* Any snippet must be contained in a branch: <tt><nowiki><branch title="example"> </branch></nowiki></tt>
 * The branches may contain other branches.
-* Each snippet is described in a container: <nowiki><leaf> </leaf></nowiki>
+* Each snippet is described in a container: <tt><nowiki><leaf> </leaf></nowiki></tt>
 == Syntax examples ==
@@ Line 39: / Line 39: @@
 * A leaf tag must have type and title attributes,
 * it also may have a tooltip attribute (line 5 of example).
+** multiline tooltip, Line Feed <tt>&amp;#10;</tt>, Carriage return <tt>&amp;#13;</tt>, Tab <tt>&amp;#9;</tt>
 * 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).
+*<param <span style="color:blue">num="1"</span> name="image"/> The num attribute of param is not used, only the order of params declaration is used, first param for %0 etc.
+* <param name="source" <span style="color:blue">is_file="1"</span>/> If is_file is set, a Browse button is added in dialog.
 === Search and replace snippets ===
@@ Line 51: / Line 55: @@
 ;searchpat and replacepat tags,
-: are replacing before and after.
+: are replacing before and after tags.
 ;leaf tag have new attibutes,:
-:;region :''values'': b (Entire document), c (forword from cursor position), s (Selection), or a (All open files).
+:;region :''values'': <tt>b</tt> (Entire document), <tt>c</tt> (forword from cursor position), <tt>s</tt> (Selection), or <tt>a</tt> (All open files).
-:;matchtype :''values'': normal, word, posix or perl.
+:;matchtype :''values'': <tt>normal</tt>, <tt>word</tt>, <tt>posix</tt> or <tt>perl</tt>.
-:;casesens :''values'':  1 (set) or 0 (unset).
+:;casesens :''values'':  <tt>1</tt> (set) or <tt>0</tt> (unset).
-:;escapechars :''values'':  1 (set) or 0 (unset).
+:;escapechars :''values'':  <tt>1</tt> (set) or <tt>0</tt> (unset).
+;Shorthand character classes:
+:you can use  <tt>\w \W \s \S</tt> and <tt>.</tt> but not <tt>\d \D</tt> (use <tt>[0-9]</tt> and <tt>[^0-9]</tt> instead)
+== My stylesheet to snippets ==
+;todo: see in [[:Category:Snippets repository]] Bluefish css2snippets snippets
 {{Man2bottom