Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Easily create and reformat your RST (reStructuredText) tables as you change cell content.
Python VimL
Branch: master

README.rst

vim-rst-tables

http://stillmaintained.com/nvie/vim-rst-tables.png

Installation

  1. Install the following packages from PyPI:

    • vim_bridge: This is required for the vim plugin scripts, to call directly into Python functions.
  2. Clone the git repository:

    git clone git://github.com/nvie/vim-rst-tables.git
    cd vim-rst-tables
    
  3. Make the project:

    python build.py
    
  4. 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"
    

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.
    
  1. Put your cursor somewhere in the table.

  2. To create the table, press ,,c (or \\c if vim's <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.

  1. Change the number of "---" signs in the top row of your table to match the column widths you would prefer.
  2. Put your cursor somewhere in the table.
  3. Press ,,f to re-flow the table (or \\f if vim's <Leader> is set to the default value; see also the :map command).
Something went wrong with that request. Please try again.