diff --git a/doc/argwrap.txt b/doc/argwrap.txt index a20b655..11af330 100644 --- a/doc/argwrap.txt +++ b/doc/argwrap.txt @@ -1,7 +1,15 @@ -argwrap.txt Wrap and unwrap function arguments, lists, and dictionaries in Vim +argwrap.txt -======================================================================================================================== -ARGWRAP *argwrap-argwrap* +================================================================================ +CONTENTS + +1. ArgWrap.......................................................|argwrap-argwrap| + 1.1. Installation.......................................|argwrap-installation| + 1.2. Usage.....................................................|argwrap-usage| + 1.3. Configuration.....................................|argwrap-configuration| + +================================================================================ +ARGWRAP *argwrap-argwrap* ArgWrap is an industrial strength argument wrapping and unwrapping extension for the Vim (http://www.vim.org/) text editor. It can be used for collapsing and expanding everything from function calls to array and dictionary definitions. @@ -9,13 +17,8 @@ All operations are easily reversible and correctly preserve the indentation of t -ArgWrap |argwrap-argwrap| - Installation |argwrap-installation| - Usage |argwrap-usage| - Configuration |argwrap-configuration| - ------------------------------------------------------------------------------------------------------------------------- -INSTALLATION *argwrap-installation* +-------------------------------------------------------------------------------- +INSTALLATION *argwrap-installation* 1. Clone or otherwise download ArgWrap extension from the GitHub (https://github.com/FooSoft/vim-argwrap) page. If you are using pathogen.vim (https://github.com/tpope/vim-pathogen) for plugin management you can clone the @@ -29,15 +32,15 @@ INSTALLATION nnoremap a :ArgWrap < ------------------------------------------------------------------------------------------------------------------------- -USAGE *argwrap-usage* +-------------------------------------------------------------------------------- +USAGE *argwrap-usage* 1. Position the cursor inside of the scope of the parenthesis, brackets or curly braces you wish to wrap/unwrap (not on top, before or after them). 2. Execute the keyboard binding you defined above to toggle the wrapping and unwrapping of arguments. ------------------------------------------------------------------------------------------------------------------------- -CONFIGURATION *argwrap-configuration* +-------------------------------------------------------------------------------- +CONFIGURATION *argwrap-configuration* You can customize the behavior of this extension by setting values for any of the following optional buffer and global variables in your `.vimrc` file: