mirror of
https://github.com/gryf/.vim.git
synced 2025-12-18 03:50:30 +01:00
Plugins update, PySmell remove, some cosmetic changes in vimrc.
This commit is contained in:
@@ -1,18 +1,20 @@
|
||||
*delimitMate* Trying to keep those beasts at bay! v.2.0 *delimitMate.txt*
|
||||
*delimitMate* Trying to keep those beasts at bay! v2.3.1 *delimitMate.txt*
|
||||
|
||||
|
||||
|
||||
MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
|
||||
MMMM MMMMMMMMM MMMMMMMMMMMMMMMMMMMMMMMMMM MMMMM MMMMMMMMMMMMMMMMMMMMM ~
|
||||
MMMM MMMMMMMMM MMMMMMMMMMMMMMMMMMMMMMMMMM MMM MMMMMMMMMMMMMMMMMMMMM
|
||||
MMMM MMMMMMMMM MMMMMMMMMMMMMMMMMMMMM MMM M M MMMMMMMMMM MMMMMMMMM ~
|
||||
MMMM MMM MMM MM MM M M MMM MM MM MM MM MMM MMM MMM MM
|
||||
MM MM M MM MMMMMM MMMMMMM MMM MMMMM MM M MMM MMM M M ~
|
||||
M M MM MM MM MM M M MM MMM MMM MMMMM MMMMM MMM MMM M
|
||||
M M MM MMMMM MM MM M M MM MMM MMM MMMMM MMM MMM MMM MMMM ~
|
||||
M M MM M MM MM MM M M MM MMM MMM MMMMM MM M MMM MMM M M
|
||||
MM MMM MMM MM MM M M MM MMM MM MMMMM MMM MMM MMM MM ~
|
||||
MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM
|
||||
|
||||
========================================================================= ~
|
||||
==== ========= ========================== ===== ===================== ~
|
||||
==== ========= ========================== === ===================== ~
|
||||
==== ========= ===================== === = = ========== ========= ~
|
||||
==== === === == == = = === == == == == === === === == ~
|
||||
== == = == ====== ======= === ===== == = === === = = ~
|
||||
= = == == == == = = == === === ===== ===== === === = ~
|
||||
= = == ===== == == = = == === === ===== === === === ==== ~
|
||||
= = == = == == == = = == === === ===== == = === === = = ~
|
||||
== === === == == = = == === == ===== === === === == ~
|
||||
========================================================================= ~
|
||||
|
||||
REFERENCE MANUAL *
|
||||
|
||||
==============================================================================
|
||||
0.- CONTENTS *delimitMate-contents*
|
||||
@@ -24,8 +26,10 @@
|
||||
2.3 Backspace__________________________|delimitMateBackspace|
|
||||
2.4 Visual wrapping____________________|delimitMateVisualWrapping|
|
||||
2.5 Smart Quotes_______________________|delimitMateSmartQuotes|
|
||||
2.6 FileType based configuration_______|delimitMateFileType|
|
||||
2.7 Syntax awareness___________________|delimitMateSyntax|
|
||||
3. Customization___________________________|delimitMateOptions|
|
||||
3.1 Option summary_____________________|delimitMateOptionSummary|
|
||||
3.1 Options summary____________________|delimitMateOptionSummary|
|
||||
3.2 Options details____________________|delimitMateOptionDetails|
|
||||
4. Commands________________________________|delimitMateCommands|
|
||||
5. Functions_______________________________|delimitMateFunctions|
|
||||
@@ -37,23 +41,13 @@
|
||||
==============================================================================
|
||||
1.- INTRODUCTION *delimitMateIntro*
|
||||
|
||||
The delimitMate plugin tries to provide some not so dumb help in the work with
|
||||
delimiters (brackets, quotes, etc.), with some optional auto-completions and
|
||||
expansions.
|
||||
This plug-in provides automatic closing of quotes, parenthesis, brackets,
|
||||
etc.; besides some other related features that should make your time in insert
|
||||
mode a little bit easier.
|
||||
|
||||
When automatic closing is enabled, if an opening delimiter is inserted
|
||||
delimitMate inserts the closing pair and places the cursor between them. When
|
||||
automatic closing is disabled, no closing delimiters is inserted by
|
||||
delimitMate, but if a pair of delimiters is typed, the cursor is placed in the
|
||||
middle. Also, to get out of a pair of delimiters just type shift+tab or the
|
||||
right delimiter and the cursor will jump to the right.
|
||||
|
||||
If the cursor is inside an empty pair of delimiters, typing <Space> will
|
||||
insert two spaces and the cursor will be placed in the middle; typing <CR>
|
||||
will insert to car retunrs and place the cursor in the middle line, between
|
||||
the delimiters.
|
||||
|
||||
All of the operations are undo/redo-wise safe.
|
||||
Most of the features can be modified or disabled permanently, using global
|
||||
variables, or on a FileType basis, using autocommands. With a couple of
|
||||
exceptions and limitations, this features don't brake undo, redo or history.
|
||||
|
||||
==============================================================================
|
||||
2. FUNCTIONALITY *delimitMateFunctionality*
|
||||
@@ -118,6 +112,8 @@ Expand <CR> to: >
|
||||
| )
|
||||
<
|
||||
|
||||
NOTE that the expansion of <CR> will brake the redo command.
|
||||
|
||||
Since <Space> and <CR> are used everywhere, I have made the functions involved
|
||||
in expansions global, so they can be used to make custom mappings. Read
|
||||
|delimitMateFunctions| for more details.
|
||||
@@ -125,17 +121,26 @@ in expansions global, so they can be used to make custom mappings. Read
|
||||
------------------------------------------------------------------------------
|
||||
2.3 BACKSPACE *delimitMateBackspace*
|
||||
|
||||
If you press backspace inside an empty pair, both delimiters are deleted. If
|
||||
you type shift + backspace instead, only the closing delimiter will be
|
||||
If you press backspace inside an empty pair, both delimiters are deleted. When
|
||||
expansions are enabled, <BS> will also delete the expansions. NOTE that
|
||||
deleting <CR> expansions will brake the redo command.
|
||||
|
||||
If you type shift + backspace instead, only the closing delimiter will be
|
||||
deleted.
|
||||
|
||||
e.g. typing at the "|": >
|
||||
|
||||
What | Before | After
|
||||
What | Before | After
|
||||
==============================================
|
||||
<BS> | call expand(|) | call expand|
|
||||
---------|------------------|-----------------
|
||||
<S-BS> | call expand(|) | call expand(|
|
||||
<BS> | call expand(|) | call expand|
|
||||
---------|-------------------|-----------------
|
||||
<BS> | call expand( | ) | call expand(|)
|
||||
---------|-------------------|-----------------
|
||||
<BS> | call expand( | call expand(|)
|
||||
| | |
|
||||
| ) |
|
||||
---------|-------------------|-----------------
|
||||
<S-BS> | call expand(|) | call expand(|
|
||||
<
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
@@ -144,8 +149,8 @@ e.g. typing at the "|": >
|
||||
When visual mode is active this script allows for the selection to be enclosed
|
||||
with delimiters. But, since brackets have special meaning in visual mode, a
|
||||
leader (the value of 'mapleader' by default) should precede the delimiter.
|
||||
This feature doesn't currently work on blockwise visual mode, any suggestions
|
||||
will be welcome.
|
||||
NOTE that this feature brakes the redo command and doesn't currently work on
|
||||
blockwise visual mode, any suggestions to fix this will be very welcome.
|
||||
|
||||
e.g. (selection represented between square brackets): >
|
||||
|
||||
@@ -170,6 +175,40 @@ e.g. typing at the "|": >
|
||||
" | let i = "| | let i = "|"
|
||||
' | I| | I'|
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
2.6 FILE TYPE BASED CONFIGURATION *delimitMateFileType*
|
||||
|
||||
delimitMate options can be set globally for all buffers using global
|
||||
("regular") variables in your |vimrc| file. But |:autocmd| can be used to set
|
||||
options for specific file types (see |'filetype'|) using buffer variables in
|
||||
the following way: >
|
||||
|
||||
au FileType mail,text let b:delimitMate_autoclose = 0
|
||||
^ ^ ^ ^ ^
|
||||
| | | | |
|
||||
| | | | - Option value.
|
||||
| | | - Option name.
|
||||
| | - Buffer variable.
|
||||
| - File types for which the option will be set.
|
||||
- Don't forget to put this event.
|
||||
<
|
||||
NOTE that you should use buffer variables (|b:var|) only to set options with
|
||||
|:autocmd|, for global options use regular variables (|g:var|) in your vimrc.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2.7 SYNTAX AWARENESS *delimitMateSyntax*
|
||||
|
||||
The features of this plug-in might not be always helpful, comments and strings
|
||||
usualy don't need auto-completion. delimitMate monitors which region is being
|
||||
edited and if it detects that the cursor is in a comment it'll turn itself off
|
||||
until the cursor leaves the comment. The excluded regions can be set using the
|
||||
option |'delimitMate_excluded_regions'|. Read |group-name| for a list of
|
||||
regions or syntax group names.
|
||||
|
||||
NOTE that this feature relies on a proper syntax file for the current file
|
||||
type, if the appropiate syntax file doesn't define a region, delimitMate won't
|
||||
know about it.
|
||||
|
||||
==============================================================================
|
||||
3. CUSTOMIZATION *delimitMateOptions*
|
||||
|
||||
@@ -202,6 +241,9 @@ specific file types, see |delimitMateOptionDetails| for examples.
|
||||
|
||||
|'delimitMate_excluded_ft'| Turns off the script for the given file types.
|
||||
|
||||
|'delimitMate_excluded_regions'|Turns off the script for the given regions or
|
||||
syntax group names.
|
||||
|
||||
|'delimitMate_apostrophes'| Tells delimitMate how it should "fix"
|
||||
balancing of single quotes when used as
|
||||
apostrophes. NOTE: Not needed any more, kept
|
||||
@@ -213,8 +255,13 @@ specific file types, see |delimitMateOptionDetails| for examples.
|
||||
3.2 OPTIONS DETAILS *delimitMateOptionDetails*
|
||||
|
||||
Add the shown lines to your vimrc file in order to set the below options.
|
||||
Local options take precedence over global ones and can be used along with
|
||||
autocmd to modify delimitMate's behavior for specific file types.
|
||||
Buffer variables take precedence over global ones and can be used along with
|
||||
autocmd to modify delimitMate's behavior for specific file types, read more in
|
||||
|delimitMateFileType|.
|
||||
|
||||
Note: Use buffer variables only to set options for specific file types using
|
||||
:autocmd, use global variables to set options for every buffer. Read more in
|
||||
|g:var| and |b:var|.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*'loaded_delimitMate'*
|
||||
@@ -245,7 +292,7 @@ Default: &matchpairs ~
|
||||
Use this option to tell delimitMate which characters should be considered
|
||||
matching pairs. Read |delimitMateAutoClose| for details.
|
||||
e.g: >
|
||||
let delimitMate = "(:),[:],{:},<:>"
|
||||
let delimitMate_matchpairs = "(:),[:],{:},<:>"
|
||||
au FileType vim,html let b:delimitMate_matchpairs = "(:),[:],{:},<:>"
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
@@ -306,6 +353,16 @@ only if you don't want any of the features it provides on those file types.
|
||||
e.g.: >
|
||||
let delimitMate_excluded_ft = "mail,txt"
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
*'delimitMate_excluded_regions'*
|
||||
Values: A string of syntax group names names separated by single commas. ~
|
||||
Default: Comment ~
|
||||
|
||||
This options turns delimitMate off for the listed regions, read |group-name|
|
||||
for more info about what is a region.
|
||||
e.g.: >
|
||||
let delimitMate_excluded_regions = "Comments,String"
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
*'delimitMate_apostrophes'*
|
||||
Values: Strings separated by ":". ~
|
||||
@@ -331,6 +388,11 @@ e.g.: >
|
||||
Re-sets all the mappings used for this script, use it if any option has been
|
||||
changed or if the filetype option hasn't been set yet.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
:DelimitMateSwitch *:DelimitMateSwitch*
|
||||
|
||||
Switches the plug-in on and off.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
:DelimitMateTest *:DelimitMateTest*
|
||||
|
||||
@@ -405,46 +467,49 @@ represented by an "|": >
|
||||
==============================================================================
|
||||
5. FUNCTIONS *delimitMateFunctions*
|
||||
|
||||
Functions should be used enclosed between <C-R>= and <CR>, otherwise they
|
||||
might not work as expected or at all.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
delimitMate_WithinEmptyPair() *delimitMate_WithinEmptyPair*
|
||||
delimitMate#WithinEmptyPair() *delimitMate_WithinEmptyPair*
|
||||
|
||||
Returns 1 if the cursor is inside an empty pair, 0 otherwise.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
DelimitMate_ExpandReturn() *DelimitMate_ExpandReturn()*
|
||||
delimitMate#ExpandReturn() *delimitMate#ExpandReturn()*
|
||||
|
||||
Returns the expansion for <CR>.
|
||||
Returns the expansion for <CR> if enabled and inside an empty pair, returns
|
||||
<CR> otherwise.
|
||||
|
||||
e.g.: This mapping could be used to select an item on a pop-up menu or expand
|
||||
<CR> inside an empty pair: >
|
||||
|
||||
inoremap <expr> <CR> pumvisible() ? "\<c-y>" :
|
||||
\ DelimitMate_WithinEmptyPair ?
|
||||
\ DelimitMate_ExpandReturn() : "\<CR>"
|
||||
\ "\<C-R>=delimitMate#ExpandReturn()\<CR>"
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
DelimitMate_ExpandSpace() *DelimitMate_ExpandSpace()*
|
||||
delimitMate#ExpandSpace() *delimitMate#ExpandSpace()*
|
||||
|
||||
Returns the expansion for <Space>.
|
||||
Returns the expansion for <Space> if enabled and inside an empty pair, returns
|
||||
<Space> otherwise.
|
||||
e.g.: >
|
||||
|
||||
inoremap <expr> <Space> DelimitMate_WithinEmptyPair() ?
|
||||
\ DelimitMate_ExpandSpace() : "\<Space>"
|
||||
inoremap <Space> <C-R>=delimitMate#ExpandSpace()<CR>
|
||||
<
|
||||
------------------------------------------------------------------------------
|
||||
DelimitMate_ShouldJump() *DelimitMate_ShouldJump()*
|
||||
delimitMate#ShouldJump() *delimitMate#ShouldJump()*
|
||||
|
||||
Returns 1 if there is a closing delimiter or a quote to the right of the
|
||||
cursor, 0 otherwise.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
DelimitMate_JumpAny() *DelimitMate_JumpAny()*
|
||||
delimitMate#JumpAny(key) *delimitMate#JumpAny()*
|
||||
|
||||
This function returns a mapping that will make the cursor jump to the right.
|
||||
This function returns a mapping that will make the cursor jump to the right
|
||||
when delimitMate#ShouldJump() returns 1, returns the argument "key" otherwise.
|
||||
e.g.: You can use this to create your own mapping to jump over any delimiter.
|
||||
>
|
||||
inoremap <expr> <C-Tab> DelimitMate_ShouldJump() ?
|
||||
\ DelimitMate_JumpAny() : "\<C-Tab>"
|
||||
inoremap <C-Tab> <C-R>=delimitMate#JumpAny("\<S-Tab>")<CR>
|
||||
<
|
||||
|
||||
==============================================================================
|
||||
@@ -452,7 +517,6 @@ e.g.: You can use this to create your own mapping to jump over any delimiter.
|
||||
|
||||
- Automatic set-up by file type.
|
||||
- Make visual wrapping work on blockwise visual mode.
|
||||
- Limit behaviour by region.
|
||||
|
||||
==============================================================================
|
||||
7. MAINTAINER *delimitMateMaintainer*
|
||||
@@ -487,7 +551,29 @@ This script was inspired by the auto-completion of delimiters of TextMate.
|
||||
|
||||
Version Date Release notes ~
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
2.0 2010-04-01 * New features:
|
||||
2.3.1 2010-06-06 * Current release:
|
||||
- Fix: an extra <Space> is inserted after <Space>
|
||||
expansion.
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
2.3 2010-06-06 * - Syntax aware: Will turn off when editing comments
|
||||
or other regions, customizable.
|
||||
- Changed format of most mappings.
|
||||
- Fix: <CR> expansion doesn't brake automatic
|
||||
indentation adjustments anymore.
|
||||
- Fix: Arrow keys would insert A, B, C or D instead
|
||||
of moving the cursor when using Vim on a terminal.
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
2.2 2010-05-16 * - Added command to switch the plug-in on and off.
|
||||
- Fix: some problems with <Left>, <Right> and <CR>.
|
||||
- Fix: A small problem when inserting a delimiter at
|
||||
the beginning of the line.
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
2.1 2010-05-10 * - Most of the functions have been moved to an
|
||||
autoload script to avoid loading unnecessary ones.
|
||||
- Fixed a problem with the redo command.
|
||||
- Many small fixes.
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
2.0 2010-04-01 * New features:
|
||||
- All features are redo/undo-wise safe.
|
||||
- A single quote typed after an alphanumeric
|
||||
character is considered an apostrophe and one
|
||||
@@ -506,24 +592,24 @@ This script was inspired by the auto-completion of delimiters of TextMate.
|
||||
- s:vars were being used to store buffer options.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.6 2009-10-10 Now delimitMate tries to fix the balancing of single
|
||||
1.6 2009-10-10 * Now delimitMate tries to fix the balancing of single
|
||||
quotes when used as apostrophes. You can read
|
||||
|delimitMate_apostrophes| for details.
|
||||
Fixed an error when |b:delimitMate_expand_space|
|
||||
wasn't set but |delimitMate_expand_space| wasn't.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.5 2009-10-05 Fix: delimitMate should work correctly for files
|
||||
1.5 2009-10-05 * Fix: delimitMate should work correctly for files
|
||||
passed as arguments to Vim. Thanks to Ben Beuchler
|
||||
for helping to nail this bug.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.4 2009-09-27 Fix: delimitMate is now enabled on new buffers even
|
||||
1.4 2009-09-27 * Fix: delimitMate is now enabled on new buffers even
|
||||
if they don't have set the file type option or were
|
||||
opened directly from the terminal.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.3 2009-09-24 Now local options can be used along with autocmd
|
||||
1.3 2009-09-24 * Now local options can be used along with autocmd
|
||||
for specific file type configurations.
|
||||
Fixes:
|
||||
- Unnamed register content is not lost on visual
|
||||
@@ -532,7 +618,7 @@ This script was inspired by the auto-completion of delimiters of TextMate.
|
||||
- Wrapping a single empty line works as expected.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.2 2009-09-07 Fixes:
|
||||
1.2 2009-09-07 * Fixes:
|
||||
- When inside nested empty pairs, deleting the
|
||||
innermost left delimiter would delete all right
|
||||
contiguous delimiters.
|
||||
@@ -543,19 +629,21 @@ This script was inspired by the auto-completion of delimiters of TextMate.
|
||||
have the mappings set.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.1 2009-08-25 Fixed an error that ocurred when mapleader wasn't
|
||||
1.1 2009-08-25 * Fixed an error that ocurred when mapleader wasn't
|
||||
set and added support for GetLatestScripts
|
||||
auto-detection.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
1.0 2009-08-23 Initial upload.
|
||||
1.0 2009-08-23 * Initial upload.
|
||||
|
||||
|---------|------------|-----------------------------------------------------|
|
||||
|
||||
|
||||
... |"| _ _ . . ___ ~
|
||||
o,*,(o o) _|_|_ o' \,=./ `o . .:::. /_\ `* ~
|
||||
8(o o)(_)Ooo (o o) (o o) :(o o): . (o o) ~
|
||||
---ooO-(_)---Ooo----ooO--(_)--Ooo-ooO--(_)--Ooo-ooO--(_)--Ooo-ooO--(_)--Ooo- ~
|
||||
`\|||/´ MMM \|/ www __^__ ~
|
||||
(o o) (o o) @ @ (O-O) /(o o)\\ ~
|
||||
ooO_(_)_Ooo__ ooO_(_)_Ooo___oOO_(_)_OOo___oOO__(_)__OOo___oOO__(_)__OOo_____ ~
|
||||
_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|____ ~
|
||||
__|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_ ~
|
||||
_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|_____|____ ~
|
||||
|
||||
vim:tw=78:ts=8:ft=help:norl:formatoptions+=tcroqn:autoindent:
|
||||
|
||||
87
doc/tags
87
doc/tags
@@ -17,31 +17,6 @@
|
||||
'NERDTreeStatusline' NERD_tree.txt /*'NERDTreeStatusline'*
|
||||
'NERDTreeWinPos' NERD_tree.txt /*'NERDTreeWinPos'*
|
||||
'NERDTreeWinSize' NERD_tree.txt /*'NERDTreeWinSize'*
|
||||
'Tlist_Auto_Highlight_Tag' taglist.txt /*'Tlist_Auto_Highlight_Tag'*
|
||||
'Tlist_Auto_Open' taglist.txt /*'Tlist_Auto_Open'*
|
||||
'Tlist_Auto_Update' taglist.txt /*'Tlist_Auto_Update'*
|
||||
'Tlist_Close_On_Select' taglist.txt /*'Tlist_Close_On_Select'*
|
||||
'Tlist_Compact_Format' taglist.txt /*'Tlist_Compact_Format'*
|
||||
'Tlist_Ctags_Cmd' taglist.txt /*'Tlist_Ctags_Cmd'*
|
||||
'Tlist_Display_Prototype' taglist.txt /*'Tlist_Display_Prototype'*
|
||||
'Tlist_Display_Tag_Scope' taglist.txt /*'Tlist_Display_Tag_Scope'*
|
||||
'Tlist_Enable_Fold_Column' taglist.txt /*'Tlist_Enable_Fold_Column'*
|
||||
'Tlist_Exit_OnlyWindow' taglist.txt /*'Tlist_Exit_OnlyWindow'*
|
||||
'Tlist_File_Fold_Auto_Close' taglist.txt /*'Tlist_File_Fold_Auto_Close'*
|
||||
'Tlist_GainFocus_On_ToggleOpen' taglist.txt /*'Tlist_GainFocus_On_ToggleOpen'*
|
||||
'Tlist_Highlight_Tag_On_BufEnter' taglist.txt /*'Tlist_Highlight_Tag_On_BufEnter'*
|
||||
'Tlist_Inc_Winwidth' taglist.txt /*'Tlist_Inc_Winwidth'*
|
||||
'Tlist_Max_Submenu_Items' taglist.txt /*'Tlist_Max_Submenu_Items'*
|
||||
'Tlist_Max_Tag_Length' taglist.txt /*'Tlist_Max_Tag_Length'*
|
||||
'Tlist_Process_File_Always' taglist.txt /*'Tlist_Process_File_Always'*
|
||||
'Tlist_Show_Menu' taglist.txt /*'Tlist_Show_Menu'*
|
||||
'Tlist_Show_One_File' taglist.txt /*'Tlist_Show_One_File'*
|
||||
'Tlist_Sort_Type' taglist.txt /*'Tlist_Sort_Type'*
|
||||
'Tlist_Use_Horiz_Window' taglist.txt /*'Tlist_Use_Horiz_Window'*
|
||||
'Tlist_Use_Right_Window' taglist.txt /*'Tlist_Use_Right_Window'*
|
||||
'Tlist_Use_SingleClick' taglist.txt /*'Tlist_Use_SingleClick'*
|
||||
'Tlist_WinHeight' taglist.txt /*'Tlist_WinHeight'*
|
||||
'Tlist_WinWidth' taglist.txt /*'Tlist_WinWidth'*
|
||||
'b:delimitMate_autoclose' delimitMate.txt /*'b:delimitMate_autoclose'*
|
||||
'b:delimitMate_expand_cr' delimitMate.txt /*'b:delimitMate_expand_cr'*
|
||||
'b:delimitMate_expand_space' delimitMate.txt /*'b:delimitMate_expand_space'*
|
||||
@@ -52,6 +27,7 @@
|
||||
'delimitMate_apostrophes' delimitMate.txt /*'delimitMate_apostrophes'*
|
||||
'delimitMate_autoclose' delimitMate.txt /*'delimitMate_autoclose'*
|
||||
'delimitMate_excluded_ft' delimitMate.txt /*'delimitMate_excluded_ft'*
|
||||
'delimitMate_excluded_regions' delimitMate.txt /*'delimitMate_excluded_regions'*
|
||||
'delimitMate_expand_cr' delimitMate.txt /*'delimitMate_expand_cr'*
|
||||
'delimitMate_expand_space' delimitMate.txt /*'delimitMate_expand_space'*
|
||||
'delimitMate_matchpairs' delimitMate.txt /*'delimitMate_matchpairs'*
|
||||
@@ -81,6 +57,7 @@
|
||||
:CVSWatchRemove vcscommand.txt /*:CVSWatchRemove*
|
||||
:CVSWatchers vcscommand.txt /*:CVSWatchers*
|
||||
:DelimitMateReload delimitMate.txt /*:DelimitMateReload*
|
||||
:DelimitMateSwitch delimitMate.txt /*:DelimitMateSwitch*
|
||||
:DelimitMateTest delimitMate.txt /*:DelimitMateTest*
|
||||
:FufAddBookmark fuf.txt /*:FufAddBookmark*
|
||||
:FufAddBookmarkAsSelectedText fuf.txt /*:FufAddBookmarkAsSelectedText*
|
||||
@@ -113,22 +90,6 @@
|
||||
:NERDTreeFromBookmark NERD_tree.txt /*:NERDTreeFromBookmark*
|
||||
:NERDTreeMirror NERD_tree.txt /*:NERDTreeMirror*
|
||||
:NERDTreeToggle NERD_tree.txt /*:NERDTreeToggle*
|
||||
:TlistAddFiles taglist.txt /*:TlistAddFiles*
|
||||
:TlistAddFilesRecursive taglist.txt /*:TlistAddFilesRecursive*
|
||||
:TlistClose taglist.txt /*:TlistClose*
|
||||
:TlistDebug taglist.txt /*:TlistDebug*
|
||||
:TlistHighlightTag taglist.txt /*:TlistHighlightTag*
|
||||
:TlistLock taglist.txt /*:TlistLock*
|
||||
:TlistMessages taglist.txt /*:TlistMessages*
|
||||
:TlistOpen taglist.txt /*:TlistOpen*
|
||||
:TlistSessionLoad taglist.txt /*:TlistSessionLoad*
|
||||
:TlistSessionSave taglist.txt /*:TlistSessionSave*
|
||||
:TlistShowPrototype taglist.txt /*:TlistShowPrototype*
|
||||
:TlistShowTag taglist.txt /*:TlistShowTag*
|
||||
:TlistToggle taglist.txt /*:TlistToggle*
|
||||
:TlistUndebug taglist.txt /*:TlistUndebug*
|
||||
:TlistUnlock taglist.txt /*:TlistUnlock*
|
||||
:TlistUpdate taglist.txt /*:TlistUpdate*
|
||||
:VCSAdd vcscommand.txt /*:VCSAdd*
|
||||
:VCSAnnotate vcscommand.txt /*:VCSAnnotate*
|
||||
:VCSBlame vcscommand.txt /*:VCSBlame*
|
||||
@@ -151,6 +112,7 @@
|
||||
:VimwikiAll2HTML vimwiki.txt /*:VimwikiAll2HTML*
|
||||
:VimwikiDeleteWord vimwiki.txt /*:VimwikiDeleteWord*
|
||||
:VimwikiFollowWord vimwiki.txt /*:VimwikiFollowWord*
|
||||
:VimwikiGenerateLinks vimwiki.txt /*:VimwikiGenerateLinks*
|
||||
:VimwikiGoBackWord vimwiki.txt /*:VimwikiGoBackWord*
|
||||
:VimwikiGoHome vimwiki.txt /*:VimwikiGoHome*
|
||||
:VimwikiMakeDiaryNote vimwiki.txt /*:VimwikiMakeDiaryNote*
|
||||
@@ -162,13 +124,11 @@
|
||||
:VimwikiTabGoHome vimwiki.txt /*:VimwikiTabGoHome*
|
||||
:VimwikiTabMakeDiaryNote vimwiki.txt /*:VimwikiTabMakeDiaryNote*
|
||||
:VimwikiTable vimwiki.txt /*:VimwikiTable*
|
||||
:VimwikiTableMoveColumnLeft vimwiki.txt /*:VimwikiTableMoveColumnLeft*
|
||||
:VimwikiTableMoveColumnRight vimwiki.txt /*:VimwikiTableMoveColumnRight*
|
||||
:VimwikiToggleListItem vimwiki.txt /*:VimwikiToggleListItem*
|
||||
:VimwikiUISelect vimwiki.txt /*:VimwikiUISelect*
|
||||
:VimwikiVSplitWord vimwiki.txt /*:VimwikiVSplitWord*
|
||||
DelimitMate_ExpandReturn() delimitMate.txt /*DelimitMate_ExpandReturn()*
|
||||
DelimitMate_ExpandSpace() delimitMate.txt /*DelimitMate_ExpandSpace()*
|
||||
DelimitMate_JumpAny() delimitMate.txt /*DelimitMate_JumpAny()*
|
||||
DelimitMate_ShouldJump() delimitMate.txt /*DelimitMate_ShouldJump()*
|
||||
ExtractSnips() snipMate.txt /*ExtractSnips()*
|
||||
ExtractSnipsFile() snipMate.txt /*ExtractSnipsFile()*
|
||||
Filename() snipMate.txt /*Filename()*
|
||||
@@ -240,10 +200,6 @@ ShowMarksClearMark showmarks.txt /*ShowMarksClearMark*
|
||||
ShowMarksOn showmarks.txt /*ShowMarksOn*
|
||||
ShowMarksPlaceMark showmarks.txt /*ShowMarksPlaceMark*
|
||||
ShowMarksToggle showmarks.txt /*ShowMarksToggle*
|
||||
Tlist_Get_Tag_Prototype_By_Line() taglist.txt /*Tlist_Get_Tag_Prototype_By_Line()*
|
||||
Tlist_Get_Tagname_By_Line() taglist.txt /*Tlist_Get_Tagname_By_Line()*
|
||||
Tlist_Set_App() taglist.txt /*Tlist_Set_App()*
|
||||
Tlist_Update_File_Tags() taglist.txt /*Tlist_Update_File_Tags()*
|
||||
VCSCommandCVSDiffOpt vcscommand.txt /*VCSCommandCVSDiffOpt*
|
||||
VCSCommandCVSExec vcscommand.txt /*VCSCommandCVSExec*
|
||||
VCSCommandCommitOnWrite vcscommand.txt /*VCSCommandCommitOnWrite*
|
||||
@@ -272,6 +228,10 @@ b:VCSCommandSourceFile vcscommand.txt /*b:VCSCommandSourceFile*
|
||||
b:VCSCommandVCSType vcscommand.txt /*b:VCSCommandVCSType*
|
||||
cvscommand-changes vcscommand.txt /*cvscommand-changes*
|
||||
delimitMate delimitMate.txt /*delimitMate*
|
||||
delimitMate#ExpandReturn() delimitMate.txt /*delimitMate#ExpandReturn()*
|
||||
delimitMate#ExpandSpace() delimitMate.txt /*delimitMate#ExpandSpace()*
|
||||
delimitMate#JumpAny() delimitMate.txt /*delimitMate#JumpAny()*
|
||||
delimitMate#ShouldJump() delimitMate.txt /*delimitMate#ShouldJump()*
|
||||
delimitMate-contents delimitMate.txt /*delimitMate-contents*
|
||||
delimitMate.txt delimitMate.txt /*delimitMate.txt*
|
||||
delimitMateAutoClose delimitMate.txt /*delimitMateAutoClose*
|
||||
@@ -279,6 +239,7 @@ delimitMateBackspace delimitMate.txt /*delimitMateBackspace*
|
||||
delimitMateCommands delimitMate.txt /*delimitMateCommands*
|
||||
delimitMateCredits delimitMate.txt /*delimitMateCredits*
|
||||
delimitMateExpansion delimitMate.txt /*delimitMateExpansion*
|
||||
delimitMateFileType delimitMate.txt /*delimitMateFileType*
|
||||
delimitMateFunctionality delimitMate.txt /*delimitMateFunctionality*
|
||||
delimitMateFunctions delimitMate.txt /*delimitMateFunctions*
|
||||
delimitMateHistory delimitMate.txt /*delimitMateHistory*
|
||||
@@ -288,6 +249,7 @@ delimitMateOptionDetails delimitMate.txt /*delimitMateOptionDetails*
|
||||
delimitMateOptionSummary delimitMate.txt /*delimitMateOptionSummary*
|
||||
delimitMateOptions delimitMate.txt /*delimitMateOptions*
|
||||
delimitMateSmartQuotes delimitMate.txt /*delimitMateSmartQuotes*
|
||||
delimitMateSyntax delimitMate.txt /*delimitMateSyntax*
|
||||
delimitMateTodo delimitMate.txt /*delimitMateTodo*
|
||||
delimitMateVisualWrapping delimitMate.txt /*delimitMateVisualWrapping*
|
||||
delimitMate_WithinEmptyPair delimitMate.txt /*delimitMate_WithinEmptyPair*
|
||||
@@ -414,16 +376,20 @@ g:fuf_timeFormat fuf.txt /*g:fuf_timeFormat*
|
||||
g:fuf_useMigemo fuf.txt /*g:fuf_useMigemo*
|
||||
g:snippets_dir snipMate.txt /*g:snippets_dir*
|
||||
g:snips_author snipMate.txt /*g:snips_author*
|
||||
g:vimwiki_CJK_length vimwiki.txt /*g:vimwiki_CJK_length*
|
||||
g:vimwiki_auto_checkbox vimwiki.txt /*g:vimwiki_auto_checkbox*
|
||||
g:vimwiki_badsyms vimwiki.txt /*g:vimwiki_badsyms*
|
||||
g:vimwiki_browsers vimwiki.txt /*g:vimwiki_browsers*
|
||||
g:vimwiki_camel_case vimwiki.txt /*g:vimwiki_camel_case*
|
||||
g:vimwiki_dir_link vimwiki.txt /*g:vimwiki_dir_link*
|
||||
g:vimwiki_fold_lists vimwiki.txt /*g:vimwiki_fold_lists*
|
||||
g:vimwiki_fold_trailing_empty_lines vimwiki.txt /*g:vimwiki_fold_trailing_empty_lines*
|
||||
g:vimwiki_folding vimwiki.txt /*g:vimwiki_folding*
|
||||
g:vimwiki_global_ext vimwiki.txt /*g:vimwiki_global_ext*
|
||||
g:vimwiki_hl_cb_checked vimwiki.txt /*g:vimwiki_hl_cb_checked*
|
||||
g:vimwiki_hl_headers vimwiki.txt /*g:vimwiki_hl_headers*
|
||||
g:vimwiki_html_header_numbering vimwiki.txt /*g:vimwiki_html_header_numbering*
|
||||
g:vimwiki_html_header_numbering_sym vimwiki.txt /*g:vimwiki_html_header_numbering_sym*
|
||||
g:vimwiki_list vimwiki.txt /*g:vimwiki_list*
|
||||
g:vimwiki_list_ignore_newline vimwiki.txt /*g:vimwiki_list_ignore_newline*
|
||||
g:vimwiki_listsyms vimwiki.txt /*g:vimwiki_listsyms*
|
||||
@@ -513,23 +479,6 @@ snipMate.txt snipMate.txt /*snipMate.txt*
|
||||
snippet snipMate.txt /*snippet*
|
||||
snippet-syntax snipMate.txt /*snippet-syntax*
|
||||
snippets snipMate.txt /*snippets*
|
||||
taglist-commands taglist.txt /*taglist-commands*
|
||||
taglist-debug taglist.txt /*taglist-debug*
|
||||
taglist-extend taglist.txt /*taglist-extend*
|
||||
taglist-faq taglist.txt /*taglist-faq*
|
||||
taglist-functions taglist.txt /*taglist-functions*
|
||||
taglist-install taglist.txt /*taglist-install*
|
||||
taglist-internet taglist.txt /*taglist-internet*
|
||||
taglist-intro taglist.txt /*taglist-intro*
|
||||
taglist-keys taglist.txt /*taglist-keys*
|
||||
taglist-license taglist.txt /*taglist-license*
|
||||
taglist-menu taglist.txt /*taglist-menu*
|
||||
taglist-options taglist.txt /*taglist-options*
|
||||
taglist-requirements taglist.txt /*taglist-requirements*
|
||||
taglist-session taglist.txt /*taglist-session*
|
||||
taglist-todo taglist.txt /*taglist-todo*
|
||||
taglist-using taglist.txt /*taglist-using*
|
||||
taglist.txt taglist.txt /*taglist.txt*
|
||||
vcscommand vcscommand.txt /*vcscommand*
|
||||
vcscommand-buffer-management vcscommand.txt /*vcscommand-buffer-management*
|
||||
vcscommand-buffer-variables vcscommand.txt /*vcscommand-buffer-variables*
|
||||
@@ -554,11 +503,11 @@ vcscommand-ssh-wrapper vcscommand.txt /*vcscommand-ssh-wrapper*
|
||||
vcscommand-statusline vcscommand.txt /*vcscommand-statusline*
|
||||
vcscommand.txt vcscommand.txt /*vcscommand.txt*
|
||||
vimwiki vimwiki.txt /*vimwiki*
|
||||
vimwiki-author vimwiki.txt /*vimwiki-author*
|
||||
vimwiki-calendar vimwiki.txt /*vimwiki-calendar*
|
||||
vimwiki-changelog vimwiki.txt /*vimwiki-changelog*
|
||||
vimwiki-commands vimwiki.txt /*vimwiki-commands*
|
||||
vimwiki-contents vimwiki.txt /*vimwiki-contents*
|
||||
vimwiki-developers vimwiki.txt /*vimwiki-developers*
|
||||
vimwiki-diary vimwiki.txt /*vimwiki-diary*
|
||||
vimwiki-folding vimwiki.txt /*vimwiki-folding*
|
||||
vimwiki-global-commands vimwiki.txt /*vimwiki-global-commands*
|
||||
@@ -569,6 +518,7 @@ vimwiki-local-commands vimwiki.txt /*vimwiki-local-commands*
|
||||
vimwiki-local-mappings vimwiki.txt /*vimwiki-local-mappings*
|
||||
vimwiki-mappings vimwiki.txt /*vimwiki-mappings*
|
||||
vimwiki-multiple-wikies vimwiki.txt /*vimwiki-multiple-wikies*
|
||||
vimwiki-nohtml vimwiki.txt /*vimwiki-nohtml*
|
||||
vimwiki-option-auto_export vimwiki.txt /*vimwiki-option-auto_export*
|
||||
vimwiki-option-css_name vimwiki.txt /*vimwiki-option-css_name*
|
||||
vimwiki-option-diary_header vimwiki.txt /*vimwiki-option-diary_header*
|
||||
@@ -607,6 +557,8 @@ vimwiki-toc vimwiki.txt /*vimwiki-toc*
|
||||
vimwiki-todo-lists vimwiki.txt /*vimwiki-todo-lists*
|
||||
vimwiki.txt vimwiki.txt /*vimwiki.txt*
|
||||
vimwiki_- vimwiki.txt /*vimwiki_-*
|
||||
vimwiki_<A-Left> vimwiki.txt /*vimwiki_<A-Left>*
|
||||
vimwiki_<A-Right> vimwiki.txt /*vimwiki_<A-Right>*
|
||||
vimwiki_<Backspace> vimwiki.txt /*vimwiki_<Backspace>*
|
||||
vimwiki_<C-CR> vimwiki.txt /*vimwiki_<C-CR>*
|
||||
vimwiki_<C-Space> vimwiki.txt /*vimwiki_<C-Space>*
|
||||
@@ -620,6 +572,7 @@ vimwiki_= vimwiki.txt /*vimwiki_=*
|
||||
vimwiki_gqq vimwiki.txt /*vimwiki_gqq*
|
||||
vimwiki_gww vimwiki.txt /*vimwiki_gww*
|
||||
vimwiki_i_<CR> vimwiki.txt /*vimwiki_i_<CR>*
|
||||
vimwiki_i_<S-CR> vimwiki.txt /*vimwiki_i_<S-CR>*
|
||||
vimwiki_i_<Tab> vimwiki.txt /*vimwiki_i_<Tab>*
|
||||
viwmiki-global-options vimwiki.txt /*viwmiki-global-options*
|
||||
viwmiki-local-options vimwiki.txt /*viwmiki-local-options*
|
||||
|
||||
300
doc/vimwiki.txt
300
doc/vimwiki.txt
@@ -1,14 +1,15 @@
|
||||
*vimwiki.txt* A Personal Wiki for Vim
|
||||
|
||||
__ __ ______ __ __ ______ __ __ ______ ~
|
||||
/\ \/\ \/\__ _\ /'\_/`\/\ \ __/\ \/\__ _\ /\ \/\ \ /\__ _\ ~
|
||||
\ \ \ \ \/_/\ \/ /\ \ \ \/\ \ \ \/_/\ \/ \ \ \/'/'\/_/\ \/ ~
|
||||
\ \ \ \ \ \ \ \ \ \ \__\ \ \ \ \ \ \ \ \ \ \ \ \ , < \ \ \ ~
|
||||
\ \ \_/ \ \_\ \__\ \ \_/\ \ \ \_/ \_\ \ \_\ \__\ \ \\`\ \_\ \__ ~
|
||||
\ `\___/ /\_____\\ \_\\ \_\ `\___x___/ /\_____\\ \_\ \_\ /\_____\~
|
||||
`\/__/ \/_____/ \/_/ \/_/'\/__//__/ \/_____/ \/_/\/_/ \/_____/~
|
||||
__ __ ___ __ __ _ _ ___ ___ _ ___ ~
|
||||
| | | || | | |_| || | _ | || | | | | || | ~
|
||||
| |_| || | | || || || || | | |_| || | ~
|
||||
| || | | || || | | _|| | ~
|
||||
| || | | || || | | |_ | | ~
|
||||
| | | | | ||_|| || _ || | | _ || | ~
|
||||
|___| |___| |_| |_||__| |__||___| |___| |_||___| ~
|
||||
|
||||
Version: 0.9.9
|
||||
|
||||
Version: 1.0
|
||||
|
||||
==============================================================================
|
||||
CONTENTS *vimwiki-contents*
|
||||
@@ -34,13 +35,12 @@ CONTENTS *vimwiki-contents*
|
||||
5.9. Comments |vimwiki-syntax-comments|
|
||||
6. Folding/Outline |vimwiki-folding|
|
||||
7. Placeholders |vimwiki-placeholders|
|
||||
7.1 Table of Contents |vimwiki-table-of-contents|
|
||||
8. Todo lists |vimwiki-todo-lists|
|
||||
9. Tables |vimwiki-tables|
|
||||
10. Diary |vimwiki-diary|
|
||||
11. Options |vimwiki-options|
|
||||
12. Help |vimwiki-help|
|
||||
13. Author |vimwiki-author|
|
||||
13. Developers |vimwiki-developers|
|
||||
14. Changelog |vimwiki-changelog|
|
||||
15. License |vimwiki-license|
|
||||
|
||||
@@ -242,6 +242,13 @@ gqq Format table. If you did some changes to a table
|
||||
or without swapping insert/normal modes this command
|
||||
gww reformat it.
|
||||
|
||||
*vimwiki_<A-Left>*
|
||||
<A-Left> Move current table column to the left.
|
||||
See |:VimwikiTableMoveColumnLeft|
|
||||
|
||||
*vimwiki_<A-Right>*
|
||||
<A-Right> Move current table column to the right.
|
||||
See |:VimwikiTableMoveColumnRight|
|
||||
|
||||
|
||||
|
||||
@@ -267,6 +274,8 @@ INSERT MODE *vimwiki-table-mappings*
|
||||
<Tab> Goto next table cell, create new row if on the last
|
||||
cell.
|
||||
|
||||
*vimwiki_i_<S-CR>*
|
||||
<S-CR> Insert <br /> and a newline.
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
@@ -278,6 +287,10 @@ ih Inner Header without leading empty lines.
|
||||
You can 'vah' to select a header with its contents or 'dah' to delete it or
|
||||
'yah' to yank it or 'cah' to change it.
|
||||
|
||||
a\ A cell in a table.
|
||||
i\ Inner cell in a table.
|
||||
ac A column in a table.
|
||||
ic Inner column in a table.
|
||||
|
||||
==============================================================================
|
||||
4. Commands *vimwiki-commands*
|
||||
@@ -362,6 +375,37 @@ You can 'vah' to select a header with its contents or 'dah' to delete it or
|
||||
:VimwikiTable cols
|
||||
Create a table with a given cols and 2 rows
|
||||
|
||||
*:VimwikiTableMoveColumnLeft* , *:VimwikiTableMoveColumnRight*
|
||||
Move current column to the left or to the right:
|
||||
Example: >
|
||||
|
||||
| head1 | head2 | head3 | head4 | head5 |
|
||||
|--------+--------+--------+--------+--------|
|
||||
| value1 | value2 | value3 | value4 | value5 |
|
||||
|
||||
|
||||
Cursor is on 'head1'.
|
||||
:VimwikiTableMoveColumnRight
|
||||
|
||||
| head2 | head1 | head3 | head4 | head5 |
|
||||
|--------+--------+--------+--------+--------|
|
||||
| value2 | value1 | value3 | value4 | value5 |
|
||||
|
||||
Cursor is on 'head3'.
|
||||
:VimwikiTableMoveColumnLeft
|
||||
|
||||
| head2 | head3 | head1 | head4 | head5 |
|
||||
|--------+--------+--------+--------+--------|
|
||||
| value2 | value3 | value1 | value4 | value5 |
|
||||
<
|
||||
|
||||
Commands are mapped to <A-Left> and <A-Right> respectively.
|
||||
|
||||
|
||||
*:VimwikiGenerateLinks*
|
||||
Insert all available links into current buffer.
|
||||
|
||||
|
||||
|
||||
==============================================================================
|
||||
5. Wiki syntax *vimwiki-syntax*
|
||||
@@ -370,13 +414,8 @@ There are a lot of different wikies out there. Most of them have their own
|
||||
syntax and vimwiki is not an exception here. Default vimwiki's syntax is a
|
||||
subset of google's wiki syntax markup.
|
||||
|
||||
As for MediaWiki's syntax -- it is not that convenient for non English
|
||||
(Russian in my case :)) keyboard layouts to emphasize text as it uses a lot
|
||||
of '''''' to do it. You have to switch layouts every time you want some bold
|
||||
non English text. This is the answer to "Why not MediaWiki?"
|
||||
|
||||
Nevertheless, there is MediaWiki syntax file included in the distribution (it
|
||||
doesn't have all the fancy stuff original MediaWiki syntax has though).
|
||||
There is MediaWiki syntax file included in the distribution (it doesn't have
|
||||
all the fancy stuff original MediaWiki syntax has though).
|
||||
See |vimwiki-option-syntax|.
|
||||
|
||||
|
||||
@@ -500,18 +539,6 @@ You can center your headers in html by placing spaces before the first '=':
|
||||
|
||||
|
||||
|
||||
Note: before vimwiki 0.8.2, header's markup syntax used exclamation marks:
|
||||
! Header level 1
|
||||
!! Header level 2
|
||||
etc...
|
||||
|
||||
If you upgrade from pre 0.8.2 you might find the next commands useful.
|
||||
To change headers from !Header to =Header= in your wiki files do: >
|
||||
:args .wiki
|
||||
:argdo %s/^\(!\+\)\([^!].*$\)/\=substitute(submatch(1),'!','=','g').submatch(2).substitute(submatch(1),'!','=','g')
|
||||
|
||||
Note: BACKUP FIRST!
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
5.4. Paragraphs *vimwiki-syntax-paragraphs*
|
||||
|
||||
@@ -619,6 +646,7 @@ In html the following part >
|
||||
>
|
||||
is higlighted as a table header.
|
||||
|
||||
If you indent table then it would be centered in html.
|
||||
|
||||
See |vimwiki-tables| for more details on how to manage tables.
|
||||
|
||||
@@ -723,7 +751,7 @@ To turn folding on/off check |g:vimwiki_folding|.
|
||||
7. Placeholders *vimwiki-placeholders*
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
7.1. Table of Contents *vimwiki-toc* *vimwiki-table-of-contents*
|
||||
%toc Table of Contents *vimwiki-toc* *vimwiki-table-of-contents*
|
||||
|
||||
You can add 'table of contents' to your html page generated from wiki one.
|
||||
Just place >
|
||||
@@ -740,6 +768,16 @@ or >
|
||||
%toc Whatever
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
%nohtml *vimwiki-nohtml*
|
||||
|
||||
If you do not want a wiki page to be converted to html, place:
|
||||
|
||||
%nohtml
|
||||
|
||||
into it.
|
||||
|
||||
|
||||
==============================================================================
|
||||
8. Todo lists *vimwiki-todo-lists*
|
||||
|
||||
@@ -825,6 +863,8 @@ values: >
|
||||
| James | Esfandiary | 27 | Istanbul | esfandiary@tmail.com |
|
||||
<
|
||||
|
||||
To indent table indent the first row. Then format it with 'gqq'.
|
||||
|
||||
|
||||
|
||||
==============================================================================
|
||||
@@ -870,6 +910,8 @@ be created in default wiki's diary.
|
||||
|
||||
Get it from http://www.vim.org/scripts/script.php?script_id=52
|
||||
|
||||
See |g:vimwiki_use_calendar| option to turn it off/on.
|
||||
|
||||
|
||||
|
||||
==============================================================================
|
||||
@@ -907,6 +949,20 @@ Empty |Dictionary| in the g:vimwiki_list is the wiki with default options: >
|
||||
|
||||
<
|
||||
|
||||
You can also create wikis as a separate |Dictionary|s. >
|
||||
|
||||
let wiki_1 = {}
|
||||
let wiki_1.path = '~/my_docs/'
|
||||
let wiki_1.html_header = '~/public_html/header.tpl'
|
||||
let wiki_1.nested_syntaxes = {'python': 'python', 'c++': 'cpp'}
|
||||
|
||||
let wiki_2 = {}
|
||||
let wiki_2.path = '~/project_docs/'
|
||||
let wiki_2.index = 'main'
|
||||
|
||||
let g:vimwiki_list = [wiki_1, wiki_2]
|
||||
|
||||
<
|
||||
|
||||
PER WIKI OPTIONS *viwmiki-local-options*
|
||||
|
||||
@@ -1079,11 +1135,11 @@ nested_syntaxes {} pairs of highlight keyword and vim filetype
|
||||
Description~
|
||||
You can make preformatted text to be highlighted with a different syntaxes
|
||||
available for vim.
|
||||
For example the following setup: >
|
||||
For example the following setup in your vimrc: >
|
||||
let wiki = {}
|
||||
let wiki.path = '~/my_site/'
|
||||
let wiki.path = '~/my_wiki/'
|
||||
let wiki.nested_syntaxes = {'python': 'python', 'c++': 'cpp'}
|
||||
let vimwiki_list = [wiki]
|
||||
let g:vimwiki_list = [wiki]
|
||||
|
||||
would give you python and c++ highlighting in: >
|
||||
{{{class="brush: python"
|
||||
@@ -1152,8 +1208,8 @@ Description~
|
||||
Number of maximum dated links placed on one line.
|
||||
Ex:
|
||||
= Diary =
|
||||
|| [[2010-01-30]] || [[2010-01-29]] || [[2010-01-28]] || [[2010-01-27]] ||
|
||||
|| [[2010-01-26]] || [[2010-01-25]] ||
|
||||
| [[2010-01-30]] | [[2010-01-29]] | [[2010-01-28]] | [[2010-01-27]] |
|
||||
| [[2010-01-26]] | [[2010-01-25]] |
|
||||
|
||||
|
||||
|
||||
@@ -1399,7 +1455,7 @@ Default: 1
|
||||
Convert directory name from current |encoding| into 'g:vimwiki_w32_dir_enc'
|
||||
before it is created.
|
||||
|
||||
If have 'enc=utf-8' and you set up >
|
||||
If you have 'enc=utf-8' and set up >
|
||||
let g:vimwiki_w32_dir_enc = 'cp1251'
|
||||
<
|
||||
then following the next link with <CR>: >
|
||||
@@ -1407,40 +1463,184 @@ then following the next link with <CR>: >
|
||||
>
|
||||
would convert utf-8 'привет' to cp1251 and create directory with that name.
|
||||
|
||||
Default value: ''
|
||||
Default: ''
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*g:vimwiki_CJK_length*
|
||||
|
||||
Use special method to calculate correct length of the strings with double wide
|
||||
characters. (To align table cells properly)
|
||||
|
||||
Value Description~
|
||||
0 Do not use it.
|
||||
1 Use it.
|
||||
|
||||
Default: 0
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*g:vimwiki_dir_link*
|
||||
|
||||
This option is about what to do with links to directories -- [[directory/]],
|
||||
[[papers/]], etc.
|
||||
|
||||
Value Description~
|
||||
'' Open 'directory/' using standard netrw plugin.
|
||||
'index' Open 'directory/index.wiki', create if needed.
|
||||
'main' Open 'directory/main.wiki', create if needed.
|
||||
etc.
|
||||
|
||||
Default: '' (empty string)
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*g:vimwiki_html_header_numbering*
|
||||
|
||||
Set this option if you want headers to be auto numbered in html.
|
||||
|
||||
ex: >
|
||||
1 Header1
|
||||
1.1 Header2
|
||||
1.2 Header2
|
||||
1.2.1 Header3
|
||||
1.2.2 Header3
|
||||
1.3 Header2
|
||||
2 Header1
|
||||
3 Header1
|
||||
etc.
|
||||
|
||||
Value Description~
|
||||
0 Header numbering is off.
|
||||
1 Header numbering is on. Headers are numbered starting from
|
||||
header level 1.
|
||||
2 Header numbering is on. Headers are numbered starting from
|
||||
header level 2.
|
||||
etc.
|
||||
Example when g:vimwiki_html_header_numbering = 2: >
|
||||
Header1
|
||||
1 Header2
|
||||
2 Header2
|
||||
2.1 Header3
|
||||
2.1.1 Header4
|
||||
2.1.2 Header4
|
||||
2.2 Header3
|
||||
3 Header2
|
||||
4 Header2
|
||||
etc.
|
||||
|
||||
Default: 0
|
||||
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*g:vimwiki_html_header_numbering_sym*
|
||||
|
||||
Ending symbol for |g:vimwiki_html_header_numbering|.
|
||||
|
||||
Value Description~
|
||||
'.' Dot would be added to the end of header's number.
|
||||
')' Closing bracket would be added to the end of header's number.
|
||||
etc.
|
||||
|
||||
With
|
||||
let g:vimwiki_html_header_numbering = '.'
|
||||
headers would look like: >
|
||||
1. Header1
|
||||
1.1. Header2
|
||||
1.2. Header2
|
||||
1.2.1. Header3
|
||||
1.2.2. Header3
|
||||
1.3. Header2
|
||||
2. Header1
|
||||
3. Header1
|
||||
|
||||
|
||||
Default: '' (empty)
|
||||
|
||||
|
||||
==============================================================================
|
||||
12. Help *vimwiki-help*
|
||||
|
||||
As you could see I am not native English speaker (not a writer as well).
|
||||
Please send me correct phrases instead of that incorrect stuff I have used
|
||||
here.
|
||||
Your help in making vimwiki better is really appreciated!
|
||||
Any help. Would it be spell correction or code snippet to patch -- everything
|
||||
is welcomed.
|
||||
|
||||
Issues could be filled in at http://code.google.com/p/vimwiki/issues .
|
||||
|
||||
Any help is really appreciated!
|
||||
|
||||
==============================================================================
|
||||
13. Author *vimwiki-author*
|
||||
13. Developers *vimwiki-developers*
|
||||
|
||||
I live in Moscow and you may believe me -- there are no polar bears (no brown
|
||||
too) here in the streets.
|
||||
- Maxim Kim <habamax@gmail.com>
|
||||
Original author.
|
||||
- Mikhail Trishchenkov <kriomant(at)gmail.com>
|
||||
Joined in at Dec 2009.
|
||||
|
||||
I do not do programming for a living. So don't blame me for an ugly
|
||||
ineffective code. Improvements are welcome.
|
||||
Vimwiki's website: http://code.google.com/p/vimwiki/
|
||||
Vim plugins website: http://www.vim.org/scripts/script.php?script_id=2226
|
||||
|
||||
... afterword
|
||||
|
||||
Many thanks to all of you for voting vimwiki up on www.vim.org. I do vimwiki
|
||||
in my spare time I could use to dance argentine tango with beautiful women.
|
||||
Your votes are kind of a good replacement. ;)
|
||||
|
||||
Sincerely yours,
|
||||
Maxim Kim <habamax@gmail.com>.
|
||||
Maxim Kim.
|
||||
|
||||
Vimwiki's website: http://code.google.com/p/vimwiki/
|
||||
Vim plugins website: http://www.vim.org/scripts/script.php?script_id=2226
|
||||
|
||||
==============================================================================
|
||||
14. Changelog *vimwiki-changelog*
|
||||
|
||||
1.0~
|
||||
* NEW: Issue 41: Table cell and column text objects. See
|
||||
|vimwiki-text-objects|.
|
||||
* NEW: Issue 42: Commands to move table columns left and right. See
|
||||
|:VimwikiTableMoveColumnLeft| and |:VimwikiTableMoveColumnRight|.
|
||||
* NEW: Issue 44: <S-Tab> should move cursor to the previous table cell.
|
||||
* NEW: Issue 45: It should be possible to indent tables. Indented tables
|
||||
are centered in html.
|
||||
* NEW: Issue 46: Do not htmlize some wiki pages (blacklist). New
|
||||
placeholder is added: %nohtml. See |vimwiki-nohtml|.
|
||||
* FIX: Issue 47: Lists aren't HTMLized properly.
|
||||
* FIX: Issue 48: With autochdir it is impossible to have path_html such as
|
||||
'd:\vimwiki\html\'
|
||||
* FIX: Issue 49: Table is not HTMLized properly at the end of wiki page.
|
||||
* FIX: Issue 50: Inline formatting is not performed in table cells.
|
||||
* FIX: Issue 51: Cannot insert '-' (minus) into table cells of the first
|
||||
column.
|
||||
* FIX: Issue 52: Table cell width is incorrect when double wide characters
|
||||
are used (ie. Chinese). Check |g:vimwiki_CJK_length|.
|
||||
* NEW: Issue 53: Wiki markup can not nested. (Use links and inline markup
|
||||
in Headers).
|
||||
* NEW: Issue 54: Highlight for placeholders.
|
||||
* NEW: Issue 56: Directory indexes. See |g:vimwiki_dir_link| option and
|
||||
|:VimwikiGenerateLinks| command.
|
||||
* NEW: Issue 58: Html new lines with <br />. Could be inserted with <S-CR>
|
||||
in insert mode.
|
||||
* FIX: Issue 59: List item's text can't be started from *.
|
||||
* NEW: Issue 60: Links inside completed gtd-items.
|
||||
* NEW: Issue 61: Headers numbering. See |g:vimwiki_html_header_numbering|
|
||||
and |g:vimwiki_html_header_numbering_sym| options.
|
||||
* FIX: Issue 63: Table cannot have leading empty cells in html.
|
||||
* FIX: Issue 65: Table separator is not htmlized right if on top of the
|
||||
table.
|
||||
* FIX: Issue 66: Table empty cells are very small in html.
|
||||
* FIX: Issue 67: Wrong html conversion of multilined list item with bold
|
||||
text on the start of next line.
|
||||
* FIX: Issue 68: auto-indent problem with langmap.
|
||||
* FIX: Issue 73: Link navigation by Tab. "Escaped" wiki-word should be
|
||||
skipped for navigation with <tab>.
|
||||
* FIX: Issue 75: `code` syntax doesn't display correctly in toc.
|
||||
* FIX: Issue 77: Diary index only showing link to today's diary entry
|
||||
file for extensions other than '.wiki'.
|
||||
* FIX: Issue 79: Further calendar.vim integration -- add sign to calendar
|
||||
date if it has corresponding diary page.
|
||||
* FIX: Issue 80: Debian Lenny GUI Vim 7.2 has problems with toggling inner
|
||||
todo list items.
|
||||
* FIX: Issue 81: Don't convert WikiWord as a link in html when
|
||||
`let g:vimwiki_camel_case = 0`
|
||||
|
||||
0.9.9~
|
||||
* NEW: Diary. Help in making daily notes. See |vimwiki-diary|. Now you can
|
||||
really easy add information into vimwiki that should be sorted out
|
||||
@@ -1819,7 +2019,7 @@ Vim plugins website: http://www.vim.org/scripts/script.php?script_id=2226
|
||||
The MIT Licence
|
||||
http://www.opensource.org/licenses/mit-license.php
|
||||
|
||||
Copyright (c) 2010 Maxim Kim
|
||||
Copyright (c) 2008-2010 Maxim Kim
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
Reference in New Issue
Block a user