Skip to content
Newer
Older
100644 98 lines (66 sloc) 3.51 KB
fdcf49b @isene Version 2.0: Initial upload
isene authored
1 GENERAL INFORAMTION ABOUT THE VIM PLUGIN FOR HYPERLISTS (version 2)
2
3 HyperLists are used to describe anything - any state, item(s), pattern,
4 action, process, transition, program, instruction set etc. So, you can use
5 it as an outliner, a ToDo list handler, a process design tool, a data
6 modeler, or any other way you want to describe something.
7
8 This plugin does both highlighting and various automatic handling of
9 HyperLists, like collapsing lists or parts of lists in a sophisticated
10 way.
11
12 The plugin incorporates encryption. You can encrypt any part of a
13 HyperList or take advantage of the autoencryption feature by making the
14 HyperList a dot file - i.e. prefixing the file name wiht a dot (such as
15 ".test.woim"). You can use this plugin to make a password safe.
16
17 As you most certainly have already done, to install the HyperList plugin
18 for VIM, dowmload woim.vba and do:
19
20 vim hyperlist.vba
21 :so %
22 :q
23
24 You will then discover that this file (README_HyperList will appear in the
25 VIM directory, while the documentation will be placed in the "doc"
26 subdirectory, the HyperList plugin will be placed in the "syntax"
27 subdirectory. A HyperList filetype detection file is placed in the
28 "ftdetect" subdirectory.
29
30 From now on all files with the ".hl" file extension will be treated as a
31 HyperList file, syntax highlighted corrrectly and you can use all the neat
32 HyperList functionality for VIM.
33
34 To use HyperLists within other file types (other than ".hl"), add the
35 following to those syntax files:
36
37 syn include @HL ~/.vim/syntax/hyperlist.vim
38 syn region HLSnip matchgroup=Snip start="HLstart" end="HLend" contains=@HL
39 hi link Snip SpecialComment
40
41 The documentation file contains all of the HyperList definition and is
42 part of the full specification for HyperList as found here:
43
44 http://isene.com/hyperlist.pdf
45
46
47 INSTRUCTIONS
48
49 Use tabs/shifts or * for indentations.
50
51 Use <SPACE> to toggle one fold.
52 Use \0 to \9, \a, \b, \c, \d, \e, \f to show up to 15 levels expanded.
53
54 As a sort of "presentation mode", you can traverse a WOIM list by using
55 g<DOWN> or g<UP> to view only the current line and its ancestors.
56 An alternative is <leader><DOWN> and <leader><UP> to open more levels down.
57
58 Use "gr" when the cursor is on a reference to jump to the referenced item.
59 A reference can be in the list or to a file by the use of
60 #file:/pathto/filename, #file:~/filename or #file:filename.
61
62 Use <leader>u to toggle underlining of Transitions, States or no underlining.
63
64 Use <leader>v to add a checkbox at start of item or to toggle a checkbox.
65 Use <leader>V to add/toggle a checkbox with a date stamp for completion.
66
67 Use <leader><SPACE> to go to the next open template element
68 (A template element is a WOIM item ending in an equal sign).
69
70 Use <leader>L to convert the entire document to LaTaX.
71 Use <leader>H to convert the entire document to HTML.
72
73 Use <leader>z encrypts the current line (including all sublevels if folded).
74 Use <leader>Z encrypts the current file (all lines).
75 Use <leader>x decrypts the current line.
76 Use <leader>X decrypts the current file (all lines).
77 <leader>z and <leader>x can be used with visual ranges.
78
79 A dot file (file name starts with a "." such as .test.woim) is
80 automatically encrypted on save and decrypted on opening.
81
82 Syntax is updated at start and every time you leave Insert mode.
83
84 For this help and more, including the full WOIM definition/description, type
85
86 :help HyperList
87
88 If you use tab completion after the "HyperList", you will find all the help
89 tags in the documentation.
90
91
92 Enjoy.
93
94
95 Geir Isene <g@isene.com>
96 ...explorer of free will
97 http://isene.com
Something went wrong with that request. Please try again.