From 7a9e92345a4705286eab10764bdf3d298a344483 Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Sat, 4 Jun 2011 00:02:30 +0200 Subject: [PATCH] Improve documentation notes (thanks to Laurent & SteP) --- doc/notes.txt | 8 ++++---- misc/notes/shadow/New note | 2 +- misc/notes/shadow/Note taking syntax | 8 +++++--- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/notes.txt b/doc/notes.txt index 6189b62..e4335c8 100644 --- a/doc/notes.txt +++ b/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 . -============================================================================== +=============================================================================== *notes-references* References ~ diff --git a/misc/notes/shadow/New note b/misc/notes/shadow/New note index f111ef5..c7c6a02 100644 --- a/misc/notes/shadow/New note +++ b/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 diff --git a/misc/notes/shadow/Note taking syntax b/misc/notes/shadow/Note taking syntax index 0262257..1179f36 100644 --- a/misc/notes/shadow/Note taking syntax +++ b/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