1- *context_commentstring .txt* For Vim version 7.3 Last change: 2013 July 6
1+ *context-commentstring .txt* For Vim version 7.3 Last change: 2013 July 6
22
33Version 0.1.0
44Script ID: ????
@@ -24,22 +24,22 @@ License: MIT license {{{
2424 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2525}}}
2626
27- CONTENTS *context_commentstring -contents*
27+ CONTENTS *context-commentstring -contents*
2828
29- Introduction | context_commentstring -introduction|
30- Installation | context_commentstring -installation|
31- Configuration and usage | context_commentstring -configuration|
32- Movement table | context_commentstring -table|
33- Customization | context_commentstring -customization|
34- Bugs and limitations | context_commentstring -bugs|
35- Credits and considerations | context_commentstring -credits|
36- Changelog | context_commentstring -changelog|
29+ Introduction | context-commentstring -introduction|
30+ Installation | context-commentstring -installation|
31+ Configuration and usage | context-commentstring -configuration|
32+ Movement table | context-commentstring -table|
33+ Customization | context-commentstring -customization|
34+ Bugs and limitations | context-commentstring -bugs|
35+ Credits and considerations | context-commentstring -credits|
36+ Changelog | context-commentstring -changelog|
3737
3838
3939==============================================================================
40- INTRODUCTION *context_commentstring -introduction*
40+ INTRODUCTION *context-commentstring -introduction*
4141
42- *context_commentstring * is a Vim plugin that sets the value of 'commentstring'
42+ *context-commentstring * is a Vim plugin that sets the value of 'commentstring'
4343to a different value depending on the region of the file you are in. Is only
4444useful for | file-types | where is possible to have a language embedded in a
4545language. The most common example are small pieces of CSS or JavaScript in an
@@ -57,7 +57,7 @@ code. Find the plugin at:
5757 https://github.com/tpope/vim-commentary
5858
5959------------------------------------------------------------------------------
60- INSTALLATION *context_commentstring -installation*
60+ INSTALLATION *context-commentstring -installation*
6161
6262The usual for any other Vim plugin: copy the files where Vim will look for
6363them with the same directory layout that came with the plugin. If you use
@@ -67,25 +67,25 @@ $HOME/.vim, and on Windows $HOME/vimfiles. See |vimfiles| for details.
6767
6868If you don't have installed any plugins yet, I strongly recommend to first
6969install and configure a plugin manager (a plugin to help you with other
70- plugins), and then install | context_commentstring | . My recommendation is that
70+ plugins), and then install | context-commentstring | . My recommendation is that
7171you start with Pathogen because is very simple and it works very well with a
7272version control system. Find it at:
7373 https://github.com/tpope/vim-pathogen
7474
7575------------------------------------------------------------------------------
76- CONFIGURATION AND USAGE *context_commentstring -configuration*
76+ CONFIGURATION AND USAGE *context-commentstring -configuration*
7777
7878It should work out of the box for HTML and Vim. It will simply change the
7979value of | commentstring | when you are in the appropriate region. See below for
8080how to customize or extend it.
8181
8282==============================================================================
83- CUSTOMIZATION *context_commentstring -customization*
83+ CUSTOMIZATION *context-commentstring -customization*
8484
8585The plugin works by checking if the current syntax group matches a group of an
8686embedded language, for example, JavaScript inside HTML. You can check the
8787default values by looking the source code, or simply with >
88- echo g:context_commentstring #table
88+ echo g:context-commentstring #table
8989<
9090
9191This variable is of type | Dictionary | , and you can modify it to your will. You
@@ -101,7 +101,7 @@ respectively.
101101You will need to know the names of the syntax group. For that, you can use the
102102| zS | command provided by | scriptease | , or use this simple but convenient
103103snippet of code: >
104- augroup temporary_test
104+ augroup temporary-test
105105 autocmd CursorMoved <buffer>
106106 \ echo map(synstack(line('.'), col('.')),
107107 \ 'synIDattr(v:val, "name")')
@@ -114,19 +114,19 @@ And when you are done with your testing, remove the echo doing: >
114114
115115
116116==============================================================================
117- BUGS *context_commentstring -bugs*
117+ BUGS *context-commentstring -bugs*
118118
119119At the moment, there is only one known issue: it doesn't work properly at the
120120edges of the embedded language, where the boundary is. Is unlikely that this
121121will have a solution, and is an uncommon case anyway. Try to move the cursor
122122one extra line further.
123123
124124Feel free to contact the author through Gitorious or GitHub:
125- https://gitorious.org/vim-for-qt-kde/vim-context_commentstring
126- https://github.com/suy/vim-context_commentstring
125+ https://gitorious.org/vim-for-qt-kde/vim-context-commentstring
126+ https://github.com/suy/vim-context-commentstring
127127
128128==============================================================================
129- CREDITS AND CONSIDERATIONS *context_commentstring -credits*
129+ CREDITS AND CONSIDERATIONS *context-commentstring -credits*
130130
131131This plugin was created almost solely to be used as a sidekick for
132132| commentary.txt | , by Tim Pope. And I only had the guts to attempt to implement
@@ -138,7 +138,7 @@ Natsuno and Shougo Matsushita, is probably the most brilliant and active Vim
138138plugin author.
139139
140140==============================================================================
141- CHANGELOG *context_commentstring -changelog*
141+ CHANGELOG *context-commentstring -changelog*
142142
1431430.1.0 2013-06-06
144144 - First public release.
0 commit comments