File: snippet_editor.md

package info (click to toggle)
frescobaldi 3.0.0~git20161001.0.eec60717%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 19,792 kB
  • ctags: 5,843
  • sloc: python: 37,853; sh: 180; makefile: 69
file content (54 lines) | stat: -rw-r--r-- 1,629 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
=== Snippet Editor ===

Here you can edit the text of the snippet.

If you start the first line(s) with '`-*- `' (note the space),
the remainder of that line(s) defines variables like `name: value;` or
simply `name;` which influence the behaviour of the snippet.

The following variables can be used:

!`menu`
: Place the snippet in the insert menu, grouped by the (optional) value.

!`template`
: Place the snippet in the menu {file_new_from_template}, grouped by the
  (optional) value. When triggered via the menu, the snippet is inserted into a
  new document.

!`name`
: The mnemonic to type to select the snippet.

!`indent: no;`
: Do not auto-indent the snippet after inserting.

!`icon`
: The icon to show in menu and snippet list.

!`symbol`
: The symbol to show in menu and snippet list. Symbols are icons that use the
  default text color and can be found in {directory}.

!`python`
: Execute the snippet as a Python script. See {link}.

!`selection`
: !_(One of more of the following words (separated with spaces or commas):)_
  `yes`: _(Requires text to be selected.)_
  `strip`: _(Adjusts the selection to not include starting and trailing
             whitespace.)_
  `keep`: _(Selects all inserted text.)_

The other lines of the snippet define the text to be inserted in the editor. 
Here, you can insert variables prefixed with a `$`. A double `$` will be 
replaced with a single one. The following variables are recognized:
        
{snippet_editor_expander}

#SUBDOCS
snippet_python

#VARS
directory md `frescobaldi_app/symbols`
link help snippet_python
file_new_from_template menu file -> New from &Template