Enhanced the help snippets, enhanced the help file a bit

This commit is contained in:
Holger Rapp 2009-07-13 12:28:58 +02:00
parent ab7ad57f77
commit 80c70697c0
2 changed files with 66 additions and 23 deletions

View File

@ -2,6 +2,34 @@
snippet sec snippet sec
============================================================================= =============================================================================
${1:SECTION}`!p res = ("*%s-%s*" % (fn.split('.')[0], t[1].lower())).rjust(77-len(t[1]))` ${1:SECTION}`!p
file_start = fn.split('.')[0]
sec_name = t[1].strip("1234567890. ").lower().replace(' ', '-')
res = ("*%s-%s*" % (file_start, sec_name)).rjust(77-len(t[1]))`
$0
endsnippet
snippet ssec
${1:Subsection}`!p
file_start = fn.split('.')[0]
sec_name = t[1].strip("1234567890. ").lower().replace(' ', '-')
sec_title = ("*%s-%s*" % (file_start, sec_name)).rjust(77-len(t[1]))
res = sec_title + "\n" + "-"*len(t[1])`
$0
endsnippet
snippet sssec
${1:SubSubsection}:`!p
file_start = fn.split('.')[0]
sec_name = t[1].strip("1234567890. ").lower().replace(' ', '-')
sec_title = ("*%s-%s*" % (file_start, sec_name)).rjust(77-len(t[1]))
res = sec_title`
$0
endsnippet endsnippet

View File

@ -2,13 +2,16 @@
UltiSnips *snippet* *snippets* *UltiSnips* UltiSnips *snippet* *snippets* *UltiSnips*
|UltiSnips-description| Description 1. Description |UltiSnips-description|
|UltiSnips-installation| Installation & Deinstallation 2. Installation and Updating |UltiSnips-installnupgrade|
|UltiSnips-syntax| Syntax 2.1 Installation |UltiSnips-installation|
|UltiSnips-settings| Settings 2.2 Deinstallation |UltiSnips-deinstallation|
|UltiSnips-roadmap| Roadmap 2.3 Updating |UltiSnips-updating|
|UltiSnips-helping| Helping out 3. Settings |UltiSnips-settings|
|UltiSnips-contact| Contact 4. Syntax |UltiSnips-syntax|
5. Roadmap |UltiSnips-roadmap|
6. Helping out |UltiSnips-helping|
7. Contact |UltiSnips-contact|
For Vim version 7.0 or later. For Vim version 7.0 or later.
This plugin only works if 'compatible' is not set. This plugin only works if 'compatible' is not set.
@ -19,7 +22,6 @@ This plugin needs Python support compiled into Vim.
============================================================================= =============================================================================
DESCRIPTION *UltiSnips-description* DESCRIPTION *UltiSnips-description*
UltiSnips aims to provide a snippets solution that users came to expect from UltiSnips aims to provide a snippets solution that users came to expect from
editors. A Snippet is a short piece of text which is either typed very often editors. A Snippet is a short piece of text which is either typed very often
or which contains a lot of redundant text. Such snippets are very often or which contains a lot of redundant text. Such snippets are very often
@ -31,7 +33,11 @@ UltiSnips is an implementation that is developed with in the philosophy of TDD
bugs do not reappear after they have been fixed once. bugs do not reappear after they have been fixed once.
============================================================================= =============================================================================
INSTALLATION *UltiSnips-installation* 2. INSTALLATION AND UPDATING *UltiSnips-installnupdate*
2.1 Installation *UltiSnips-installation*
----------------
UltiSnips has only been tested on Mac OS X and Linux. Like TextMates Snippets UltiSnips has only been tested on Mac OS X and Linux. Like TextMates Snippets
it also relies heavily on shell integration, therefore Windows users will have it also relies heavily on shell integration, therefore Windows users will have
@ -44,35 +50,44 @@ yields '1'.
If you have Python, you only need to install UltiSnips. The recommended way to If you have Python, you only need to install UltiSnips. The recommended way to
do so is by using bzr (http://bazaar-vcs.org/). It is in all major linux do so is by using bzr (http://bazaar-vcs.org/). It is in all major linux
distribution (either package bzr or bazaar) and can be easily installed under distribution (either package bzr or bazaar) and can be easily installed under
Mac OS X: Mac OS X: >
$ easy_install bzr $ easy_install bzr
To get UltiSnips, check it out into a directory of your choice. Then add this To get UltiSnips, check it out into a directory of your choice. Then add this
directory to your Vim runtime path: directory to your Vim runtime path: >
$ cd ~/.vim/ $ cd ~/.vim/
$ bzr get lp:ultisnips ultisnips_rep $ bzr get lp:ultisnips ultisnips_rep
$ vim ~/.vimrc $ vim ~/.vimrc
add the line:
add the line: >
set runtimepath+=~/.vim/ultisnips_rep set runtimepath+=~/.vim/ultisnips_rep
Restart vim and UltiSnips should work. Restart vim and UltiSnips should work.
To Update an installation, simply pull the latest revision: 2.2 Deinstallation *UltiSnips-deinstallation*
------------------
To Uninstall UltiSnips, remove the directory you installed it to and remove
the path from your vim runtimepath: >
$ rm -rf ~/.vim/ultisnips_rep
$ vim ~/.vimrc
remove the line: >
set runtimepath+=~/.vim/ultisnips_rep
2.3 Updating *UltiSnips-updating*
------------
To Update an installation, simply pull the latest revision: >
$ cd ~/.vim/ultisnips_rep $ cd ~/.vim/ultisnips_rep
$ bzr pull $ bzr pull
To Uninstall UltiSnips, remove the directory you installed it to and remove
the path from your vim runtimepath:
$ rm -rf ~/.vim/ultisnips_rep
$ vim ~/.vimrc
remove the line:
set runtimepath+=~/.vim/ultisnips_rep
============================================================================= =============================================================================
CONTACT *UltiSnips-contact* 7. CONTACT *UltiSnips-contact*
You can reach me at SirVer -AT- gmx -ADOT- de. You can find the launchpad You can reach me at SirVer -AT- gmx -ADOT- de. You can find the launchpad
project for UltiSnips at https://launchpad.net/ultisnips/, there is also the project for UltiSnips at https://launchpad.net/ultisnips/, there is also the
bug tracker. bug tracker.
vim:ft=help: vim:tw=78:ts=8:ft=help:norl: