rst-snippets

This Atom Package is focused on developing some shortcuts for editing reStructuredText documents.

Headers

This is set of shortcut methods to take the current line and turn it into a reStructuredText header.

Usage

1. Set reStructuredText as syntax (or open a .rst)
2. Create a line of text::

 This is a Line of text

3. Put your cursor somewhere in the content to turn into a heading.
4. Press ctrl+alt+h 1 to turn the line of text into a Level 1 heading. The output will look something like this::

 ======================
 This is a Line of text
 ======================

Notes

You can choose the heading level by pressing the corresponding level key after pressing ctrl+alt+h.

Tables

This is a Atom adaptation of Vincent Driessen's vim-rst-tables1 code by Martín Gaitán gaitan@gmail.com

Usage

1. Set reStructuredText as syntax (or open a .rst)

2. Create some kind of table outline:

    This is paragraph text *before* the table.
   
    Column 1  Column 2
    Hickory  Insert two (or more) spaces as a field separator.
    Dickory  Long lines like these are fine, as long as you do not put in line endings here.
    Dock  This is the last line.
   
    This is paragraph text *after* the table.
   

3. Put your cursor somewhere in the content to convert as table.

4. Press ctrl+alt+t enter (to create the table). The output will look something like this:

    This is paragraph text *before* the table.
   
    +----------+---------------------------------------------------------------------------------+
    | Column 1 | Column 2                                                                        |
    +==========+=================================================================================+
    | Hickory  | Insert two (or more) spaces as a field separator.                               |
    +----------+---------------------------------------------------------------------------------+
    | Dickory  | Long lines like these are fine, as long as you do not put in line endings here. |
    +----------+---------------------------------------------------------------------------------+
    | Dock     | This is the last line.                                                          |
    +----------+---------------------------------------------------------------------------------+
   
    This is paragraph text *after* the table.
   

5. Suppose you want to wrap long line within a cell. First break the line and place pipes to delineate the column. Then press ctrl+alt+t t (to fix the formatting).

    This is paragraph text *before* the table.
   
    +----------+---------------------------------------------------------------------------------+
    | Column 1 | Column 2                                                                        |
    +==========+=================================================================================+
    | Hickory  | Insert two (or more) spaces as a field separator.                               |
    +----------+---------------------------------------------------------------------------------+
    | Dickory  | Long lines like these are fine, as long as you do not
    |  |  put in line endings here. |
    +----------+---------------------------------------------------------------------------------+
    | Dock     | This is the last line.                                                          |
    +----------+---------------------------------------------------------------------------------+
   
    This is paragraph text *after* the table.
   

   The output will look something like this:

    This is paragraph text *before* the table.
   
    +----------+-------------------------------------------------------+
    | Column 1 | Column 2                                              |
    +==========+=======================================================+
    | Hickory  | Insert two (or more) spaces as a field separator.     |
    +----------+-------------------------------------------------------+
    | Dickory  | Long lines like these are fine, as long as you do not |
    |          | put in line endings here.                             |
    +----------+-------------------------------------------------------+
    | Dock     | This is the last line.                                |
    +----------+-------------------------------------------------------+
   
    This is paragraph text *after* the table.
   

6. If you wanted to add additional content to a cell, but not increase the width of the current table. Add your additional text to the line, then press ctrl+alt+t r to reflow and wrap text as needed.

    This is paragraph text *before* the table.
   
    +----------+-------------------------------------------------------+
    | Column 1 | Column 2                                              |
    +==========+=======================================================+
    | Hickory  | Insert two (or more) spaces as a field separator.     |
    +----------+-------------------------------------------------------+
    | Dickory  | Long lines like these are fine, as long as you do not |
    |          | put in line endings here.                             |
    +----------+-------------------------------------------------------+
    | Dock     | This is the last line. Fore score and seven years ago, the quick brown fox jumped over the lazy dogs.                               |
    +----------+-------------------------------------------------------+
   
    This is paragraph text *after* the table.
   

The output will look something like this:

>      This is paragraph text *before* the table.
>
>      +----------+------------------------------------------------------+
>      | Column 1 | Column 2                                             |
>      +==========+======================================================+
>      | Hickory  | Insert two (or more) spaces as a field separator.    |
>      +----------+------------------------------------------------------+
>      | Dickory  | Long lines like these are fine, as long as you       |
>      |          | do not put in line endings here.                     |
>      +----------+------------------------------------------------------+
>      | Dock     | This is the last line. Fore score and seven          |
>      |          | years ago, the quick brown fox jumped over the lazy  |
>      |          | dogs.                                                |
>      +----------+------------------------------------------------------+
>
>      This is paragraph text *after* the table.

Tip

Change something in the output table and run ctrl+alt+t enter again: Magically, it will be fixed.

And ctrl+alt+t r reflows the table maintaining the current column width.