Changes between Version 3 and Version 4 of Web/ViEditor

Timestamp:

Mar 28, 2011, 4:24:33 PM (15 years ago)

Author:

/O=GRID-FR/C=FR/O=CNRS/OU=IPHC/CN=Jerome Pansanel

Comment:

--

Web/ViEditor

@@ -3 +3 @@
 [http://www.vim.org/ Vim] is a highly configurable text editor built to enable efficient text editing. It supports syntax highlighting and code completion for many languages. However, PAN language is not supported by default. The following sections describes how to use Vi for PAN template development.
 
-== Syntax Highlighting ==
-
-The syntax highlighting is enabled by installing two files. It can be done with the following process:
+If you want to enable PAN syntax highlighting or code completion, the first step is to tell to Vim how to recognize PAN files. To do this, create the following directory:
 {{{
 mkdir -p ${HOME}/.vim/ftdetect
-mkdir ${HOME}/.vim/syntax
 }}}
 
-Download the following file from the quattor website:
+and download the following file from the quattor website:
 {{{
 https://quattor.svn.sourceforge.net/svnroot/quattor/trunk/util/vim/ftdetect/pan.vim
@@ -17 +14 @@
 and copy it to the {{{${HOME}/.vim/ftdetect}}} directory.
 
-Download the following file from the quattor website:
+=== Syntax Highlighting ===
+
+For highlighting PAN keywords, create the {{{syntax}}} directory with the following
+command:
+{{{
+mkdir ${HOME}/.vim/syntax
+}}}
+Then download the following file from the quattor website:
 {{{
 https://quattor.svn.sourceforge.net/svnroot/quattor/trunk/util/vim/syntax/pan.vim
 }}}
-and copy it to the {{{${HOME}/.vim/syntax}}} directory.
+and copy it to the {{{${HOME}/.vim/syntax directory}}}.
 
-Take care, the two files have the same name!
+=== PAN Code Completion ===
+
+For enabling code auto-completion, add the following line in your {{{.vimrc}}} file:
+filetype plugin on
+
+Then create the autoload and ftplugin directories with the following commands:
+{{{
+mkdir ${HOME}/.vim/autoload
+mkdir ${HOME}/.vim/ftplugin
+}}}
+
+Put in the {{{autoload}}} directory the following file:
+{{{
+https://quattor.svn.sourceforge.net/svnroot/quattor/trunk/util/vim/autoload/pancomplete.vim
+}}}
+
+Put in the {{{ftplugin}}} directory the following file:
+{{{
+https://quattor.svn.sourceforge.net/svnroot/quattor/trunk/util/vim/ftplugin/pan.vim
+}}}
+
+Code completion is performed by using Ctrl-x + Ctrl-o in ''insert'' or ''append'' mode.
+
+