[svn] r5620 - trunk/tools/asciidoc-vim

packagers at lists.rpmforge.net packagers at lists.rpmforge.net
Thu Jul 19 17:12:44 CEST 2007


Author: dag
Date: 2007-07-19 17:11:36 +0200 (Thu, 19 Jul 2007)
New Revision: 5620

Added:
   trunk/tools/asciidoc-vim/README.txt
Log:
Added preliminary README.

Added: trunk/tools/asciidoc-vim/README.txt
===================================================================
--- trunk/tools/asciidoc-vim/README.txt	                        (rev 0)
+++ trunk/tools/asciidoc-vim/README.txt	2007-07-19 15:11:36 UTC (rev 5620)
@@ -0,0 +1,54 @@
+= AsciiDoc syntax highlighting in VIM
+Dag Wieers <dag at wieers.com>
+
+
+== Installing the asciidoc.vim file
+Put the _asciidoc.vim_ syntax file in your home directory at
+_~/.vim/syntax/asciidoc.vim_. That should be sufficient to have AsciiDoc
+support in VIM.
+
+
+== Auto enabling syntax highlighting
+AsciiDoc files have the default +.txt+ extension and therefor are
+indistinguishable from plain text files (that do not honour the AsciiDoc
+rules). Therefor we cannot automatically enable syntax highlighting in VIM for
+AsciiDoc files.
+
+To enable syntax highlighting for AsciiDoc files, add the following line at
+the end of your AsciiDoc files:
+
+----
+// vim: set syntax=asciidoc:
+----
+
+== Testing VIM syntax files
+The syntax file considers 3 different environments.
+
+ 1. Terminal
+ 2. Color terminal
+ 3. GUI
+
+Each of these have different capabilities and therefor can have different
+definitions. To test each of these on a capable terminal, try:
+
+ $ TERM=vt100 vim README.txt
+ $ TERM=ansi vim README.txt
+ $ gvim README.txt
+
+
+== Known shortcomings
+There are a few quirks in the syntax files. Here is an overview:
+
+Underlining titles does not work consistently???
+
+    There is no way that we can match the length of a title with the length of
+    the line under it. Because of that every line preceded by text could
+    ambigously be interpreted as either a title or the start of a block. Use
+    the wiki-style syntax for titles. (used by this document)
+
+
+== Feedback
+If you have fixes or improvements to the syntax file, please send them to:
+mailto:dag at wieers.com[dag at wieers.com].
+
+// vim: set syntax=asciidoc:




More information about the commits mailing list