Permalink
Browse files

Version 2.0: Initial upload

  • Loading branch information...
0 parents commit fdcf49b4db27dd75d3cdfaf03b42f2260568766a @isene isene committed with Apr 5, 2012
Showing with 1,916 additions and 0 deletions.
  1. +31 −0 README
  2. +97 −0 README_HyperList
  3. +1,187 −0 doc/hyperlist.txt
  4. +50 −0 ftdetect/hyperlist.vim
  5. +551 −0 syntax/hyperlist.vim
@@ -0,0 +1,31 @@
+This is a mirror of http://www.vim.org/scripts/script.php?script_id=4006
+
+HyperList is a methodology to describe anything in plain text.
+
+HyperList can be used to describe any state or transition - anything from simple shopping and todo lists to large project plans, process design, the human history, the human DNA or the whole universe.
+
+With HyperList, descriptions become simple, easily readable, concise and precise.
+
+This VIM plugin makes it easy to create and manage HyperLists using VIM.
+
+The plugin includes a large range of features such as:
+
+* Complete highlighting of HyperList elements
+* Collapsing and expanding of up to 15 levels in a list
+* Linking/referencing between elements (items) in a list
+* Easy navigation in lists, including jumping to references
+* "Presentation modes" where you can view only parts of lists and line-by-line
+* Automatic underlining of State or Transition items in a list
+* Creating and checking of checkboxes in a list, with or without date stamps
+* Easy navigation to elements that needs filling out (when you use a list as a template)
+* Encryption (and decryption) of whole lists or parts of lists
+* Auto-encryption of lists - making a list into an excellent password safe
+* HTML export of lists
+* LaTeX export of lists
+* Description on how to include HyperLists within other filetypes, thus taking full advantage of the above features when including a HyperList in e.g. a normal .txt document.
+* All documents with the file suffix ".hl" is treated as HyperList documents
+* ... and there are many more features. Check out the comprehensive documentation (type ":help HyperList" in VIM after install)
+
+This VIM plugin is the continuation of the now deprecated WOIM plugin (http://www.vim.org/scripts/script.php?script_id=2518)
+
+There is virtually no limit to what you can use HyperLists for. Contact me at g @ isene . com if you have any questions or suggestions, or if you just want to have a chat about HyperList (or any other things that are cool & interesting). See http://isene.com for more of my work.
@@ -0,0 +1,97 @@
+GENERAL INFORAMTION ABOUT THE VIM PLUGIN FOR HYPERLISTS (version 2)
+
+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
+way.
+
+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 %
+ :q
+
+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:
+
+ http://isene.com/hyperlist.pdf
+
+
+INSTRUCTIONS
+
+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" when the cursor is on a reference to jump to the referenced item.
+A reference can be in the list or to a file by the use of
+#file:/pathto/filename, #file:~/filename or #file:filename.
+
+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 is updated at start and every time you leave Insert mode.
+
+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.
+
+
+Enjoy.
+
+
+Geir Isene <g@isene.com>
+...explorer of free will
+ http://isene.com
Oops, something went wrong.

0 comments on commit fdcf49b

Please sign in to comment.