m-vim_plugins/vim-table-mode
1
0
Fork 0
mirror of https://github.com/dhruvasagar/vim-table-mode.git synced 2025-11-08 11:03:47 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Reformat docs

Browse Source
This commit is contained in:
Dhruva Sagar
2024-03-14 00:02:47 +05:30
parent 319e3537de
commit 5f2f94096b
1 changed files with 393 additions and 414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

403
doc/table-mode.txt
View File

@@ -19,120 +19,119 @@ CONTENTS *table-mode-contents*
=============================================================================== ===============================================================================
INTRODUCTION *table-mode-introduction* INTRODUCTION *table-mode-introduction*
Table Mode is simple plugin that makes building tables in vim a breeze. It is Table Mode is simple plugin that makes building & manipulating tables in vim
inspired from tpope's auto aligning script for creating tables in vim - a breeze. It is inspired from tpope's auto aligning script for creating tables
https://gist.github.com/tpope/287147, which in turn utilizes the Tabular in vim - https://gist.github.com/tpope/287147, which in turn utilizes the
Plugin. Tabular Plugin
=============================================================================== ===============================================================================
GETTING STARTED *table-mode-getting-started* GETTING STARTED *table-mode-getting-started*
Create Table on the fly: Create Table on the fly:
Using Table Mode is dead simple. You simply start typing on a new line Using Table Mode is dead simple. You simply start typing on a new line
with the table separator - |table-mode-separator|, and you just type with the table separator - |table-mode-separator|, and you just type away!
away! The plugin does the rest automatically for you as you type. With The plugin does the rest automatically for you as you type. With each
each additional separator you add, it aligns the table properly, additional separator you add, it aligns the table properly, without having
without having to do anything else. to do anything else.
Table Mode now supports gfm style tables and allows to define column Table Mode now supports gfm style tables and allows to define column
alignments with the aid of placing ':' (configured using alignments with the aid of placing ':' (configured using
|g:table_mode_align_char|) on the table header border appropriately to |g:table_mode_align_char|) on the table header border appropriately to
align content left or right. align content left or right.
The table mode is disabled by default and you can enter table mode The table mode is disabled by default and you can enter table mode using
using |table-mode-toggle-map| or you can also enable it permanently |table-mode-toggle-map| or you can also enable it permanently using
using |table-mode-always-active| if you wish though not recommended. |table-mode-always-active| if you wish though not recommended.
Table Mode allows for creation of tables within comments, it looks at Table Mode allows for creation of tables within comments, it looks at
the 'commentstring' setting to identify whether the current line is the 'commentstring' setting to identify whether the current line is
commented. commented.
Tableize content: Tableize content:
Table Mode enables conversion of delimited text into tables. Again Table Mode enables conversion of delimited text into tables. Again like
like table creation, this is also applicable within comments. table creation, this is also applicable within comments.
Move between cells : Move between cells :
Now you can move between cells using table mode motions Move between cells using table mode motions `[|`, `]|`, `{|`, `}|` to move
'[|, ]|, {|, }|' to move left | down | up | right cells respectively. `left` | `down` | `up` | `right` cells respectively. The `left` | `right`
The left | right motions wrap around the table and move to the next motions wrap around the table and move to the `next` | `previous` row
| previous row after the last | first cell in the current row if one after the `last` | `first` cell in the current row if one exists.
exists.
Manipulation of tables: Manipulation of tables:
Tableize provides 3 easy ways to quickly manipulate tables. Tableize provides 3 easy ways to quickly manipulate tables.
1. Cell Text Object : A text object for table cell 1. Cell Text Object : A text object for table cell defined by
defined by |table-mode-cell-text-object|. You can use it with an |table-mode-cell-text-object|. You can use it with an operator (d,c,y)
operator (d,c,y) to manipulate it easily. If you delete the cell using to manipulate it easily. If you delete the cell using this, it will
this, it will delete the table separator along with it so if you type delete the table separator along with it so if you type out some new
out some new stuff, you will have to re-add it, which triggers a stuff, you will have to re-add it, which triggers a re-alignment and
re-alignment and the table would be formatted again. the table would be formatted again
2. Delete Column : Delete an entire table column using 2. Delete Column : Delete an entire table column using
|table-mode-delete-column-map| . |table-mode-delete-column-map|
3. Delete Row : Delete an entire table row using 3. Delete Row : Delete an entire table row using
|table-mode-delete-row-map| |table-mode-delete-row-map|
4. Insert Column : Insert a table column either before the cursor using
4. Insert Column : Insert a table column either before the cursor |table-mode-insert-column-before-map| or after the cusor using
using |table-mode-insert-column-before-map| or after the cusor using |table-mode-insert-column-after-map|
|table-mode-insert-column-after-map|.
*table-formulas* *table-formulas*
Table Formulas: Table Formulas:
Table Mode now has support for formulas like a spreadsheet. There Table Mode now has support for formulas like a spreadsheet. There are
are 2 ways of defining formulas : 2 ways of defining formulas :
You can add formulas using |:TableAddFormula| or the mapping You can add formulas using |:TableAddFormula| or the mapping
|<Leader>tfa| defined by the option |<Leader>tfa| defined by the option |table-mode-add-formula-map| from
|table-mode-add-formula-map| from within a table cell, which within a table cell, which will ask for input on the cmd-line with a `f=`
will ask for input on the cmd-line with a 'f=' prompt. The prompt. The input formula will be appended to the formula line if one
input formula will be appended to the formula line if one exists or a new one will be created with the input formula taking the
exists or a new one will be created with the input formula current cell as the target cell. The formula line is evaluated immediately
taking the current cell as the target cell. The formula line to reflect the results.
is evaluated immediately to reflect the results.
You can directly also add / manipulate formula expressions in You can directly also add / manipulate formula expressions in the
the formula line. The formula line is a commented line right formula line. The formula line is a commented line right after the table,
after the table, beginning with 'tmf:' (table mode formula). beginning with `tmf:` (table mode formula). eg) `# tmf: $3=$2*$1`. You
eg) '# tmf: $3=$2*$1'. You can add multiple formulas on the can add multiple formulas on the line separated with a `;`
line separated with a ';' eg) '# tmf: $3=$2*$1;$4=$3/3.14' eg) `# tmf: $3=$2*$1;$4=$3/3.14`
You can evaluate the formula line using |:TableEvalFormulaLine| or the You can evaluate the formula line using |:TableEvalFormulaLine| or the
mapping |<Leader>tfe| defined by the option |table-mode-expr-calc-map| mapping |<Leader>tfe| defined by the option |table-mode-expr-calc-map|
*formula-expressions* *formula-expressions*
Formula Expressions : Formula Expressions :
Expressions are of the format '$target = formula'. Expressions are of the format `$target = formula`.
The target can be of 2 forms: The target can be of 2 forms:
'$n': This matches the table column number 'n'. So the formula 1. `n`: This matches the table column number `n`. So the formula would
would be evaluated for each cell in that column and the result be evaluated for each cell in that column and the result would be
would be placed in it. You can use negative indice to placed in it. You can use negative indice to represent column
represent column relative to the last, -1 being the last. relative to the last, -1 being the last.
2. `$n,m`: This matches the table cell `n`, `m` (row, column). So in
this case the formula would be evaluated and the result will be
placed in this cell. You can also use negative values to refer to
cells relative to the size, -1 being the last (row or column).
'$n,m': This matches the table cell n,m (row, column). So in The formula can be a simple mathematical expression involving cells which
this case the formula would be evaluated and the result will are also defined by the same format as that of the target cell. Apart from
be placed in this cell. You can also use negative values to basic mathematical expressions, table mode also provides special functions
refer to cells relative to the size, -1 being the last (row or
column).
The formula can be a simple mathematical expression involving cells - `Min`
which are also defined by the same format as that of the target cell. - `Max`
Apart from basic mathematical expressions, table mode also provides - `CountE` (number of empty cells)
special functions 'Min', 'Max', 'CountE' (number of empty cells), - `CountNE` (number of non-empty cells)
'CountNE' (number of non-empty cells), 'PercentE' (percent of empty - `PercentE` (percent of empty cells)
cells), 'PercentNE' (percent of non-empty cells), 'Sum', 'Average', - `PercentNE` (percent of non-empty cells)
and 'AverageNE' (average over non-empty cells). All these functions - `Sum`
take a range as input. A range can be of two forms : - `Average`
- `AverageNE` (average over non-empty cells)
'n:m': This represents cells in the current column from row All these functions take a range as input. A range can be of two forms:
'n' through 'm'. If 'm' is negative it represents 'm' row
above the current row (of the target cell).
'r1,c1:r2,c2': This represents cells in the table from cell 1. `n:m`: This represents cells in the current column from row `n`
r1,c1 through cell r2,c2 (row, column). through `m`. If `m` is negative it represents `m` row above the
current row (of the target cell).
2. `r1,c1:r2,c2`: This represents cells in the table from cell `r1,c1`
through cell `r2,c2` (row, column).
Examples : Examples :
$2 = $1 * $1 $2 = $1 * $1
@@ -145,54 +144,50 @@ Formula Expressions :
OPTIONS *table-mode-options* OPTIONS *table-mode-options*
Overview: Overview:
|table-mode-loaded| ............. Disable the plugin. |table-mode-loaded| .................... Disable the plugin
|table-mode-verbose| ............ Notify when Enabled/Disabled. |table-mode-verbose| ................... Notify when Enabled/Disabled
|table-mode-disable-mappings| ... Disable default mappings. |table-mode-disable-mappings| .......... Disable default mappings
|table-mode-disable-tableize-mappings| |table-mode-disable-tableize-mappings| . Disable tableize mappings
Disable tableize mappings. |table-mode-corner| .................... Set corner character
|table-mode-corner| ............. Set corner character. |table-mode-separator| ................. Set separator character
|table-mode-separator| .......... Set separator character. |table-mode-separator-map| ............. Set separator mapping
|table-mode-separator-map| ...... Set separator mapping. |table-mode-fillchar| .................. Set table border fillchar character
|table-mode-fillchar| ........... Set table border fillchar character. |table-mode-header-fillchar| ........... Set table header border fillchar
|table-mode-header-fillchar| .... Set table header border fillchar character. character
|table-mode-map-prefix| ......... Set prefix for table mode commands. |table-mode-map-prefix| ................ Set prefix for table mode commands
|table-mode-toggle-map| ......... Set table mode toggle mapping. |table-mode-toggle-map| ................ Set table mode toggle mapping
|table-mode-always-active| ...... Set table mode to always enabled. |table-mode-always-active| ............. Set table mode to always enabled
|table-mode-delimiter| .......... Set the delimiter for Tableize. |table-mode-delimiter| ................. Set the delimiter for Tableize
|table-mode-corner-corner| ...... Set the character to be used for |table-mode-corner-corner| ............. Set the character to be used for
extreme corners of the table border. extreme corners of the table border
|table-mode-align-char|.......... Set the alignment character which |table-mode-align-char|................. Set the alignment character which
can be added to the table header can be added to the table header
border to control alignment of that border to control alignment of that
column. column
|table-mode-motion-up-map| ...... Set the table motion up mapping |table-mode-motion-up-map| ............. Set the table motion up mapping
|table-mode-motion-down-map| .... Set the table motion down mapping |table-mode-motion-down-map| ........... Set the table motion down mapping
|table-mode-motion-left-map| .... Set the table motion left mapping |table-mode-motion-left-map| ........... Set the table motion left mapping
|table-mode-motion-right-map| ... Set the table motion right mapping |table-mode-motion-right-map| .......... Set the table motion right mapping
|table-mode-cell-text-object-a-map| |table-mode-cell-text-object-a-map| .... Set the 'a' cell text object
Set the 'a' cell text object
mapping mapping
|table-mode-cell-text-object-i-map| |table-mode-cell-text-object-i-map| .... Set the 'i' cell text object
Set the 'i' cell text object
mapping mapping
|table-mode-realign-map| ........ Set the realign mapping |table-mode-realign-map| ............... Set the realign mapping
|table-mode-delete-row-map| ..... Set the delete row mapping |table-mode-delete-row-map| ............ Set the delete row mapping
|table-mode-delete-column-map| .. Set the delete column mapping |table-mode-delete-column-map| ......... Set the delete column mapping
|table-mode-insert-column-before-map| |table-mode-insert-column-before-map| .. Set the insert column before the
Set the insert column before the
cursor mapping cursor mapping
|table-mode-insert-column-after-map| |table-mode-insert-column-after-map| ... Set the insert column after the
Set the insert column after the
cursor mapping cursor mapping
|table-mode-add-formula-map| .... Set the add formula mapping |table-mode-add-formula-map| ........... Set the add formula mapping
|table-mode-eval-formula-map| ... Set the eval formula mapping |table-mode-eval-formula-map| .......... Set the eval formula mapping
|table-mode-echo-cell-map| ...... Set the echo cell mapping |table-mode-echo-cell-map| ............. Set the echo cell mapping
|table-mode-sort-map| ........... Set the table sort mapping |table-mode-sort-map| .................. Set the table sort mapping
|table-mode-syntax| ............. Control table mode syntax |table-mode-syntax| .................... Control table mode syntax
|table-mode-auto-align| ......... Set if the table mode should auto |table-mode-auto-align| ................ Set if the table mode should auto
align as you type align as you type
|table-mode-tableize-auto-border| Set if tableize adds row borders |table-mode-tableize-auto-border| ...... Set if tableize adds row borders
|table-mode-ignore-align| ....... Set to ignore alignment characters |table-mode-ignore-align| .............. Set to ignore alignment characters
g:loaded_table_mode *table-mode-loaded* g:loaded_table_mode *table-mode-loaded*
Use this option to disable the plugin: > Use this option to disable the plugin: >
@@ -205,11 +200,6 @@ g:table_mode_verbose *table-mode-verbose*
g:table_mode_disable_mappings *table-mode-disable-mappings* g:table_mode_disable_mappings *table-mode-disable-mappings*
Use this option to disable default mappings: > Use this option to disable default mappings: >
let g:table_mode_disable_mappings = 1 let g:table_mode_disable_mappings = 1
<
*table-mode-disable-tableize-mappings*
g:table_mode_disable_tableize_mappings
Use this option to disable tableize mappings: >
let g:table_mode_disable_tableize_mappings = 1
< <
g:table_mode_corner *table-mode-corner* g:table_mode_corner *table-mode-corner*
Use this option to define the table corner character: > Use this option to define the table corner character: >
@@ -222,49 +212,45 @@ g:table_mode_separator *table-mode-separator*
Use this option to define the table column separator character: > Use this option to define the table column separator character: >
let g:table_mode_separator = '|' let g:table_mode_separator = '|'
< <
This option also defines the trigger to be used to start creating a This option also defines the trigger to be used to start creating a table
table row in insert mode. row in insert mode.
g:table_mode_separator_map *table-mode-separator-map* g:table_mode_separator_map *table-mode-separator-map*
Use this option to define the mapping to be used for the table separator. > Use this option to define the mapping to be used for the table separator. >
let g:table_mode_separator_map = '<Bar>' let g:table_mode_separator_map = '<Bar>'
< <
g:table_mode_fillchar *table-mode-fillchar* g:table_mode_fillchar *table-mode-fillchar*
Use this option to define the table border fill character: > Use this option to define the table border fill character: >
let g:table_mode_fillchar = '-' let g:table_mode_fillchar = '-'
< <
g:table_mode_header_fillchar *table-mode-header-fillchar* g:table_mode_header_fillchar *table-mode-header-fillchar*
Use this option to define the table header border fill character: > Use this option to define the table header border fill character: >
let g:table_mode_fillchar = '-' let g:table_mode_fillchar = '-'
< <
g:table_mode_map_prefix *table-mode-map-prefix* g:table_mode_map_prefix *table-mode-map-prefix*
Use this option to define the table mode mapping prefix that will be Use this option to define the table mode mapping prefix that will be
prefixed for all other table mode mappings. > prefixed for all other table mode mappings. >
let g:table_mode_map_prefix = '<Leader>t' let g:table_mode_map_prefix = '<Leader>t'
< <
g:table_mode_toggle_map *table-mode-toggle-map* g:table_mode_toggle_map *table-mode-toggle-map*
Use this option to define the mapping for toggling the table mode: > Use this option to define the mapping for toggling the table mode: >
let g:table_mode_toggle_map = 'm' let g:table_mode_toggle_map = 'm'
< <
Read |table-mode-mappings-toggle| for more info. Read |table-mode-mappings-toggle| for more info.
NOTE you will need to use the |table-mode-map-prefix| before this to NOTE: you will need to use the |table-mode-map-prefix| before this to get
get the desired effect. the desired effect.
g:table_mode_always_active *table-mode-always-active* g:table_mode_always_active *table-mode-always-active*
Use this option to permanently enable the table mode: > Use this option to permanently enable the table mode: >
let g:table_mode_always_active = 0 let g:table_mode_always_active = 0
< <
This will trigger table creation once you type the This will trigger table creation once you type the |table-mode-separator|
|table-mode-separator| as long as it's the first character on as long as it's the first character on the line, which can be annoying.
the line, which can be annoying. I recommend you to instead use the I recommend you to instead use the |table-mode-mappings-toggle| or
|table-mode-mappings-toggle| or |table-mode-commands-toggle| to toggle |table-mode-commands-toggle| to toggle the table mode or
the table mode or |table-mode-commands-enable| to enable and |table-mode-commands-enable| to enable and |table-mode-commands-disable|
|table-mode-commands-disable| to disable mode when needed. to disable mode when needed.
g:table_mode_delimiter *table-mode-delimiter* g:table_mode_delimiter *table-mode-delimiter*
Use this option to define the delimiter which used by Use this option to define the delimiter which used by
@@ -310,8 +296,8 @@ g:table_mode_cell_text_object_a_map *table-mode-cell-text-object-a-map*
let g:table_mode_cell_text_object_a_map = 'a<Bar>' let g:table_mode_cell_text_object_a_map = 'a<Bar>'
> >
g:table_mode_cell_text_object_i_map *table-mode-cell-text-object-i-map* g:table_mode_cell_text_object_i_map *table-mode-cell-text-object-i-map*
Set this to configure the mapping to define the text object for inner Set this to configure the mapping to define the text object for inner cell
cell object. > object. >
let g:table_mode_cell_text_object_i_map = 'i<Bar>' let g:table_mode_cell_text_object_i_map = 'i<Bar>'
> >
g:table_mode_realign_map *table-mode-realign-map* g:table_mode_realign_map *table-mode-realign-map*
@@ -327,18 +313,17 @@ g:table_mode_delete_column_map *table-mode-delete-column-map*
let g:table_mode_delete_column_map = '<Leader>tdc' let g:table_mode_delete_column_map = '<Leader>tdc'
> >
g:table_mode_insert_column_before_map *table-mode-insert-column-before-map* g:table_mode_insert_column_before_map *table-mode-insert-column-before-map*
Set this to configure the mapping for inserting a table column before Set this to configure the mapping for inserting a table column before the
the cursor. > cursor. >
let g:table_mode_insert_column_before_map = '<Leader>tiC' let g:table_mode_insert_column_before_map = '<Leader>tiC'
> >
g:table_mode_insert_column_after_map *table-mode-insert-column-after-map* g:table_mode_insert_column_after_map *table-mode-insert-column-after-map*
Set this to configure the mapping for inserting a table column after Set this to configure the mapping for inserting a table column after the
the cursor. > cursor. >
let g:table_mode_insert_column_after_map = '<Leader>tic' let g:table_mode_insert_column_after_map = '<Leader>tic'
> >
g:table_mode_add_formula_map *table-mode-add-formula-map* g:table_mode_add_formula_map *table-mode-add-formula-map*
Set this to configure the mapping for adding a formula for a table Set this to configure the mapping for adding a formula for a table cell. >
cell. >
let g:table_mode_add_formula_map = '<Leader>tfa' let g:table_mode_add_formula_map = '<Leader>tfa'
> >
g:table_mode_eval_formula_map *table-mode-eval-formula-map* g:table_mode_eval_formula_map *table-mode-eval-formula-map*
@@ -346,53 +331,48 @@ g:table_mode_eval_formula_map *table-mode-eval-formula-map*
let g:table_mode_eval_formula_map = '<Leader>tfe' let g:table_mode_eval_formula_map = '<Leader>tfe'
> >
g:table_mode_echo_cell_map *table-mode-echo-cell-map* g:table_mode_echo_cell_map *table-mode-echo-cell-map*
Set this to configure the mapping for echoing the tablemode Set this to configure the mapping for echoing the tablemode representation
representation of the current cell. > of the current cell. >
let g:table_mode_echo_cell_map = '<Leader>t?' let g:table_mode_echo_cell_map = '<Leader>t?'
> >
g:table_mode_sort_map *table-mode-sort-map* g:table_mode_sort_map *table-mode-sort-map*
Set this to configure the mapping for sorting the table mode by Set this to configure the mapping for sorting the table mode by current
current column. > column. >
let g:table_mode_sort_map = '<Leader>ts' let g:table_mode_sort_map = '<Leader>ts'
> >
g:table_mode_tableize_map *table-mode-tableize-map* g:table_mode_tableize_map *table-mode-tableize-map*
Set this to configure the mapping for converting the visual selection Set this to configure the mapping for converting the visual selection to
to a table. > a table. >
let g:table_mode_tableize_map = '<Leader>tt' let g:table_mode_tableize_map = '<Leader>tt'
> >
g:table_mode_tableize_d_map *table-mode-tableize-d-map* g:table_mode_tableize_d_map *table-mode-tableize-d-map*
Set this to configure the mapping for converting the visual selection Set this to configure the mapping for converting the visual selection to
to a table, asking the user for a delimiter. > a table, asking the user for a delimiter. >
let g:table_mode_tableize_d_map = '<Leader>T' let g:table_mode_tableize_d_map = '<Leader>T'
> >
g:table_mode_syntax *table-mode-syntax* g:table_mode_syntax *table-mode-syntax*
Control whether table mode should define table syntax definitions or Control whether table mode should define table syntax definitions or not. >
not. >
let g:table_mode_syntax = 1 let g:table_mode_syntax = 1
< <
g:table_mode_auto_align *table-mode-auto-align* g:table_mode_auto_align *table-mode-auto-align*
Set if the table mode should auto align as you type when table mode is Set if the table mode should auto align as you type when table mode is
active. > active. >
let g:table_mode_auto_align = 1 let g:table_mode_auto_align = 1
<
g:table_mode_update_time *table-mode-update-time* g:table_mode_update_time *table-mode-update-time*
Set the value of updatetime to be used when table mode is active, Set the value of updatetime to be used when table mode is active, used in
used in combination with |table-mode-auto-align|. > combination with |table-mode-auto-align|. >
let g:table_mode_update_time = 500 let g:table_mode_update_time = 500
< <
g:table_mode_disable_tableize_mappings *table-mode-disable-tableize-mappings* g:table_mode_disable_tableize_mappings *table-mode-disable-tableize-mappings*
Disables mappings for tableize. > Disables mappings for tableize. >
let g:table_mode_disable_tableize_mappings = 0 let g:table_mode_disable_tableize_mappings = 0
< <
*table-mode-tableize-auto-border* g:table_mode_tableize_auto_border *table-mode-tableize-auto-border*
g:table_mode_tableize_auto_border
Enables adding row borders to tables when created using tableize. > Enables adding row borders to tables when created using tableize. >
let g:table_mode_tableize_auto_border = 0 let g:table_mode_tableize_auto_border = 0
< <
*table-mode-ignore-align* g:table_mode_ignore_align *table-mode-ignore-align*
g:table_mode_ignore_align
If enabled, ignores alignment characters on the header border and always If enabled, ignores alignment characters on the header border and always
left aligns. > left aligns. >
let g:table_mode_ignore_align = 0 let g:table_mode_ignore_align = 0
@@ -402,77 +382,76 @@ g:table_mode_ignore_align
MAPPINGS *table-mode-mappings* MAPPINGS *table-mode-mappings*
*table-mode-mappings-prefix* *table-mode-mappings-prefix*
<Leader>t This is a prefix defined by the option |table-mode-map-prefix| `<Leader>t`: This is a prefix defined by the option
used before all other table mode commands. |table-mode-map-prefix| used before all other table mode commands
*table-mode-mappings-toggle* *table-mode-mappings-toggle*
<Leader>tm Toggle table mode for the current buffer. You can change this `<Leader>tm`: Toggle table mode for the current buffer. You can change
using the |toggle-mode-options-toggle-map| option. this using the |toggle-mode-options-toggle-map| option
NOTE This is applicable only if |table-mode-always-active| is NOTE: This is applicable only if |table-mode-always-active| is not set
not set.
*table-mode-mappings-trigger* *table-mode-mappings-trigger*
| Trigger table creation in table mode. You can change this `|`: Trigger table creation in table mode. You can change this
using the |toggle-mode-options-separator| option. using the |toggle-mode-options-separator| option
<Leader>tt Triggers |table-mode-commands-tableize| on the visually *table-mode-mappings-tableize*
selected content. `<Leader>tt`: Triggers |table-mode-commands-tableize| on the visually
selected content
*table-mode-mappings-op-trigger* *table-mode-mappings-op-trigger*
<Leader>T Triggers |table-mode-commands-tableize| on the visually `<Leader>T`: Triggers |table-mode-commands-tableize| on the visually
selected asking for user to input the delimiter. selected asking for user to input the delimiter
*table-mode-mappings-realign* *table-mode-mappings-realign*
<Leader>tr Realigns table columns `<Leader>tr`: Realigns table columns
<Leader>t? Echo the current table cells representation for defining `<Leader>t?`: Echo the current table cells representation for defining
formulas. formulas
*table-mode-mappings-motions* *table-mode-mappings-motions*
[| Move to previous cell `[|`: Move to previous cell
]| Move to next cell `]|`: Move to next cell
{| Move to the cell above `{|`: Move to the cell above
}| Move to the cell below `}|`: Move to the cell below
*table-mode-mappings-delete-row* *table-mode-mappings-delete-row*
<Leader>tdd Delete the entire table row you are on or multiple rows using `<Leader>tdd`: Delete the entire table row you are on or multiple rows using
a [count]. You can change this using |table-mode-delete-row-map| a [count]. You can change this using |table-mode-delete-row-map| option
option.
*table-mode-mappings-delete-column* *table-mode-mappings-delete-column*
<Leader>tdc Delete entire table column you are within. You can preceed it `<Leader>tdc`: Delete entire table column you are within. You can preceed it
with a [count] to delete multiple columns to the right. You with a [count] to delete multiple columns to the right. You can change this
can change this using |table-mode-delete-column-map| option. using |table-mode-delete-column-map| option.
*table-mode-mappings-insert-column-before* *table-mode-mappings-insert-column-before*
<Leader>tiC Insert a table column before the column you are within. You can `<Leader>tiC`: Insert a table column before the column you are within. You
preceed it with a [count] to insert multiple columns. You can can preceed it with a [count] to insert multiple columns. You can change
change this using |table-mode-insert-column-before-map| option. this using |table-mode-insert-column-before-map| option.
*table-mode-mappings-insert-column-after* *table-mode-mappings-insert-column-after*
<Leader>tic Insert a table column after the column you are within. You can `<Leader>tic`: Insert a table column after the column you are within. You
preceed it with a [count] to insert multiple columns. You can can preceed it with a [count] to insert multiple columns. You can change
change this using |table-mode-insert-column-after-map| option. this using |table-mode-insert-column-after-map| option.
*table-mode-mappings-add-formula* *table-mode-mappings-add-formula*
<Leader>tfa Add a fomula for the current table cell. This invokes `<Leader>tfa`: Add a fomula for the current table cell. This invokes
|TableAddFormula| command. |TableAddFormula| command.
*table-mode-mappings-evaluate-formula-line* *table-mode-mappings-evaluate-formula-line*
<Leader>tfe Evaluate the formula line which is a commented line right `<Leader>tfe`: Evaluate the formula line which is a commented line right
after the table beginning with 'tmf:'. If one exists this after the table beginning with 'tmf:'. If one exists this would evaluate the
would evaluate the formula line and update the table formula line and update the table accordingly. This invokes the
accordingly. This invokes the |TableEvalFormulaLine| command. |TableEvalFormulaLine| command.
*table-mode-mappings-sort-column* *table-mode-mappings-sort-column*
<Leader>ts Sort a column under the cursor. This invokes |TableSort| `<Leader>ts`: Sort a column under the cursor. This invokes |TableSort|
|| Expands to a header border. You can change this by changing `||`: Expands to a header border. You can change this by changing
|table-mode-separator| option. You can change the character to |table-mode-separator| option. You can change the character to be used for
be used for the extreme corners of the border by changing the extreme corners of the border by changing |table-mode-corner-corner|
|table-mode-corner-corner| option. option.
=============================================================================== ===============================================================================
COMMANDS *table-mode-commands* COMMANDS *table-mode-commands*
@@ -505,17 +484,17 @@ COMMANDS *table-mode-commands*
*table-mode-:Tableize* *table-mode-:Tableize*
:Tableize :Tableize
This converts the current line into a table if it consists of This converts the current line into a table if it consists of
|table-mode-delimiter|. This accepts a range, without which it |table-mode-delimiter|. This accepts a range, without which it applies on
applies on the current line. the current line.
This accepts a {pattern} similar to Tabular which defines the This accepts a {pattern} similar to Tabular which defines the delimiter.
delimiter. eg.) > eg.) >
:Tableize/; :Tableize/;
< <
The above command will Tableize using ';' as the delimiter. The above command will Tableize using ';' as the delimiter.
NOTE this is optional, by default without the expression it will NOTE this is optional, by default without the expression it will tableize
tableize the content using |table-mode-delimiter| as the delimiter. the content using |table-mode-delimiter| as the delimiter.
*:TableModeRealign* *:TableModeRealign*
*table-mode-:TableModeRealign* *table-mode-:TableModeRealign*
@@ -525,31 +504,31 @@ COMMANDS *table-mode-commands*
*:TableAddFormula* *:TableAddFormula*
*table-mode-:TableAddFormula* *table-mode-:TableAddFormula*
:TableAddFormula :TableAddFormula
This command is for defining a formula for the current table cell. It This command is for defining a formula for the current table cell. It takes
takes input on the cmd-line with a 'f=' prompt and appends it to the input on the cmd-line with a 'f=' prompt and appends it to the formula line
formula line if it exists or adds a new formula line with the if it exists or adds a new formula line with the expression using the
expression using the current cell as the target and the input formula. current cell as the target and the input formula.
*:TableEvalFormulaLine* *:TableEvalFormulaLine*
*table-mode-:TableEvalFormulaLine* *table-mode-:TableEvalFormulaLine*
:TableEvalFormulaLine :TableEvalFormulaLine
This command when invoked from anywhere within the table or directly This command when invoked from anywhere within the table or directly on the
on the formula line evaluates it and updates the table accordingly. formula line evaluates it and updates the table accordingly.
*:TableSort* *:TableSort*
*table-mode-:TableSort* *table-mode-:TableSort*
:TableSort[!] [i][u][r][n][x][o] :TableSort[!] [i][u][r][n][x][o]
This command sorts column under the cursor and inherits the same flags This command sorts column under the cursor and inherits the same flags as
as the |:sort| command. the |:sort| command.
With [!] the order is reversed. With [!] the order is reversed.
=============================================================================== ===============================================================================
CONTRIBUTING *table-mode-contributing* CONTRIBUTING *table-mode-contributing*
If you want to take a stab at it, by all means, send me a pull request on If you want to take a stab at it, by all means, send me a pull request on Github
Github (http://github.com/dhruvasagar/vim-table-mode) or get in touch with me (http://github.com/dhruvasagar/vim-table-mode) or get in touch with me directly
directly via e-mail at dhruva 'dot' sagar 'at' gmail.com. via e-mail at dhruva 'dot' sagar 'at' gmail.com.
=============================================================================== ===============================================================================
REPORT ISSUES *table-mode-report-issues* REPORT ISSUES *table-mode-report-issues*