Snippets

Der Calibre-Editor unterstützt Snippets. Ein Snippet ist ein Text Schnipsel, der entweder häufig verwendet wird, oder aus Blindtext besteht. Der Editor ermöglicht es Ihnen, ein Snippet mit nur wenigen Tastenkombinationen einzufügen. Nehmen wir zum Beispiel an, dass Sie oft Link Tags beim Bearbeiten von HTML Dateien einfügen. Dann können Sie einfach „<a“ in den Editor eingeben und drücken Control+J. Der Editor wird es erweitern zu:

<a href="filename"></a>

Des Weiteren wird das Wort filename ausgewählt und der Cursor darüber plaziert. Auf diese Weise ist es einfach den echten Dateinamen mit Hilfe der nützlichen Automatisches Vervollständigen Funktion einzugeben. Nach dem der Name einmal eingegeben wurde springt der Cursor durch die Control+J Taste zwischen die <a> Tags damit der Text für den Link einfach eingeben werden kann.

Das Snippet System des Editors ist sehr fortschrittlich, es beinhaltet einige vorinstallierte Snippets und es ist möglich eigene Snippets zu erstellen, welche zu dem eigenen Bearbeitungsstil passen.

Die nachfolgende Beschreibung der vorgefertigten Snippets sollten dabei helfen, die Möglichkeiten des Snippet-Systems aufzuzeigen.

Bemerkung

You can also use snippets in the text entry fields in the Search & replace panel, however, placeholders (using Control+J to jump around) will not work.

Die vorgefertigten Snippets

Die vorgefertigten Snippets werden unten beschrieben. Sie können sie überschreiben, indem Sie Ihr eigenes Snippet mit dem gleichen Auslösetext erstellen.

Fülltext einfügen [Lorem]

The first built-in snippet, and the simplest is used to insert filler text into a document. The filler text is taken from De finibus bonorum et malorum a philosophical work by Cicero (translated to English). To use it simply type Lorem in an HTML file and press Control+J. It will be replaced by a couple of paragraphs of filler.

The definition of this snippet is very simple, the trigger text is defined as Lorem and the template is defined simply as the literal text to be inserted. You can easily customize it to use your favorite form of filler text.

Einen selbstschließenden HTML Tag [<>] einfügen

Now let’s look at a simple example of the powerful concept of placeholders. Say you want to insert the self-closing tag <hr/>. Just type <>, and press Control+J, the editor will expand the snippet to:

<|/>

Here, the | symbol represents the current cursor position. You can then type hr and press Control+J to move the cursor to after the end of the tag. This snippet is defined as:

Trigger: <>
Template: <$1/>$2

Placeholders are simply the dollar ($) sign followed by a number. When the snippet is expanded by pressing Control+J the cursor is positioned at the first placeholder (the placeholder with the lowest number). When you press Control+J again the cursor jumps to the next placeholder (the placeholder with the next higher number).

Einen HTML Bild-Tag einfügen [<i]

This is very similar to inserting an HTML link, as we saw above. It allows you to quickly input an <img src="filename" alt="description" /> tag and jump between the src and alt attributes:

Trigger: <i
Template: <img src="${1:filename}" alt="${2*:description}" />$3

Insert an arbitrary HTML tag [<<]

This allows you to insert an arbitrary full HTML tag (or wrap previously selected text in the tag). To use it, simply type << and press Control+J. The editor will expand it to:

<|></>

Type the tag name, for example: span and press Control+J, that will result in:

<span>|</span>

You will note that the closing tag has been automatically filled with span. This is achieved with yet another feature of placeholders, mirroring. Mirroring simply means that if you specify the sample placeholder more than once in a template, the second and all later positions will be automatically filled in with whatever you type in the first position, when you press Control+J. The definition for this snippet is:

Trigger: <<
Template: <$1>${2*}</$1>$3

As you can see, the first placeholder ($1) has been specified twice, the second time in the closing tag, which will simply copy whatever you type in the opening tag.

Inserting an arbitrary HTML tag with a class attribute [<c]

This is very similar to the insert arbitrary tag example above, except that it assumes that you want to specify a class for the tag:

Trigger: <c
Template: <$1 class="${2:classname}">${3*}</$1>$4

This will allow you to first type the tag name, press Control+J, type the class name, press Control+J type the contents of the tag and press Control+J one last time to jump out of the tag. The closing tag will be auto-filled.

Erstellen eigener Snippets

Snippets really shine because you can create your own to suit your editing style. To create your own snippets go to Edit → Preferences → Editor settings → Manage snippets in the editor. This will pop-up an easy to use dialog to help you create your own snippets. Simply click the Add snippet button and you will see a dialog that looks like:

The create your own snippets tool

First give your snippet a name, something descriptive, to help identify the snippet in the future. Then specify the trigger. A trigger is simply the text that you have to type in the editor before pressing Control+J in order to expand the snippet.

Then specify the snippet template. You should start with one of the example above and modify it to suit your needs. Finally, specify which file types you want the snippet to be active for. This way you can have multiple snippets with the same trigger text that work differently in different file types.

The next step is to test your newly created snippet. Use the Test box at the bottom. Type in the trigger text and press Control+J to expand the snippet and jump between placeholders.