mirror of
https://github.com/dhruvasagar/vim-table-mode.git
synced 2025-11-08 11:03:47 -05:00
Compare commits
31 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9875a117a7 | ||
|
|
cca55e72ce | ||
|
|
eed25aee91 | ||
|
|
0683cec58c | ||
|
|
27544e168a | ||
|
|
e4af7200ff | ||
|
|
3cea0bbaba | ||
|
|
8931891845 | ||
|
|
0810512c54 | ||
|
|
4606d9c637 | ||
|
|
9ff1b37210 | ||
|
|
287f45cfa2 | ||
|
|
1ce3ec4e7f | ||
|
|
34e271b24a | ||
|
|
d0d9d1d4f6 | ||
|
|
41fa837437 | ||
|
|
fb63484e47 | ||
|
|
51c108188c | ||
|
|
974d506484 | ||
|
|
dd38fcfeeb | ||
|
|
94a76dc0f7 | ||
|
|
eba2481798 | ||
|
|
edfb221b3e | ||
|
|
e9d9030cbb | ||
|
|
2bde444575 | ||
|
|
def9a08623 | ||
|
|
57a49efe7e | ||
|
|
af55d03e14 | ||
|
|
cb21c1626c | ||
|
|
4e8e87256b | ||
|
|
88edc35ea6 |
12
CHANGELOG.md
12
CHANGELOG.md
@@ -1,4 +1,16 @@
|
|||||||
# Change Log
|
# Change Log
|
||||||
|
## Version 3.1
|
||||||
|
* Removed borders. You can now optionally create a table header by simply
|
||||||
|
adding a header border immidiately after the header line by using the
|
||||||
|
iabbrev trigger '+-'. Just type that on the line immidiately after the
|
||||||
|
header and press space / \<CR\> to complete the header border.
|
||||||
|
* Some Bug Fixes
|
||||||
|
|
||||||
|
## Version 3.0
|
||||||
|
* Removed dependence on Tabular and added code borrowed from Tabular for
|
||||||
|
aligning the table rows.
|
||||||
|
* Added feature to be able to define & evaluate formulas.
|
||||||
|
|
||||||
## Version 2.4.0
|
## Version 2.4.0
|
||||||
* Added Table Cell text object.
|
* Added Table Cell text object.
|
||||||
* Added api to delete entire table row.
|
* Added api to delete entire table row.
|
||||||
|
|||||||
159
README.md
159
README.md
@@ -26,42 +26,146 @@ $ git submodule add git@github.com:dhruvasagar/vim-table-mode.git bundle/table-m
|
|||||||
vimfiles/autoload/, vimfiles/plugin/ and vimfiles/doc under WINDOWS and
|
vimfiles/autoload/, vimfiles/plugin/ and vimfiles/doc under WINDOWS and
|
||||||
restart VIM
|
restart VIM
|
||||||
|
|
||||||
### Requirements
|
|
||||||
|
|
||||||
Depends on <a href="https://github.com/godlygeek/tabular">Tabular</a>. Make
|
|
||||||
sure Tabular is installed and loaded into your runtime to ensure this works.
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
- On the fly table creation :
|
- **On the fly table creation** :
|
||||||
|
|
||||||
By default the table column separator is '|' (it can be changed). As soon as
|
By default the table column separator is `|` defined by the
|
||||||
you type it on a new line (ignores indentation) the script gets to work on
|
`g:table_mode_separator` option. As soon as you type it on a new line (ignores
|
||||||
creating a table around it. As you type and define more columns, the table
|
indentation) the script gets to work on creating a table around it. As you
|
||||||
is completed, formatted and aligned automatically on the fly.
|
type and define more columns, the table is completed, formatted and aligned
|
||||||
|
automatically on the fly.
|
||||||
|
|
||||||
Since this could lead to unwanted behavior I have disabled table mode by
|
Since this could lead to unwanted behavior I have disabled table mode by
|
||||||
default. You would have to use `:TableModeToggle` command or the table mode
|
default. You have to use `:TableModeToggle` command or the table mode
|
||||||
toggle mapping, which is `<Leader>tm` by default to toggle the table mode or
|
toggle mapping, which is `<Leader>tm` defined by `g:table_mode_toggle_map`
|
||||||
you can directly use `:TableModeEnable` and `:TableModeDisable` to enable or
|
option to toggle the table mode or you can directly use `:TableModeEnable`
|
||||||
disable the table mode. This is on a per buffer basis and so it does not
|
and `:TableModeDisable` to enable or disable the table mode. This is on a
|
||||||
cause any unusual behavior unless enabled explicitly. Please read `:h
|
per buffer basis and so it does not cause any unusual behavior unless it is
|
||||||
table-mode` for further information.
|
enabled explicitly. Please read `:h table-mode` for further information.
|
||||||
- Format existing content into a table :
|
|
||||||
|
- **Format existing content into a table** :
|
||||||
|
|
||||||
Table Mode wouldn't justify it's name if it didn't allow formatting
|
Table Mode wouldn't justify it's name if it didn't allow formatting
|
||||||
existing content into a table. And it does as promised. Like table creation
|
existing content into a table. And it does as promised. Like table creation
|
||||||
on the fly as you type, formatting existing content into a table is equally
|
on the fly as you type, formatting existing content into a table is equally
|
||||||
simple. You can visually select multiple lines and call `:Tableize` on it, or
|
simple. You can visually select multiple lines and call `:Tableize` on it,
|
||||||
alternatively use the mapping `<Leader>T` (this is configurable). `:Tableize`
|
or alternatively use the mapping `<Leader>tt` defined by the
|
||||||
accepts a range and so you can also call it by giving lines manually like
|
`g:table_mode_tableize_map` option which would convert CSV (Comma Separated
|
||||||
`:line1,line2Tableize`, but this is not that intuitive. You can also use
|
Value) data into a table and use `,` defined by `g:table_mode_delimiter`
|
||||||
the mapping `<Leader>T` with a `[count]` to apply it to the next `[count]`
|
option as the delimiter.
|
||||||
lines in usual vim style.
|
|
||||||
- Move between cells :
|
|
||||||
|
|
||||||
Now you can move between cells using table mode motions. Check `:h
|
If however you wish to use a different delimiter, you can use the command
|
||||||
table-mode-motion-prefix` for more details.
|
`:Tableize/{pattern}` in a similar fashion as you use tabular (eg.
|
||||||
|
`:Tableize/;` uses ';' as the delimiter) or use the mapping `<Leader>T`
|
||||||
|
defined by `g:table_mode_tableize_op_map` option which takes input in the
|
||||||
|
cmd-line and uses the `{pattern}` input as the delimiter.
|
||||||
|
|
||||||
|
`:Tableize` also accepts a range and so you can also call it by giving
|
||||||
|
lines manually like `:line1,line2Tableize`, but this is not very intuitive.
|
||||||
|
You can use the mapping `<Leader>T` with a `[count]` to apply it to the
|
||||||
|
next `[count]` lines in standard vim style.
|
||||||
|
|
||||||
|
- **Move between cells** :
|
||||||
|
|
||||||
|
Now you can move between cells using table mode motions `<Leader>t[hjkl]`
|
||||||
|
to move left | down | up | right cells respectively. You can use
|
||||||
|
`g:table_mode_map_prefix` option to define the prefix mapping to be used
|
||||||
|
before 'hjkl'. The left | right motions wrap around the table and move to
|
||||||
|
the next | previous row after the last | first cell in the current row if
|
||||||
|
one exists.
|
||||||
|
|
||||||
|
- **Manipulating Table** :
|
||||||
|
|
||||||
|
- **Cell Text Object** :
|
||||||
|
|
||||||
|
Tableize provides a text object for manipulating table cells. By default
|
||||||
|
it's `tc`, but that can be changed if you wish to by setting the
|
||||||
|
`g:table_mode_cell_text_object` option.
|
||||||
|
|
||||||
|
This is intelligent in the sense that if you use it to delete the
|
||||||
|
contents it will delete everything till the `g:table_mode_separator` so
|
||||||
|
that the cell is removed and you can enter new stuff if you wish to (had
|
||||||
|
you used 'c' operator), having to input the `g:table_mode_separator`
|
||||||
|
again to form the cell & realign it (since it can't be done from the
|
||||||
|
text object itself). However if you were to 'y' or yank the text, it
|
||||||
|
would copy the right text, i.e. the contents of the cell and nothing
|
||||||
|
else.
|
||||||
|
|
||||||
|
- **Delete Row** :
|
||||||
|
|
||||||
|
You can use the `<Leader>tdd` mapping defined by the option
|
||||||
|
`g:table_mode_delete_row_map` to delete the current table row (provided
|
||||||
|
you are within a table row), this can be preceeded with a [count] to
|
||||||
|
delete multiple rows just like you would with 'dd'.
|
||||||
|
|
||||||
|
- **Delete Column** :
|
||||||
|
|
||||||
|
You can use the `<Leader>tdc` mapping defined by the option
|
||||||
|
`g:table_mode_delete_column_map` to delete the entire current column
|
||||||
|
(provided you are within a table row), this can also be preceeded with a
|
||||||
|
[count] to delete multiple columns.
|
||||||
|
|
||||||
|
- **Table Formulas** :
|
||||||
|
|
||||||
|
Table Mode now has support for formulas like a spreadsheet. There are 2 ways
|
||||||
|
of defining formulas :
|
||||||
|
|
||||||
|
- You can add formulas using `:TableAddFormula` or the mapping `<Leader>tfa`
|
||||||
|
defined by the option `g:table_mode_add_formula_map` from within a table
|
||||||
|
cell, which will ask for input on the cmd-line with a `f=` prompt. The
|
||||||
|
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 current cell as the
|
||||||
|
target cell. The formula line is evaluated immidiately to reflect the
|
||||||
|
results.
|
||||||
|
|
||||||
|
- You can directly add / manipulate formula expressions in the formula line.
|
||||||
|
The formula line is a commented line right after the table, beginning with
|
||||||
|
'tmf:' (table mode formula). eg) `# tmf: $3=$2*$1`. You can add multiple
|
||||||
|
formulas on the line separated with a ';' eg) `# tmf: $3=$2*$1;$4=$3/3.14`
|
||||||
|
|
||||||
|
You can evaluate the formula line using `:TableEvalFormulaLine` or the
|
||||||
|
mapping `<Leader>tfe` defined by the option `g:table_mode_eval_expr_map`
|
||||||
|
from anywhere inside the table or while on the formula line.
|
||||||
|
|
||||||
|
- **Formula Expressions** :
|
||||||
|
|
||||||
|
Expressions are of the format `$target = formula`.
|
||||||
|
|
||||||
|
- The `target` can be of 2 forms :
|
||||||
|
|
||||||
|
- `$n`: This matches the table column number `n`. So the `formula` would
|
||||||
|
be evaluated for each cell in that column and the result would be placed
|
||||||
|
in it.
|
||||||
|
|
||||||
|
- `$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.
|
||||||
|
|
||||||
|
- The `formula` can be a simple mathematical expression involving cells
|
||||||
|
which are also defined by the same format as that of the target cell. You
|
||||||
|
can use all native vim functions within the formula. Apart from that table
|
||||||
|
mode also provides 2 special functions `Sum` and `Average`. Both these
|
||||||
|
functions take a range as input. A range can be of two forms :
|
||||||
|
|
||||||
|
- `r1,r2`: This represents cells in the current column from row `r1`
|
||||||
|
through `r2`. If `r2` is negative it represents `r2` rows above the
|
||||||
|
current row (of the target cell).
|
||||||
|
|
||||||
|
- `r1,c1:r2,c2`: This represents cells in the table from cell r1,c1
|
||||||
|
through cell r2,c2 (row, column).
|
||||||
|
|
||||||
|
- Examples :
|
||||||
|
- `$2 = $1 * $1`
|
||||||
|
- `$2 = pow($1, 5)` NOTE: Remember to put space between the $1, and 5
|
||||||
|
here otherwise it will be treated like a table cell.
|
||||||
|
- `$2 = $1 / $1,3`
|
||||||
|
- `$1,2 = $1,1 * $1,1`
|
||||||
|
- `$5,1 = Sum(1:-1)`
|
||||||
|
- `$5,1 = float2nr(Sum(1:-1))`
|
||||||
|
- `$5,3 = Sum(1,2:5,2)`
|
||||||
|
- `$5,3 = Sum(1,2:5,2)/$5,1`
|
||||||
|
- `$5,3 = Average(1,2:5,2)/$5,1`
|
||||||
|
|
||||||
### Demo
|
### Demo
|
||||||
|
|
||||||
@@ -85,5 +189,4 @@ I must thank Tim Pope for inspiration. The initial concept was created by him
|
|||||||
named <a href="https://gist.github.com/tpope/287147">cucumbertables.vim</a>.
|
named <a href="https://gist.github.com/tpope/287147">cucumbertables.vim</a>.
|
||||||
|
|
||||||
Also a shout out to godlygeek who developed the incredible <a
|
Also a shout out to godlygeek who developed the incredible <a
|
||||||
href="http://github.com/godlygeek/tabular">Tabular</a> plugin which does most
|
href="http://github.com/godlygeek/tabular">Tabular</a> plugin.
|
||||||
of the grunt work behind the scenes.
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,7 @@
|
|||||||
*table-mode.txt* Table Mode for easy table formatting. v2.4.0
|
*table-mode.txt* Table Mode for easy table formatting. v3.1
|
||||||
===============================================================================
|
===============================================================================
|
||||||
Table Mode, THE AWESOME AUTOMATIC TABLE CREATOR & FORMATTER
|
Table Mode, THE AWESOME AUTOMATIC TABLE CREATOR & FORMATTER
|
||||||
VERSION 2.4.0
|
VERSION 3.1
|
||||||
|
|
||||||
Author: Dhruva Sagar <http://dhruvasagar.com/>
|
Author: Dhruva Sagar <http://dhruvasagar.com/>
|
||||||
License: MIT <http://opensource.org/licenses/MIT/>
|
License: MIT <http://opensource.org/licenses/MIT/>
|
||||||
@@ -9,13 +9,12 @@
|
|||||||
CONTENTS *table-mode-contents*
|
CONTENTS *table-mode-contents*
|
||||||
|
|
||||||
1. Introduction .................... |table-mode-introduction|
|
1. Introduction .................... |table-mode-introduction|
|
||||||
2. Requirements .................... |table-mode-requirements|
|
2. Getting Started ................. |table-mode-getting-started|
|
||||||
3. Getting Started ................. |table-mode-getting-started|
|
3. Options ......................... |table-mode-options|
|
||||||
4. Options ......................... |table-mode-options|
|
4. Mappings ........................ |table-mode-mappings|
|
||||||
5. Mappings ........................ |table-mode-mappings|
|
5. Commands ........................ |table-mode-commands|
|
||||||
6. Commands ........................ |table-mode-commands|
|
6. Contributing .................... |table-mode-contributing|
|
||||||
7. Contributing .................... |table-mode-contributing|
|
7. Report Issues ................... |table-mode-report-issues|
|
||||||
8. Report Issues ................... |table-mode-report-issues|
|
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
INTRODUCTION *table-mode-introduction*
|
INTRODUCTION *table-mode-introduction*
|
||||||
@@ -25,12 +24,6 @@ inspired from tpope's auto aligning script for creating tables in vim -
|
|||||||
https://gist.github.com/tpope/287147, which in turn utilizes the Tabular
|
https://gist.github.com/tpope/287147, which in turn utilizes the Tabular
|
||||||
Plugin.
|
Plugin.
|
||||||
|
|
||||||
===============================================================================
|
|
||||||
REQUIREMENTS *table-mode-requirements*
|
|
||||||
|
|
||||||
This depends on the Tabular plugin - https://github.com/godlygeek/tabular,
|
|
||||||
make sure it is installed and loaded.
|
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
GETTING STARTED *table-mode-getting-started*
|
GETTING STARTED *table-mode-getting-started*
|
||||||
|
|
||||||
@@ -43,7 +36,7 @@ Create Table on the fly:
|
|||||||
|
|
||||||
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 |table-mode-toggle-map| or you can also enable it permanently
|
using |table-mode-toggle-map| or you can also enable it permanently
|
||||||
using |g:table-mode-always-active| if you wish.
|
using |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
|
||||||
@@ -53,6 +46,14 @@ Tableize content:
|
|||||||
Table Mode enables conversion of delimited text into tables. Again
|
Table Mode enables conversion of delimited text into tables. Again
|
||||||
like table creation, this is also applicable within comments.
|
like table creation, this is also applicable within comments.
|
||||||
|
|
||||||
|
Move between cells :
|
||||||
|
Now you can move between cells using table mode motions
|
||||||
|
'<Leader>t[hjkl]' to move left | down | up | right cells respectively.
|
||||||
|
You can use |table-mode-map-prefix| option to define the prefix
|
||||||
|
mapping to be used before 'hjkl'. The left | right motions wrap around
|
||||||
|
the table and move to the next | previous row after the last | first
|
||||||
|
cell in the current row if one 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.
|
||||||
|
|
||||||
@@ -69,40 +70,89 @@ Manipulation of tables:
|
|||||||
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|
|
||||||
|
|
||||||
|
Table Formulas:
|
||||||
|
Table Mode now has support for formulas like a spreadsheet. There
|
||||||
|
are 2 ways of defining formulas :
|
||||||
|
|
||||||
|
You can add formulas using |:TableAddFormula| or the mapping
|
||||||
|
|<Leader>tfa| defined by the option
|
||||||
|
|table-mode-add-formula-map| from within a table cell, which
|
||||||
|
will ask for input on the cmd-line with a 'f=' prompt. The
|
||||||
|
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 current cell as the target cell. The formula line
|
||||||
|
is evaluated immidiately to reflect the results.
|
||||||
|
|
||||||
|
You can directly also add / manipulate formula expressions in
|
||||||
|
the formula line. The formula line is a commented line right
|
||||||
|
after the table, beginning with 'tmf:' (table mode formula).
|
||||||
|
eg) '# tmf: $3=$2*$1'. You can add multiple formulas on the
|
||||||
|
line separated with a ';' eg) '# tmf: $3=$2*$1;$4=$3/3.14'
|
||||||
|
|
||||||
|
You can evaluate the formula line using |:TableEvalFormulaLine| or the
|
||||||
|
mapping |<Leader>tfe| defined by the option |table-mode-expr-calc-map|
|
||||||
|
|
||||||
|
Formula Expressions :
|
||||||
|
Expressions are of the format '$target = formula'.
|
||||||
|
|
||||||
|
The target can be of 2 forms :
|
||||||
|
|
||||||
|
'$n': This matches the table column number 'n'. So the formula
|
||||||
|
would be evaluated for each cell in that column and the result
|
||||||
|
would be placed in it.
|
||||||
|
|
||||||
|
'$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.
|
||||||
|
|
||||||
|
The formula can be a simple mathematical expression involving cells
|
||||||
|
which are also defined by the same format as that of the target cell.
|
||||||
|
Apart from basic mathematical expressions, table mode also provides
|
||||||
|
special functions 'Sum' and 'Average'. Both these functions take a
|
||||||
|
range as input. A range can be of two forms :
|
||||||
|
|
||||||
|
'n,m': This represents cells in the current column from row
|
||||||
|
'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
|
||||||
|
r1,c1 through cell r2,c2 (row, column).
|
||||||
|
|
||||||
|
Examples :
|
||||||
|
$2 = $1 * $1
|
||||||
|
$2 = $1 / $1,3
|
||||||
|
$1,2 = $1,1 * $1,1
|
||||||
|
$5,1 = Sum(1:-1)
|
||||||
|
$5,3 = Sum(1,2:5,2)
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
OPTIONS *table-mode-options*
|
OPTIONS *table-mode-options*
|
||||||
|
|
||||||
Overview:
|
Overview:
|
||||||
|table-mode-loaded| ............. Disable the plugin.
|
|table-mode-loaded| ............. Disable the plugin.
|
||||||
|table-mode-border| ............. Enable border.
|
|
||||||
|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-fillchar| ........... Set table fillchar character.
|
|table-mode-fillchar| ........... Set table fillchar character.
|
||||||
|
|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-tableize-map| ....... Set mapping for Tableize.
|
|table-mode-tableize-map| ....... Set mapping for Tableize.
|
||||||
|table-mode-tableize-op-map| .... Set mapping for Tableize with input.
|
|table-mode-tableize-op-map| .... Set mapping for Tableize with input.
|
||||||
|table-mode-align| .............. Set the text alignment for
|
|
||||||
Tableize.
|
|
||||||
|table-mode-no-border-padding| .. Set for no border padding.
|
|
||||||
|table-mode-realign-map| ........ Set mapping for table realigning.
|
|table-mode-realign-map| ........ Set mapping for table realigning.
|
||||||
|table-mode-motion-prefix| ...... Set prefix for table mode motions.
|
|
||||||
|table-mode-cell-text-object| ... Set mapping for table cell object.
|
|table-mode-cell-text-object| ... Set mapping for table cell object.
|
||||||
|table-mode-delete-row-map| ..... Set mapping for deleting table row.
|
|table-mode-delete-row-map| ..... Set mapping for deleting table row.
|
||||||
|table-mode-delete-column-map| .. Set mapping for deleting table
|
|table-mode-delete-column-map| .. Set mapping for deleting table
|
||||||
column.
|
column.
|
||||||
|
|table-mode-add-formula-map| .... Define a new table formula for the
|
||||||
|
current cell.
|
||||||
|
|table-mode-eval-expr-map| ...... Evaluate formula line and update
|
||||||
|
table.
|
||||||
|
|
||||||
g:table_mode_loaded *table-mode-loaded*
|
g:loaded_table_mode *table-mode-loaded*
|
||||||
Use this option to disable the plugin: >
|
Use this option to disable the plugin: >
|
||||||
let g:table_mode_loaded = 1
|
let g:loaded_table_mode = 1
|
||||||
<
|
<
|
||||||
|
|
||||||
g:table_mode_border *table-mode-border*
|
|
||||||
Use this option to enable / disable table border: >
|
|
||||||
let g:table_mode_border = 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: >
|
||||||
let g:table_mode_corner = '+'
|
let g:table_mode_corner = '+'
|
||||||
@@ -115,16 +165,25 @@ g:table_mode_separator *table-mode-separator*
|
|||||||
table row in insert mode.
|
table row in insert mode.
|
||||||
|
|
||||||
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 header border fill character: >
|
||||||
let g:table_mode_fillchar = '-'
|
let g:table_mode_fillchar = '-'
|
||||||
<
|
<
|
||||||
|
|
||||||
|
g:table_mode_map_prefix *table-mode-map-prefix*
|
||||||
|
Use this option to define the table mode mapping prefix that will be
|
||||||
|
prefixed for all other table mode mappings. >
|
||||||
|
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 = '<Leader>tm'
|
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
|
||||||
|
get 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
|
||||||
@@ -145,7 +204,7 @@ g:table_mode_delimiter *table-mode-delimiter*
|
|||||||
g:table_mode_tableize_map *table-mode-tableize-map*
|
g:table_mode_tableize_map *table-mode-tableize-map*
|
||||||
Use this option to define the mapping to invoke |:Tableize| with
|
Use this option to define the mapping to invoke |:Tableize| with
|
||||||
default delimiter, i.e. |:Tableize| without input. >
|
default delimiter, i.e. |:Tableize| without input. >
|
||||||
let g:table_mode_tableize_map = '<Leader>tt'
|
let g:table_mode_tableize_map = 't'
|
||||||
<
|
<
|
||||||
|
|
||||||
g:table_mode_tableize_op_map *table-mode-tableize-op-map*
|
g:table_mode_tableize_op_map *table-mode-tableize-op-map*
|
||||||
@@ -155,37 +214,13 @@ g:table_mode_tableize_op_map *table-mode-tableize-op-map*
|
|||||||
let g:table_mode_tableize_op_map = '<Leader>T'
|
let g:table_mode_tableize_op_map = '<Leader>T'
|
||||||
<
|
<
|
||||||
|
|
||||||
g:table_mode_align *table-mode-align*
|
|
||||||
Use this option to define the format for text alignment to be used for
|
|
||||||
the tables. Go through |tabular-walkthrough| for details on how to set
|
|
||||||
the format options for alignment. >
|
|
||||||
let g:table_mode_align = 'l1'
|
|
||||||
<
|
|
||||||
|
|
||||||
g:table_mode_no_border_padding *table-mode-no-border-padding*
|
|
||||||
Use this option to remove the border padding (extra spaces around the
|
|
||||||
|table-mode-fillchar|). >
|
|
||||||
let g:table_mode_no_border_padding = 0
|
|
||||||
<
|
|
||||||
NOTE this option changes |table-mode-align| to 'c0', so that
|
|
||||||
there is no extra padding around the contents.
|
|
||||||
|
|
||||||
g:table_mode_realign_map *table-mode-realign-map*
|
g:table_mode_realign_map *table-mode-realign-map*
|
||||||
Use this option to define the mapping for realigning table columns.
|
Use this option to define the mapping for realigning table columns.
|
||||||
This is useful in case you make edits to an existing table. >
|
This is useful in case you make edits to an existing table. >
|
||||||
let g:table_mode_realign_map = '<Leader>tr'
|
let g:table_mode_realign_map = 'r'
|
||||||
<
|
<
|
||||||
|
NOTE you will need to use the |table-mode-map-prefix| before this to
|
||||||
g:table_mode_motion_prefix *table-mode-motion-prefix*
|
get the desired effect.
|
||||||
Use this option to define the prefix for table mode motion commands. >
|
|
||||||
let g:table_mode_motion_prefix = '<Leader>t'
|
|
||||||
<
|
|
||||||
You can move to the next / previous row / column using the motion
|
|
||||||
commands. The motions 'hjkl' follow the prefix are in accordance to
|
|
||||||
standard vim character motions to make them easier to remember. They
|
|
||||||
may also be preceeded with a [count]. The 'h', 'l' (left and right
|
|
||||||
motions) wrap around the table row and move to the previous rows last
|
|
||||||
column, next rows first column respectively if one exists.
|
|
||||||
|
|
||||||
g:table_mode_cell_text_object *table-mode-cell-text-object*
|
g:table_mode_cell_text_object *table-mode-cell-text-object*
|
||||||
Use this option to define the table mode cell text object. >
|
Use this option to define the table mode cell text object. >
|
||||||
@@ -207,18 +242,43 @@ g:table_mode_cell_text_object *table-mode-cell-text-object*
|
|||||||
g:table_mode_delete_row_map *table-mode-delete-row-map*
|
g:table_mode_delete_row_map *table-mode-delete-row-map*
|
||||||
Use this option to define the mapping for deletion of the entire table
|
Use this option to define the mapping for deletion of the entire table
|
||||||
row. You can delete multiple rows by preceeding this with a [count]. >
|
row. You can delete multiple rows by preceeding this with a [count]. >
|
||||||
let g:table_mode_delete_column_map = '<Leader>tdd'
|
let g:table_mode_delete_column_map = 'dd'
|
||||||
|
<
|
||||||
|
NOTE you will need to use the |table-mode-map-prefix| before this to
|
||||||
|
get the desired effect.
|
||||||
|
|
||||||
g:table_mode_delete_column_map *table-mode-delete-column-map*
|
g:table_mode_delete_column_map *table-mode-delete-column-map*
|
||||||
USe this option to define the mapping for deletion of the entire table
|
Use this option to define the mapping for deletion of the entire table
|
||||||
column. You can delete multiple columns to the right by preceeding
|
column. You can delete multiple columns to the right by preceeding
|
||||||
this with a [count] >
|
this with a [count] >
|
||||||
let g:table_mode_delete_column_map = '<Leader>tdc'
|
let g:table_mode_delete_column_map = 'dc'
|
||||||
<
|
<
|
||||||
|
NOTE you will need to use the |table-mode-map-prefix| before this to
|
||||||
|
get the desired effect.
|
||||||
|
|
||||||
|
g:table_mode_add_formula_map *table-mode-add-formula-map*
|
||||||
|
Use this option to define the mapping for invoking |TableAddFormula|
|
||||||
|
command. >
|
||||||
|
let g:table_mode_add_formula_map = 'fa'
|
||||||
|
<
|
||||||
|
NOTE you will need to use the |table-mode-map-prefix| before this to
|
||||||
|
get the desired effect.
|
||||||
|
|
||||||
|
g:table_mode_eval_expr_map *table-mode-eval-expr-map*
|
||||||
|
Use this option to define the mapping for invoking
|
||||||
|
|TableEvalFormulaLine| command. >
|
||||||
|
let g:table_mode_eval_expr_map = 'fe'
|
||||||
|
<
|
||||||
|
NOTE you will need to use the |table-mode-map-prefix| before this to
|
||||||
|
get the desired effect.
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
MAPPINGS *table-mode-mappings*
|
MAPPINGS *table-mode-mappings*
|
||||||
|
|
||||||
|
*table-mode-mappings-prefix*
|
||||||
|
<Leader>t This is a prefix defined by the option |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 this
|
||||||
using the |toggle-mode-options-toggle-map| option.
|
using the |toggle-mode-options-toggle-map| option.
|
||||||
@@ -253,6 +313,22 @@ MAPPINGS *table-mode-mappings*
|
|||||||
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 using |table-mode-delete-column-map| option.
|
can change this using |table-mode-delete-column-map| option.
|
||||||
|
|
||||||
|
*table-mode-mappings-add-formula*
|
||||||
|
<Leader>tfa Add a fomula for the current table cell. This invokes
|
||||||
|
|TableAddFormula| command.
|
||||||
|
|
||||||
|
*table-mode-mappings-evaluate-formula-line*
|
||||||
|
<Leader>tfe Evaluate the formula line which is a commented line right
|
||||||
|
after the table beginning with 'tmf:'. If one exists this
|
||||||
|
would evaluate the formula line and update the table
|
||||||
|
accordingly. This invokes the |TableEvalFormulaLine| command.
|
||||||
|
|
||||||
|
+- Expands to a header border, the line immidiately above this
|
||||||
|
will be considered as the table header. You can change this by
|
||||||
|
changing |table-mode-corner| and |table-mode-fillchar|
|
||||||
|
options. This is an iabbrev so is triggered when you press
|
||||||
|
space or <CR> after typing the mapping.
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
COMMANDS *table-mode-commands*
|
COMMANDS *table-mode-commands*
|
||||||
|
|
||||||
@@ -294,7 +370,22 @@ COMMANDS *table-mode-commands*
|
|||||||
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 the content using |g:table-mode-delimiter| as the delimiter.
|
tableize the content using |table-mode-delimiter| as the delimiter.
|
||||||
|
|
||||||
|
*:TableAddFormula*
|
||||||
|
*table-mode-:TableAddFormula*
|
||||||
|
:TableAddFormula
|
||||||
|
This command is for defining a formula for the current table cell. It
|
||||||
|
takes input on the cmd-line with a 'f=' prompt and appends it to the
|
||||||
|
formula line if it exists or adds a new formula line with the
|
||||||
|
expression using the current cell as the target and the input formula.
|
||||||
|
|
||||||
|
*:TableEvalFormulaLine*
|
||||||
|
*table-mode-:TableEvalFormulaLine*
|
||||||
|
:TableEvalFormulaLine
|
||||||
|
This command when invoked from anywhere within the table or directly
|
||||||
|
on the formula line evaluates it and updates the table accordingly.
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
CONTRIBUTING *table-mode-contributing*
|
CONTRIBUTING *table-mode-contributing*
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
" Author: Dhruva Sagar <http://dhruvasagar.com/>
|
" Author: Dhruva Sagar <http://dhruvasagar.com/>
|
||||||
" License: MIT (http://www.opensource.org/licenses/MIT)
|
" License: MIT (http://www.opensource.org/licenses/MIT)
|
||||||
" Website: http://github.com/dhruvasagar/vim-table-mode
|
" Website: http://github.com/dhruvasagar/vim-table-mode
|
||||||
" Version: 2.4.0
|
" Version: 3.1
|
||||||
" Note: This plugin was heavily inspired by the 'CucumberTables.vim'
|
" Note: This plugin was heavily inspired by the 'CucumberTables.vim'
|
||||||
" (https://gist.github.com/tpope/287147) plugin by Tim Pope and
|
" (https://gist.github.com/tpope/287147) plugin by Tim Pope and
|
||||||
" uses a small amount of code from it.
|
" uses a small amount of code from it.
|
||||||
@@ -20,48 +20,37 @@
|
|||||||
" =============================================================================
|
" =============================================================================
|
||||||
|
|
||||||
" Finish if already loaded {{{1
|
" Finish if already loaded {{{1
|
||||||
if exists('g:table_mode_loaded')
|
if exists('g:loaded_table_mode')
|
||||||
finish
|
finish
|
||||||
endif
|
endif
|
||||||
let g:table_mode_loaded = 1
|
let g:loaded_table_mode = 1
|
||||||
"}}}1
|
|
||||||
"
|
|
||||||
" Finish if Tabularize plugin is not available {{{1
|
|
||||||
if !exists(':Tabularize')
|
|
||||||
echoerr 'Table Mode depends on Tabularize, ensure that is installed first.'
|
|
||||||
finish
|
|
||||||
endif
|
|
||||||
" }}}1
|
|
||||||
|
|
||||||
" Avoiding side effects {{{1
|
" Avoiding side effects {{{1
|
||||||
let s:save_cpo = &cpo
|
let s:save_cpo = &cpo
|
||||||
set cpo&vim
|
set cpo&vim
|
||||||
" }}}1
|
|
||||||
|
|
||||||
function! s:SetGlobalOptDefault(opt, val) "{{{1
|
function! s:SetGlobalOptDefault(opt, val) "{{{1
|
||||||
if !exists('g:' . a:opt)
|
if !exists('g:' . a:opt)
|
||||||
let g:{a:opt} = a:val
|
let g:{a:opt} = a:val
|
||||||
endif
|
endif
|
||||||
endfunction
|
endfunction
|
||||||
" }}}1
|
|
||||||
|
|
||||||
" Set Global Defaults {{{1
|
" Set Global Defaults {{{1
|
||||||
call s:SetGlobalOptDefault('table_mode_border', 1)
|
|
||||||
call s:SetGlobalOptDefault('table_mode_corner', '+')
|
call s:SetGlobalOptDefault('table_mode_corner', '+')
|
||||||
call s:SetGlobalOptDefault('table_mode_separator', '|')
|
call s:SetGlobalOptDefault('table_mode_separator', '|')
|
||||||
call s:SetGlobalOptDefault('table_mode_fillchar', '-')
|
call s:SetGlobalOptDefault('table_mode_fillchar', '-')
|
||||||
call s:SetGlobalOptDefault('table_mode_toggle_map', '<LocalLeader>tm')
|
call s:SetGlobalOptDefault('table_mode_map_prefix', '<Leader>t')
|
||||||
|
call s:SetGlobalOptDefault('table_mode_toggle_map', 'm')
|
||||||
call s:SetGlobalOptDefault('table_mode_always_active', 0)
|
call s:SetGlobalOptDefault('table_mode_always_active', 0)
|
||||||
call s:SetGlobalOptDefault('table_mode_delimiter', ',')
|
call s:SetGlobalOptDefault('table_mode_delimiter', ',')
|
||||||
call s:SetGlobalOptDefault('table_mode_tableize_map', '<Leader>tt')
|
call s:SetGlobalOptDefault('table_mode_tableize_map', 't')
|
||||||
call s:SetGlobalOptDefault('table_mode_tableize_op_map', '<Leader>T')
|
call s:SetGlobalOptDefault('table_mode_tableize_op_map', '<Leader>T')
|
||||||
call s:SetGlobalOptDefault('table_mode_align', 'l1')
|
call s:SetGlobalOptDefault('table_mode_realign_map', 'r')
|
||||||
call s:SetGlobalOptDefault('table_mode_realign_map', '<Leader>tr')
|
|
||||||
call s:SetGlobalOptDefault('table_mode_motion_prefix', '<Leader>t')
|
|
||||||
call s:SetGlobalOptDefault('table_mode_cell_text_object', 'tc')
|
call s:SetGlobalOptDefault('table_mode_cell_text_object', 'tc')
|
||||||
call s:SetGlobalOptDefault('table_mode_delete_row_map', '<Leader>tdd')
|
call s:SetGlobalOptDefault('table_mode_delete_row_map', 'dd')
|
||||||
call s:SetGlobalOptDefault('table_mode_delete_column_map', '<Leader>tdc')
|
call s:SetGlobalOptDefault('table_mode_delete_column_map', 'dc')
|
||||||
"}}}1
|
call s:SetGlobalOptDefault('table_mode_add_formula_map', 'fa')
|
||||||
|
call s:SetGlobalOptDefault('table_mode_eval_expr_map', 'fe')
|
||||||
|
|
||||||
function! s:TableMotion() "{{{1
|
function! s:TableMotion() "{{{1
|
||||||
let direction = nr2char(getchar())
|
let direction = nr2char(getchar())
|
||||||
@@ -69,11 +58,10 @@ function! s:TableMotion() "{{{1
|
|||||||
call tablemode#TableMotion(direction)
|
call tablemode#TableMotion(direction)
|
||||||
endfor
|
endfor
|
||||||
endfunction
|
endfunction
|
||||||
" }}}1
|
|
||||||
|
|
||||||
" Define Commands & Mappings {{{1
|
" Define Commands & Mappings {{{1
|
||||||
if !g:table_mode_always_active "{{{2
|
if !g:table_mode_always_active "{{{2
|
||||||
exec "nnoremap <silent> " . g:table_mode_toggle_map .
|
exec "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_toggle_map .
|
||||||
\ " <Esc>:call tablemode#TableModeToggle()<CR>"
|
\ " <Esc>:call tablemode#TableModeToggle()<CR>"
|
||||||
command! -nargs=0 TableModeToggle call tablemode#TableModeToggle()
|
command! -nargs=0 TableModeToggle call tablemode#TableModeToggle()
|
||||||
command! -nargs=0 TableModeEnable call tablemode#TableModeEnable()
|
command! -nargs=0 TableModeEnable call tablemode#TableModeEnable()
|
||||||
@@ -91,22 +79,32 @@ endif
|
|||||||
|
|
||||||
command! -nargs=? -range Tableize <line1>,<line2>call tablemode#TableizeRange(<q-args>)
|
command! -nargs=? -range Tableize <line1>,<line2>call tablemode#TableizeRange(<q-args>)
|
||||||
|
|
||||||
execute "xnoremap <silent> " . g:table_mode_tableize_map . " :Tableize<CR>"
|
command! TableAddFormula call tablemode#AddFormula()
|
||||||
execute "nnoremap <silent> " . g:table_mode_tableize_map . " :Tableize<CR>"
|
command! TableEvalFormulaLine call tablemode#EvaluateFormulaLine()
|
||||||
execute "xnoremap <silent> " . g:table_mode_tableize_op_map . " :<C-U>call tablemode#TableizeByDelimiter()<CR>"
|
|
||||||
|
|
||||||
execute "nnoremap <silent> " . g:table_mode_realign_map . " :<C-U>call tablemode#TableRealign('.')<CR>"
|
execute "xnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_tableize_map .
|
||||||
execute "nnoremap <silent> " . g:table_mode_motion_prefix . " :<C-U>call <SID>TableMotion()<CR>"
|
\ " :Tableize<CR>"
|
||||||
|
execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_tableize_map .
|
||||||
execute "onoremap <silent> " . g:table_mode_cell_text_object . " :<C-U>call tablemode#CellTextObject()<CR>"
|
\ " :Tableize<CR>"
|
||||||
|
execute "xnoremap <silent> " . g:table_mode_tableize_op_map .
|
||||||
execute "nnoremap <silent> " . g:table_mode_delete_row_map . " :<C-U>call tablemode#DeleteRow()<CR>"
|
\ " :<C-U>call tablemode#TableizeByDelimiter()<CR>"
|
||||||
execute "nnoremap <silent> " . g:table_mode_delete_column_map . " :<C-U>call tablemode#DeleteColumn()<CR>"
|
execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_realign_map .
|
||||||
"}}}1
|
\ " :call tablemode#TableRealign('.')<CR>"
|
||||||
|
execute "nnoremap <silent> " . g:table_mode_map_prefix .
|
||||||
|
\ " :call <SID>TableMotion()<CR>"
|
||||||
|
execute "onoremap <silent> " . g:table_mode_cell_text_object .
|
||||||
|
\ " :<C-U>call tablemode#CellTextObject()<CR>"
|
||||||
|
execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_delete_row_map .
|
||||||
|
\ " :call tablemode#DeleteRow()<CR>"
|
||||||
|
execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_delete_column_map .
|
||||||
|
\ " :call tablemode#DeleteColumn()<CR>"
|
||||||
|
execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_add_formula_map .
|
||||||
|
\ " :TableAddFormula<CR>"
|
||||||
|
execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_eval_expr_map .
|
||||||
|
\ " :TableEvalFormulaLine<CR>"
|
||||||
|
|
||||||
" Avoiding side effects {{{1
|
" Avoiding side effects {{{1
|
||||||
let &cpo = s:save_cpo
|
let &cpo = s:save_cpo
|
||||||
" }}}1
|
|
||||||
|
|
||||||
" ModeLine {{{
|
" ModeLine {{{
|
||||||
" vim:fdl=0 fdm=marker
|
" vim: sw=2 sts=2 fdl=0 fdm=marker
|
||||||
Reference in New Issue
Block a user