m (Changed the category.) |
(Added content on using folds. Still requires expansion of use of other foldmethod values.) |
||
| Line 1: | Line 1: | ||
{{needs love}}{{draft}} | {{needs love}}{{draft}} | ||
== Folding == | |||
As of VIM 7.0 support for folds is included in the editor. Folds allow sections of a document which are not being actively worked on to be 'folded' into themselves and hidden. Programmers often use folds to hide and show functions, classes and structures but the functionality is equally useful when editing DocBook XML. | |||
Whether VIM folds content and how it folds it depends on the <code>foldmethod</code> setting. There are a number of valid options: | |||
* <code>manual</code> - Folds are created manually. | |||
* <code>indent</code> - Folds are created based on indentation levels. | |||
* <code>expr</code> - Folds are created based on the value of <code>foldexpr</code>. | |||
* <code>marker</code> - Folds are created based on markers. | |||
* <code>syntax</code> - Folds are created based on syntax highlighting items. | |||
* <code>diff</code> - Folds are created based on whether text has/hasn't changed, text that hasn't changed is folded. | |||
When working with consistently indented XML content the <code>indent</code> method is very easy to invoke and requires no additional setup. It can be accessed by issuing: | |||
<pre> | |||
set foldmethod=indent | |||
</pre> | |||
Issuing this command while a consistently indented XML file is open in the buffer will result in a number of folds being created. Folds can be opened by placing the cursor on the line denoting the fold. For example in the following XML block there is an appendix opened on line 4 and closed on line 184. The enclosed content is a fold which contains 179 lines of text. | |||
<pre> | |||
4 <appendix id="chap-RedHat_Enterprise_Virtualization-Administration_Guide-Backup_and_Recovery"> | |||
5 +--179 lines: <title>&PRODUCT; Manager backup and recovery</title>---------------- | |||
184 </appendix> | |||
</pre> | |||
Opening the fold is as simple as placing the cursor on the fold in command mode and entering <code>zo</code>. Folds can be closed by issuing <code>zc</code> in command mode while the cursor is within the fold. | |||
By default folds are discarded when exiting. Folds can be explicitly written to disk by issuing <code>:mkview</code>. When the file is next opened <code>:loadview</code> can be issued to reload previously saved folds for the document. Alternatively the following lines can be placed in the users <code>.vimrc</code> file to ensure that folds are automatically loaded and saved when buffers are opened and closed respectively. | |||
<pre> | |||
au BufWinLeave * mkview | |||
au BufWinEnter * silent loadview | |||
</pre> | |||
There are many other options to facilitate modification of the way folds behave in VIM. Further information on the use of folds in VIM can be accessed by issuing <code>:help fold</code> from command mode. | |||
== Vi config file hacks == | == Vi config file hacks == | ||
Revision as of 05:06, 11 October 2010
This page should be revised or reconstructed to be more helpful. Problems may include being out of step with current team or project status or process.
It is still under construction and content may change. Do not rely on the information on this page.
Folding
As of VIM 7.0 support for folds is included in the editor. Folds allow sections of a document which are not being actively worked on to be 'folded' into themselves and hidden. Programmers often use folds to hide and show functions, classes and structures but the functionality is equally useful when editing DocBook XML.
Whether VIM folds content and how it folds it depends on the foldmethod setting. There are a number of valid options:
manual- Folds are created manually.indent- Folds are created based on indentation levels.expr- Folds are created based on the value offoldexpr.marker- Folds are created based on markers.syntax- Folds are created based on syntax highlighting items.diff- Folds are created based on whether text has/hasn't changed, text that hasn't changed is folded.
When working with consistently indented XML content the indent method is very easy to invoke and requires no additional setup. It can be accessed by issuing:
set foldmethod=indent
Issuing this command while a consistently indented XML file is open in the buffer will result in a number of folds being created. Folds can be opened by placing the cursor on the line denoting the fold. For example in the following XML block there is an appendix opened on line 4 and closed on line 184. The enclosed content is a fold which contains 179 lines of text.
4 <appendix id="chap-RedHat_Enterprise_Virtualization-Administration_Guide-Backup_and_Recovery"> 5 +--179 lines: <title>&PRODUCT; Manager backup and recovery</title>---------------- 184 </appendix>
Opening the fold is as simple as placing the cursor on the fold in command mode and entering zo. Folds can be closed by issuing zc in command mode while the cursor is within the fold.
By default folds are discarded when exiting. Folds can be explicitly written to disk by issuing :mkview. When the file is next opened :loadview can be issued to reload previously saved folds for the document. Alternatively the following lines can be placed in the users .vimrc file to ensure that folds are automatically loaded and saved when buffers are opened and closed respectively.
au BufWinLeave * mkview au BufWinEnter * silent loadview
There are many other options to facilitate modification of the way folds behave in VIM. Further information on the use of folds in VIM can be accessed by issuing :help fold from command mode.
Vi config file hacks
For convenient editing, I add the following lines to the bottom of any DocBook files I'll be editing in Vi(m):
<!-- vim: softtabstop=2:shiftwidth=2:expandtab:textwidth=72 -->