Difference between revisions of "Snippets syntax"

From Bluefish Wiki
Jump to: navigation, search
m
m
Line 8: Line 8:
 
|next=Man 2 ch08
 
|next=Man 2 ch08
 
}}
 
}}
 
 
 
{{toc}}
 
{{toc}}
 +
The snippets are stored in <tt>~/.bluefish/snippets</tt>.
 +
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: <nowiki><?xml version="1.0"?></nowiki>.
 +
* The document must be included in the container: <nowiki><snippets> <snippets></nowiki>
 +
* Any snippet must be contained in a branch: <nowiki><branch title="example"> </branch></nowiki>
 +
* The branches may contain other branches.
 +
* Each snippet is described in a container: <nowiki><leaf> </leaf></nowiki>
  
== syntax example ==
+
== Syntax examples ==
 +
There are two types of snippets: '''insert''' and '''snr''', aka '''S'''earch '''N''' '''R'''eplace.
 +
=== Insert snippets ===
 
<ol>
 
<ol>
 
# <nowiki><?xml version="1.0"?></nowiki>
 
# <nowiki><?xml version="1.0"?></nowiki>
Line 23: Line 31:
 
# <nowiki></branch></nowiki>
 
# <nowiki></branch></nowiki>
 
# <nowiki></snippets></nowiki>
 
# <nowiki></snippets></nowiki>
 
+
=== Search and replace snippets ===
  
 
</ol>
 
</ol>

Revision as of 18:21, 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"><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>

    Search and replace snippets

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