Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve documentation notes (thanks to Laurent & SteP)

  • Loading branch information...
commit 7a9e92345a4705286eab10764bdf3d298a344483 1 parent 8759b17
@xolox authored
View
8 doc/notes.txt
@@ -42,7 +42,7 @@ Here's a screen shot of the syntax mode using the slate [3] color scheme:
Syntax mode screen shot, see reference [4]
-==============================================================================
+===============================================================================
*notes-install-usage*
Install & usage ~
@@ -53,7 +53,7 @@ restart Vim and execute the command ':helptags ~/.vim/doc' (use ':helptags
note:', this will start a new note that contains instructions on how to
continue from there (and how to use the plug-in in general).
-==============================================================================
+===============================================================================
*notes-contact*
Contact ~
@@ -62,14 +62,14 @@ contacted at peter@peterodding.com. The latest version is available at
http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes.
If you like the script please vote for it on Vim Online [6].
-==============================================================================
+===============================================================================
*notes-license*
License ~
This software is licensed under the MIT license [7]. Copyright 2011 Peter
Odding <peter@peterodding.com>.
-==============================================================================
+===============================================================================
*notes-references*
References ~
View
2  misc/notes/shadow/New note
@@ -7,7 +7,7 @@ automatically based on the title.
* * *
The notes plug-in comes with self hosting documentation. To jump to these notes
-position your text on the highlighted name and press ‘gf’ in normal mode:
+position your cursor on the highlighted name and press ‘gf’ in normal mode:
• Note taking syntax
• Note taking commands
View
8 misc/notes/shadow/Note taking syntax
@@ -1,7 +1,9 @@
Note taking syntax
This note contains examples of the syntax highlighting styles supported by the
-notes plug-in.
+notes plug-in. When your Vim configuration supports concealing of text, the
+markers which enable the syntax highlighting won’t be visible. In this case you
+can make the markers visible by selecting the text.
# Headings
@@ -21,8 +23,8 @@ Hyper links and such:
• Hyper links: http://www.vim.org/, sftp://server/file
• Domain names: www.python.org
• E-mail addresses: user@host.ext
- • UNIX filenames: ~/.vim/notes
- • Windows filenames: ~\vimfiles\notes
+ • UNIX filenames: ~/relative/to/home, /absolute/path
+ • Windows filenames: ~\relative\to\home, c:\absolute\path, \\server\share
# Lists
Please sign in to comment.
Something went wrong with that request. Please try again.