Skip to content

Commit

Permalink
Update documentation for 0.42.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
keforbes committed Apr 6, 2014
1 parent d4ab671 commit 5b64e2e
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 23 deletions.
9 changes: 8 additions & 1 deletion website/documentation/commandline_commands.html
Expand Up @@ -124,6 +124,11 @@ <h2>Command-Line Commands</h2>
<td>:source &lt;filename&gt;</td>
<td>Include another config file (e.g., ":source .vimrc") to extend current configuration</td>
</tr>
<tr>
<td>:let @&lt;char&gt;=&lt;register contents&gt;</td>
<td>Programmatically set register contents for register &lt;char&gt;. Register can then be executed as a macro.<br/><br/>
We don't currently support any other <code>:let</code> behavior.</td>
</tr>
<tr>
<td>:!&lt;command&gt;</td>
<td>Execute a shell command with the selected text as input.</td>
Expand Down Expand Up @@ -262,7 +267,9 @@ <h2>Command-Line Commands</h2>
and column as it was in Eclipse. This allows you to perform any operation in gvim which Vrapper doesn't support.
After you save the file and exit gvim (:wq) Eclipse will reload the file with your changes.
<br/><br/>
Path to gvim is determined by 'gvimpath' property (defaults to /usr/bin/gvim).</td>
Path to gvim is determined by 'gvimpath' property (defaults to /usr/bin/gvim).<br/>
Arguments for gvim is determined by 'gvimargs' property.<br/>
</td>
</tr>
<tr>
<td>:maximize</td>
Expand Down
4 changes: 3 additions & 1 deletion website/documentation/commands.html
Expand Up @@ -103,7 +103,9 @@ <h3>Text Objects</h3>
<ul class="commands">
<li>All text objects may be defined with 'i' to <b>exclude</b> the bounding characters or
'a' to <b>include</b> the bounding characters. For example, di( will delete everything
within the parentheses and da( will delete the parentheses and everything within them.</li>
within the parentheses and da( will delete the parentheses and everything within them.<br/>
m&lt;char&gt; allows you to define any arbitrary &lt;char&gt; as the delimiter. For example,
<code>vim*</code> will select (in visual mode) text between two '*' characters.</li>
</ul>
<br/>
<ul class="commands">
Expand Down
9 changes: 9 additions & 0 deletions website/documentation/configuration.html
Expand Up @@ -227,6 +227,14 @@ <h3>Vrapper Settings</h3>
<td>gvimpath=/usr/bin/gvim</td>
<td>Defines path to gvim used with :vim command.</td>
</tr>
<tr>
<td>:set&nbsp;gvimargs=&lt;arguments for gvim executable&gt;</td>
<td>none</td>
<td>gvimargs=+{line} -c normal zv{col}| -c set nobackup -f -n {file}</td>
<td>Defines arguments to send to gvim when using :vim command. Supports
placeholder strings {line}, {col}, and {file} which define current
cursor position and filename in Eclipse.</td>
</tr>
<tr>
<td>:set&nbsp;cleanindent<br/>:set&nbsp;nocleanindent</td>
<td>none</td>
Expand Down Expand Up @@ -378,6 +386,7 @@ <h3>Remapping Keys</h3>
<li>DELETE</li>
<li>BACKSPACE*</li>
<li>SPACE</li>
<li>BAR</li>
</ul>
<dl>
<dt>* InsertMode can only map the special character names marked with an asterisk. All other special characters of this list are ignored.</dt>
Expand Down
41 changes: 20 additions & 21 deletions website/documentation/optional_plugins.html
Expand Up @@ -189,6 +189,26 @@ <h3>Method Text Object (methodtextobj.vim) Plugin</h3>
of matching '{' and '}' in a file (where a class definition would be the 1st-level). Thus it is handy for Java and C++ source
files or similarly formatted code.</p>

<h3>Exchange (exchange.vim) Plugin</h3>

<p>exchange.vim is a vim plugin defined here:<br>
<a href="https://github.com/tommcdo/vim-exchange">https://github.com/tommcdo/vim-exchange</a><br/>
<br/>
Easy text exchange operator for Vim.</p>
<p>The plugin provides the following commands:</p>
<table class="commands">
<tr><th>Command</th><th>Mode</th><th>Description</th></tr>
<tr><td><code>cx&lt;text object&gt;</code></td><td>normal</td><td>highlight/exchange a text object</td></tr>
<tr><td><code>cxx</code></td><td>normal</td><td>highlight/exchange the current line</td></tr>
<tr><td><code>cxc</code></td><td>normal</td><td>clear previously highlighted text object</td></tr>
<tr><td><code>X</code></td><td>visual</td><td>highlight/exchange visual selection</td></tr>
</table>

<p>The colour of the exchange region is configured in <br/>
<i>Windows</i> -&gt <i>Preferences</i> -&gt <i>General</i> -&gt <i>Editors</i> -&gt <i>Text Editors</i> -&gt <i>Annotations</i> -&gt <i>Vrapper Exchange Region</i></p>

<p>NOTE: Block-wise visual selection is not implemented.</p>

<h3>Surround (surround.vim) Plugin</h3>
<p>Surround.vim is a vim plugin defined here:<br>
<a href="http://www.vim.org/scripts/script.php?script_id=1697">http://www.vim.org/scripts/script.php?script_id=1697</a><br/>
Expand Down Expand Up @@ -267,24 +287,3 @@ <h5>Change tag, remove all attributes</h5>
<li>Press <tt>cstt</tt> again.</li>
<li>Enter <tt>&lt;span&gt;</tt></li>
</ol>

<h3>Exchange (exchange.vim) Plugin</h3>

<p>exchange.vim is a vim plugin defined here:<br>
<a href="https://github.com/tommcdo/vim-exchange">https://github.com/tommcdo/vim-exchange</a><br/>
<br/>
Easy text exchange operator for Vim.</p>
<p>The plugin provides the following commands:</p>
<table class="commands">
<tr><th>Command</th><th>Mode</th><th>Description</th></tr>
<tr><td><code>cx&lt;text object&gt;</code></td><td>normal</td><td>highlight/exchange a text object</td></tr>
<tr><td><code>cxx</code></td><td>normal</td><td>highlight/exchange the current line</td></tr>
<tr><td><code>cxc</code></td><td>normal</td><td>clear previously highlighted text object</td></tr>
<tr><td><code>X</code></td><td>visual</td><td>highlight/exchange visual selection</td></tr>
</table>

<p>The colour of the exchange region is configured in <br/>
<i>Windows</i> -&gt <i>Preferences</i> -&gt <i>General</i> -&gt <i>Editors</i> -&gt <i>Text Editors</i> -&gt <i>Annotations</i> -&gt <i>Vrapper Exchange Region</i></p>

<p>NOTE: Block-wise visual selection is not implemented.</p>

0 comments on commit 5b64e2e

Please sign in to comment.