1
0
mirror of https://github.com/gryf/snipmate.vim.git synced 2026-02-22 11:15:46 +01:00

updated documentation

This commit is contained in:
Michael Sanders
2009-03-08 21:50:38 -04:00
parent 6c978f274d
commit 562d78749d

View File

@@ -1,7 +1,7 @@
*snipMate.txt* Plugin for using TextMate-style snippets in Vim. *snipMate.txt* Plugin for using TextMate-style snippets in Vim.
snipMate *snippet* *snippets* *snipMate* snipMate *snippet* *snippets* *snipMate*
Last Change: March 2, 2009 Last Change: March 8, 2009
|snipMate-description| Description |snipMate-description| Description
|snipMate-usage| Usage |snipMate-usage| Usage
@@ -39,14 +39,14 @@ be updated.
============================================================================== ==============================================================================
USAGE *snipMate-usage* USAGE *snipMate-usage*
There are two ways to make snippets: file-based and command-based. File-based There are currently two ways to make snippets: file-based and command-based.
snippets are simply *.snippet files named after the trigger of the snippet File-based snippets are simply *.snippet files named after the trigger of
placed in the directory of the filetype (<filetype>/<trigger>.snippet); the snippet placed in the directory of the filetype
command-based snippets are snippets defined using the |Snipp| and |GlobalSnip| (<filetype>/<trigger>.snippet); command-based snippets are snippets defined
commands. File-based snippets have the advantage of being easier to read, but using the |Snipp| and |GlobalSnip| commands. File-based snippets have the
do not support some special characters in snippet triggers, while advantage of being easier to read, but do not support special characters in
command-based snippets are obviously convenient for short snippets but can snippet triggers, while command-based snippets are obviously convenient for
quickly get unreadable. short snippets but can quickly get unreadable.
*command-snippets* *command-snippets*
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@@ -200,7 +200,7 @@ TextMates's functionality, use the |system()| function. E.g.: >
will insert the current date, assuming you are on a Unix system. Note that you will insert the current date, assuming you are on a Unix system. Note that you
can also (and should) use |strftime()| for this example. can also (and should) use |strftime()| for this example.
Filename([{expr}, {defaultText}]) *snipMate-filename* *Filename()* Filename([{expr}] [, {defaultText}]) *snipMate-filename* *Filename()*
Since the current filename is used often in snippets, a default function Since the current filename is used often in snippets, a default function
has been defined for it in snipMate.vim, appropriately called Filename(). has been defined for it in snipMate.vim, appropriately called Filename().