nvie / Vim Rst Tables
Easily create and reformat your RST (reStructuredText) tables as you change cell content.
Stars: ✭ 118
Programming Languages
python
139335 projects - #7 most used programming language
vim-rst-tables
.. image:: http://stillmaintained.com/nvie/vim-rst-tables.png
.. contents:: Contents :local:
Installation
-
Install the following packages from PyPI:
- vim_bridge_: This is required for the vim plugin scripts, to call directly into Python functions.
-
Clone the git repository::
git clone git://github.com/nvie/vim-rst-tables.git cd vim-rst-tables
-
Copy the file
ftplugin/rst_tables.vim
to your~/.vim/ftplugin
directory. If your vim is not already configured to source scripts in this directory, make sure to add the appropriate command to your.vimrc
::source "~/.vim/ftplugin/rst_tables.vim"
.. _vim_bridge: http://pypi.python.org/pypi/vim_bridge
Usage
Creating a new table
1. Open a reStructuredText file
2. Create some kind of table outline::
This is paragraph text *before* the table.
Column 1 Column 2
Foo Put two (or more) spaces as a field separator.
Bar Even very very long lines like these are fine, as long as you do not put in line endings here.
Qux This is the last line.
This is paragraph text *after* the table.
2. Put your cursor somewhere in the table.
3. To create the table, press :kbd:`,,c` (or :kbd:`\\c` if vim's
:kbd:`<Leader>` is set to the default value). The output will look
something like this::
This is paragraph text *before* the table.
+----------+---------------------------------------------------------+
| Column 1 | Column 2 |
+==========+=========================================================+
| Foo | Put two (or more) spaces as a field separator. |
+----------+---------------------------------------------------------+
| Bar | Even very very long lines like these are fine, as long |
| | as you do not put in line endings here. |
+----------+---------------------------------------------------------+
| Qux | This is the last line. |
+----------+---------------------------------------------------------+
This is paragraph text *after* the table.
Re-flowing an existing table
Sometimes, you may have a column that contains enough data that your table is a little hard to work with. To fix that kind of problem, you can define the column width you would prefer, and re-flow your table.
- Change the number of "---" signs in the top row of your table to match the column widths you would prefer.
- Put your cursor somewhere in the table.
- Press :kbd:
,,f
to re-flow the table (or :kbd:\\f
if vim's :kbd:<Leader>
is set to the default value; see also the:map
command).
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].