Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Tag: 2.1.5
Fetching contributors…

Cannot retrieve contributors at this time

111 lines (76 sloc) 4.07 KB
HyperLists are used to describe anything - any state, item(s), pattern,
action, process, transition, program, instruction set etc. So, you can use
it as an outliner, a ToDo list handler, a process design tool, a data
modeler, or any other way you want to describe something.
This plugin does both highlighting and various automatic handling of
HyperLists, like collapsing lists or parts of lists in a sophisticated
The plugin incorporates encryption. You can encrypt any part of a
HyperList or take advantage of the autoencryption feature by making the
HyperList a dot file - i.e. prefixing the file name wiht a dot (such as
".test.woim"). You can use this plugin to make a password safe.
As you most certainly have already done, to install the HyperList plugin
for VIM, dowmload woim.vba and do:
vim hyperlist.vba
:so %
You will then discover that this file (README_HyperList will appear in the
VIM directory, while the documentation will be placed in the "doc"
subdirectory, the HyperList plugin will be placed in the "syntax"
subdirectory. A HyperList filetype detection file is placed in the
"ftdetect" subdirectory.
From now on all files with the ".hl" file extension will be treated as a
HyperList file, syntax highlighted corrrectly and you can use all the neat
HyperList functionality for VIM.
To use HyperLists within other file types (other than ".hl"), add the
following to those syntax files:
syn include @HL ~/.vim/syntax/hyperlist.vim
syn region HLSnip matchgroup=Snip start="HLstart" end="HLend" contains=@HL
hi link Snip SpecialComment
The documentation file contains all of the HyperList definition and is
part of the full specification for HyperList as found here:
Use tabs/shifts or * for indentations.
Use <SPACE> to toggle one fold.
Use \0 to \9, \a, \b, \c, \d, \e, \f to show up to 15 levels expanded.
As a sort of "presentation mode", you can traverse a WOIM list by using
g<DOWN> or g<UP> to view only the current line and its ancestors.
An alternative is <leader><DOWN> and <leader><UP> to open more levels down.
Use "gr" (without the quotation marks, signifies "Goto Ref") or simply
press the "Enter" ("<CR>") key while the cursor is on a HyperList
reference to jump to that destination in a HyperList. Use "n" after a "gr"
to verify that the reference destination is unique. A reference can be in
the list or to a file by the use of #file:/pathto/filename,
#file:~/filename or #file:filename.
Whenever you jump to a reference in this way, the mark "'" is set at the
point you jumped from so that you may easily jump back by hitting "''"
(single quoutes twice).
Use <leader>u to toggle underlining of Transitions, States or no underlining.
Use <leader>v to add a checkbox at start of item or to toggle a checkbox.
Use <leader>V to add/toggle a checkbox with a date stamp for completion.
Use <leader><SPACE> to go to the next open template element
(A template element is a WOIM item ending in an equal sign).
Use <leader>L to convert the entire document to LaTaX.
Use <leader>H to convert the entire document to HTML.
Use <leader>z encrypts the current line (including all sublevels if folded).
Use <leader>Z encrypts the current file (all lines).
Use <leader>x decrypts the current line.
Use <leader>X decrypts the current file (all lines).
<leader>z and <leader>x can be used with visual ranges.
A dot file (file name starts with a "." such as .test.woim) is
automatically encrypted on save and decrypted on opening.
Syntax updated at start and every time you leave Insert mode, or you can
press "zx" to update the syntax.
You may speed up larger HyperListS by setting the the global variable
"disable_collapse" - add the following to your .vimrc:
let "g:disable_collapse" = 1
For this help and more, including the full WOIM definition/description, type
:help HyperList
If you use tab completion after the "HyperList", you will find all the help
tags in the documentation.
Geir Isene <>
...explorer of free will
Jump to Line
Something went wrong with that request. Please try again.