From a3a499080b79ed1e625516b74db3875c43a66d8f Mon Sep 17 00:00:00 2001 From: EinfachToll Date: Mon, 29 Jul 2013 10:57:07 +0200 Subject: [PATCH] Further update for the documentation --- doc/vimwiki.txt | 123 +++++++++++++++++++++++++----------------------- 1 file changed, 65 insertions(+), 58 deletions(-) diff --git a/doc/vimwiki.txt b/doc/vimwiki.txt index c1e3efb..aa534e7 100644 --- a/doc/vimwiki.txt +++ b/doc/vimwiki.txt @@ -326,7 +326,7 @@ gLh Decrease the level of a list item and all child items. glr Renumber list items for the current list. gLr Renumber list items for the whole buffer. - *vimwiki_glstar* *vimwiki_glstar* + *vimwiki_glstar* *vimwiki_gLstar* gl* Make a list item out of normal line or change the marker of the current item to *. gL* Change the marker of the current list to *. @@ -446,11 +446,11 @@ INSERT MODE *vimwiki-list-mappings* *vimwiki_i___list* Change the marker of the current list item to the next - available. From * to - to # to 1. to a). + available. From - to • to 1. to * to I) to a). *vimwiki_i___list* Change the marker of the current list item to the prev - available. From * to a) to 1. to # to -. + available. From - to a) to I) to * to 1. to •. *vimwiki_i___list* Create/remove a marker from a list item. @@ -762,72 +762,79 @@ two lines. 5.5. Lists *vimwiki-syntax-lists* Unordered lists: > + - Bulleted list item 1 + - Bulleted list item 2 +or: > + • Bulleted list item 1 + • Bulleted list item 2 +or: > * Bulleted list item 1 * Bulleted list item 2 - * Bulleted list sub item 1 - * Bulleted list sub item 2 - * more ... - * and more ... - * ... - * Bulleted list sub item 3 - * etc. or: > - - Bulleted list item 1 - - Bulleted list item 2 - - Bulleted list sub item 1 - - Bulleted list sub item 2 - - more ... - - and more ... - - ... - - Bulleted list sub item 3 - - etc. + # Bulleted list item 1 + # Bulleted list item 2 -or mix: > - - Bulleted list item 1 - - Bulleted list item 2 - * Bulleted list sub item 1 - * Bulleted list sub item 2 - * more ... - - and more ... - - ... - * Bulleted list sub item 3 - * etc. Ordered lists: > - # Numbered list item 1 - # Numbered list item 2 - # Numbered list sub item 1 - # Numbered list sub item 2 - # more ... - # and more ... - # ... - # Numbered list sub item 3 - # etc. + 1. Numbered list item 1 + 2. Numbered list item 2 + 3. Numbered list item 3 +or: > + 1) Numbered list item 1 + 2) Numbered list item 2 + 3) Numbered list item 3 +or: > + a) Numbered list item 1 + b) Numbered list item 2 + c) Numbered list item 3 +or: > + A) Numbered list item 1 + B) Numbered list item 2 + C) Numbered list item 3 +or: > + i) Numbered list item 1 + ii) Numbered list item 2 + iii) Numbered list item 3 +or: > + I) Numbered list item 1 + II) Numbered list item 2 + III) Numbered list item 3 -It is possible to mix bulleted and numbered lists: > - * Bulleted list item 1 - * Bulleted list item 2 - # Numbered list sub item 1 - # Numbered list sub item 2 +You can nest and mix the various types: > + - Bulleted list item 1 + - Bulleted list item 2 + a) Numbered list sub item 1 + b) more ... + • and more ... + • ... + c) Numbered list sub item 3 + 1. Numbered list sub sub item 1 + 2. Numbered list sub sub item 2 + d) etc. + - Bulleted list item 3 -Note that a space after *, - or # is essential. -Multiline list items: > - * Bulleted list item 1 - List item 1 continued line. - List item 1 next continued line. - * Bulleted list item 2 - * Bulleted list sub item 1 - List sub item 1 continued line. - List sub item 1 next continued line. - * Bulleted list sub item 2 - * etc. +Note that a space after the list item markers (-, *, 1. etc.) are essential + +List items can span multiple lines: > + * Item 1 + Item 1 continued line. + Item 1 next continued line. + * Item 2 + - Sub item 1 + Sub item 1 continued line. + Sub item 1 next continued line. + - Sub item 2 + - etc. + Continuation of Item 2 + Next continuation of Item 2 + Definition lists: > -Term 1:: Definition 1 -Term 2:: -:: Definition 2 -:: Definition 3 + Term 1:: Definition 1 + Term 2:: + :: Definition 2 + :: Definition 3 ------------------------------------------------------------------------------