addons/snippets/DESIGN.txt

0001 Snippet plugin for KDevelop4
0002 ============================
0003
0004 => Moved to KatePart to allow other applications to take benefits
0005
0006 (C) Robert Gruber [rgruber A users!sourceforge!net]
0007 (C) Milian Wolff <mail@milianw.de>
0008
0009 *** work in progress ***
0010
0011 1. Basics
0012 Snippets and repositoryies get displayed as tree.
0013
0014 Snippets are grouped into repositories, which are saved as XML files to disk.
0015 The XML format is the same as used in the snippets_tng plugin for Kate.
0016
0017 We look for available repository files via QStandardPaths in share/ktexteditor_snippets/{data,ghns}/.
0018
0019 After importing, the repository and it's snippets and sup-repositories show
0020 up in the snippet tree and the snippets can be inserted like normal code-completion items.
0021
0022 2. Editing
0023 Snipets and repositories can be edited via the contextmenu of the snippet tree.
0024
0025 Changing a repository's name will also rename the file from which the snippet has
0026 been loaded.
0027
0028 3. Contents of a snippet
0029 A snippet can contain any kind of text. A snippet's text will inserted into the
0030 currently active document uppon doubleclicking a snippet from the tree or by
0031 executing it's completion item.
0032
0033 The snippets content's can contain variables, see the documentation of KTextEditor::TemplateInterface
0034 for more information.