mirror of
https://github.com/dhruvasagar/vim-table-mode.git
synced 2025-11-08 11:03:47 -05:00
restructured the headers
This commit is contained in:
29
README.md
29
README.md
@@ -3,12 +3,8 @@
|
|||||||
An awesome automatic table creator & formatter allowing one to create neat
|
An awesome automatic table creator & formatter allowing one to create neat
|
||||||
tables as you type.
|
tables as you type.
|
||||||
|
|
||||||
## Change Log
|
## Getting Started
|
||||||
See <a
|
|
||||||
href="https://github.com/dhruvasagar/vim-table-mode/blob/master/CHANGELOG.md">
|
|
||||||
CHANGELOG.md </a>
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
There are several ways to do this
|
There are several ways to do this
|
||||||
@@ -30,9 +26,7 @@ $ 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
|
||||||
|
|
||||||
### Usage
|
### Creating table on-the-fly
|
||||||
|
|
||||||
- **Create table on-the-fly** :
|
|
||||||
|
|
||||||
To start using the plugin in the on-the-fly mode use `:TableModeToggle` mapped to <kbd>\<Leader\>tm</kbd> by default (which means <kbd>\\</kbd> <kbd>t</kbd> <kbd>m</kbd> if you didn't override the <Leader> by `:let mapleader = ","` to have <kbd>,</kbd> <kbd>t</kbd> <kbd>m</kbd>).
|
To start using the plugin in the on-the-fly mode use `:TableModeToggle` mapped to <kbd>\<Leader\>tm</kbd> by default (which means <kbd>\\</kbd> <kbd>t</kbd> <kbd>m</kbd> if you didn't override the <Leader> by `:let mapleader = ","` to have <kbd>,</kbd> <kbd>t</kbd> <kbd>m</kbd>).
|
||||||
|
|
||||||
@@ -103,7 +97,7 @@ To get ReST-compatible tables use
|
|||||||
aligned, whether center, right or left by using a `:` character defined by
|
aligned, whether center, right or left by using a `:` character defined by
|
||||||
`g:table_mode_align_char` option.
|
`g:table_mode_align_char` option.
|
||||||
|
|
||||||
- **Format existing content into a table** :
|
### Formatting 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
|
||||||
@@ -125,7 +119,7 @@ To get ReST-compatible tables use
|
|||||||
You can use the mapping <kbd>\<Leader\>T</kbd> with a `[count]` to apply it to the
|
You can use the mapping <kbd>\<Leader\>T</kbd> with a `[count]` to apply it to the
|
||||||
next `[count]` lines in standard vim style.
|
next `[count]` lines in standard vim style.
|
||||||
|
|
||||||
- **Move between cells** :
|
### Moving around
|
||||||
|
|
||||||
Now you can move between cells using table mode motions <kbd>[|</kbd>,
|
Now you can move between cells using table mode motions <kbd>[|</kbd>,
|
||||||
<kbd>]|</kbd>, <kbd>{|</kbd> & <kbd>}|</kbd> to move left | right | up |
|
<kbd>]|</kbd>, <kbd>{|</kbd> & <kbd>}|</kbd> to move left | right | up |
|
||||||
@@ -133,7 +127,7 @@ To get ReST-compatible tables use
|
|||||||
and move to the next | previous row after the last | first cell in the
|
and move to the next | previous row after the last | first cell in the
|
||||||
current row if one exists.
|
current row if one exists.
|
||||||
|
|
||||||
- **Manipulating Table** :
|
### Manipulating Table
|
||||||
|
|
||||||
- **Cell Text Object** :
|
- **Cell Text Object** :
|
||||||
|
|
||||||
@@ -156,7 +150,9 @@ To get ReST-compatible tables use
|
|||||||
(provided you are within a table row), this can also be preceeded with a
|
(provided you are within a table row), this can also be preceeded with a
|
||||||
[count] to delete multiple columns.
|
[count] to delete multiple columns.
|
||||||
|
|
||||||
- **Table Formulas** :
|
## Advanced Usage: Spreadsheet Capabilities
|
||||||
|
|
||||||
|
### Table Formulas
|
||||||
|
|
||||||
Table Mode now has support for formulas like a spreadsheet. There are 2 ways
|
Table Mode now has support for formulas like a spreadsheet. There are 2 ways
|
||||||
of defining formulas :
|
of defining formulas :
|
||||||
@@ -180,7 +176,7 @@ To get ReST-compatible tables use
|
|||||||
|
|
||||||
NOTE: You can now use the mapping <kbd>\<Leader\>t?</kbd>
|
NOTE: You can now use the mapping <kbd>\<Leader\>t?</kbd>
|
||||||
|
|
||||||
- **Formula Expressions** :
|
### Formula Expressions
|
||||||
|
|
||||||
Expressions are of the format `$target = formula`.
|
Expressions are of the format `$target = formula`.
|
||||||
|
|
||||||
@@ -221,11 +217,16 @@ To get ReST-compatible tables use
|
|||||||
- `$5,3 = Sum(1,2:5,2)/$5,1`
|
- `$5,3 = Sum(1,2:5,2)/$5,1`
|
||||||
- `$5,3 = Average(1,2:5,2)/$5,1`
|
- `$5,3 = Average(1,2:5,2)/$5,1`
|
||||||
|
|
||||||
### Demo
|
## Demo
|
||||||
|
|
||||||
<a href="https://www.youtube.com/watch?v=qA-ZT2r5-t0"><img
|
<a href="https://www.youtube.com/watch?v=qA-ZT2r5-t0"><img
|
||||||
src="https://raw.github.com/dhruvasagar/vim-table-mode/master/youtube.png"/></a>
|
src="https://raw.github.com/dhruvasagar/vim-table-mode/master/youtube.png"/></a>
|
||||||
|
|
||||||
|
## Change Log
|
||||||
|
See <a
|
||||||
|
href="https://github.com/dhruvasagar/vim-table-mode/blob/master/CHANGELOG.md">
|
||||||
|
CHANGELOG.md </a>
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
### Reporting an Issue :
|
### Reporting an Issue :
|
||||||
|
|||||||
Reference in New Issue
Block a user