Differences

This shows you the differences between two versions of the page.

--- tools:vim [2015/02/26 13:00] – created oschuett
+++ tools:vim [2023/11/10 15:31] (current) – krack
@@ Line 5: / Line 5: @@
 ==== Plugin setup ====
-Syntax highlighting for CP2K input files can be enabled with the (g)vim editor using the vim plugin file [[http://manual.cp2k.org/trunk/cp2k.vim | cp2k.vim]]. Download the file cp2k.vim and copy it to the folder ~/.vim/syntax in your home directory, e.g. using
+Syntax highlighting for CP2K input files can be enabled with the (g)vim editor using the vim plugin file [[http://manual.cp2k.org/trunk/cp2k.vim | cp2k.vim]].
+Download the file ''cp2k.vim'' and copy it to the folder ~/.vim/syntax in your home directory, e.g. using
-<code>
+<code bash>
-wget http://manual.cp2k.org/trunk/cp2k.vim
 mkdir -p ~/.vim/syntax
-mv cp2k.vim ~/.vim/syntax
+wget -O ~/.vim/syntax/cp2k.vim http://manual.cp2k.org/trunk/cp2k.vim
 </code>
-In addition create a file with the name filetype.vim in the ~/.vim folder containing the following lines
+In addition create a file with the name ''filetype.vim'' in the ''~/.vim'' folder containing the following lines
-<code>
+<code vim>
 if exists("did_load_filetypes")
    finish
 endif
 augroup filetypedetect
-   au! BufNewFile,BufRead *.inp setf cp2k
+   au! BufNewFile,BufRead *.inp set filetype=cp2k
+   au! BufNewFile,BufRead *.restart set filetype=cp2k
 augroup END
 </code>
-which causes that all files with the name extension ".inp" will be considered as CP2K input files by the Vim editor. You may change the extension due to your favored settings.
+which causes that all files with the name extensions ''.inp'' and ''.restart'' will be considered as CP2K input files by the Vim editor. You may change the extension due to your favored settings.
+=== Alternative for pathogen.vim/vim-plug users ===
+For developers using pathogen or similar VIM runtime path managers, a [[https://github.com/cp2k/vim-cp2k|separate vim-cp2k repository]] is provided and the setup procedure is even easier:
+<code bash>
+git clone https://github.com/cp2k/vim-cp2k.git ~/.vim/bundle/vim-cp2k
+</code>
 ==== Usage Tips ====
 === Syntax folding ===
-The syntax folding based on the CP2K input line indentation is supported by default. The following Vim editor commands might be useful for large CP2K input files:
+The syntax folding based on the CP2K input line indentation can be activated in the ~/.vimrc file by
+<code>
+au FileType cp2k setlocal foldlevel=99 foldmethod=indent
+</code>
+. The following Vim editor commands might be useful for large CP2K input files:
   * za :: Toggle the folding of the current fold level
   * zA :: Toggle the folding of all fold levels recursively
@@ Line 54: / Line 67: @@
 :set shiftwidth=0 tabstop=0
 </code>
+The vim indent command "=" can be used to properly indent a section (region) of a file or even the full file, e.g. by typing "=G" when the cursor is positioned at the first line of the input file.
 ==== Vim support for the CP2K code development ====