Snippets plugin: Difference between revisions

Revision as of 21:22, 8 January 2010

The snippets plugin allows you to record reusable pieces of code. There are two categories of snippets:

insert strings
search and replace patterns

Snippets are organized in branches. The first time you open Bluefish 2 you have no snippets. You have to create them, or import a set of snippets.

Bluefish 1.3 users

you can copy your old snippets to Bluefish 2
$ cp ~/.bluefish-unstable/snippets ~/.bluefish/

Bluefish 1.0 users

to import your Bluefish 1 Custom menu in snippets you can use Olivier's python script convert_custom_menu_to_snippets.py.

put convert_custom_menu_to_snippets.py in ~/.bluefish/ directory
make the script executable: $ chmod a+x convert_custom_menu_to_snippets.py
run the script: $ ./convert_custom_menu_to_snippets.py > mysnippets.xml
import mysnippets.xml in your snippets plugin.

You also can find useful snippets in Snippets repository

Import snippets

The first time you open Bluefish 2 you have no snippets. You have to create them, or import a set of snippets. Right click in the snippets area open the snippets menu.

click on the arrow of the branch title to expand it.

see Snippets usage to learn how to use snippets.

You can find snippets to import in the Category:Snippets repository

Snippets usage

There are two kinds of snippets, insert snippets and replace snippets.

Insert snippets

Snippets are organized in branches (chapters) and possibly sub-branches. In mediawiki branch there is a sub-branche called man bf where are usefull snippets to edit Bluefish manual. The title of the snippet gives an idea of what it does. By moving the mouse over the title of the snippet appears a tooltip giving details.

By double-clicking a snippet is inserted the code at the cursor position in the edit area.

Snippet can use parameters, double-clicking opens a dialog box.

Here is the result:

Replace snippets

Some snippets make replace in a selected text. Select text before use them!

Export snippets

you can export:
- a branch
- a single snippet
to export your entire snippets file just copy ~/.bluefish/snippets to mysnippets.xml
to export a selection of branches, you have to create a new branch, move wanted snippets into it and export new branch.

Create snippets

Branch

Insert strings

lorem ipsum

Search and replace patterns

Edit snippets

Reorder snippets