mirror of
https://github.com/dhruvasagar/vim-table-mode.git
synced 2025-11-12 13:03:46 -05:00
e997144d2f
- Fixed #1. Added new option `g:table_mode_no_border_padding` which if set to 1 (set to 0 by default) removes the padding around borders (and the text too), sets `g:table_mode_align` to `'c0'` for achieving the same.
108 lines
3.9 KiB
Markdown
108 lines
3.9 KiB
Markdown
# VIM Table Mode
|
|
|
|
An awesome automatic table creator & formatter allowing one to create neat
|
|
tables as you type.
|
|
|
|
## Change Log
|
|
### Version 2.1.3 :
|
|
* Bug Fix #1, added new option `g:table_mode_no_border_padding` which removes
|
|
padding from the border.
|
|
|
|
### Version 2.1.2 :
|
|
* Bug Fixes #2, #3 & #4
|
|
|
|
### Version 2.1.1 :
|
|
* Added option g:table_mode_align to allow setting Tabular format option for
|
|
more control on how Tabular aligns text.
|
|
|
|
### Version 2.1 :
|
|
* VIM loads plugins in alphabetical order and so table-mode would be loaded
|
|
before Tabularize which it depends on. Hence Moved plugin into an after
|
|
plugin. Checking if Tabularize is available and finish immidiately if it's
|
|
not.
|
|
|
|
### Version 2.0 :
|
|
* Moved bulk of code to autoload for vimscript optimisation.
|
|
|
|
### Version 1.1 :
|
|
* Added Tableize command and mapping to convert existing content into a table.
|
|
|
|
### Version 1.0 :
|
|
* First stable release, create tables as you type.
|
|
|
|
## Getting Started
|
|
### Installation
|
|
|
|
There are 2 ways to do this
|
|
|
|
1. I recommend installing <a
|
|
href="https://github.com/tpope/vim-pathogen">pathogen.vim</a> and then
|
|
adding a git submodule for your plugin:
|
|
|
|
```sh
|
|
$ cd ~/.vim
|
|
$ git submodule add git@github.com:dhruvasagar/vim-table-mode.git bundle/table-mode
|
|
```
|
|
2. Copy autoload/todomode.vim, plugin/todo-mode.vim, doc/todo-mode.txt to
|
|
respective ~/.vim/autoload/, ~/.vim/plugin and ~/.vim/doc under UNIX or
|
|
vimfiles/autoload/, vimfiles/plugin/ and vimfiles/doc under WINDOWS and
|
|
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
|
|
|
|
- On the fly table creation :
|
|
|
|
By default the table column separator is '|' (it can be changed). As soon as
|
|
you type it on a new line (ignores indentation) the script gets to work on
|
|
creating a table around it. As you 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
|
|
default. You would have to use `:TableModeToggle` command or the table mode
|
|
toggle mapping, which is `<Leader>tm` by default to toggle the table mode or
|
|
you can directly use `:TableModeEnable` and `:TableModeDisable` to enable or
|
|
disable the table mode. This is on a per buffer basis and so it does not
|
|
cause any unusual behavior unless enabled explicitly. Please read `:h
|
|
table-mode` for further information.
|
|
- Format existing content into a table :
|
|
|
|
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
|
|
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
|
|
alternatively use the mapping `<Leader>T` (this is configurable). `:Tableize`
|
|
accepts a range and so you can also call it by giving lines manually like
|
|
`:line1,line2Tableize`, but this is not that intuitive. You can also use
|
|
the mapping `<Leader>T` with a `[count]` to apply it to the next `[count]`
|
|
lines in usual vim style.
|
|
|
|
### Demo
|
|
|
|
<a href="http://www.youtube.com/watch?v=sK2IH1hiDkw"><img
|
|
src="https://raw.github.com/dhruvasagar/vim-table-mode/master/youtube.png"/></a>
|
|
|
|
## Contributing
|
|
|
|
### Reporting an Issue :
|
|
- Use <a href="https://github.com/dhruvasagar/vim-table-mode/issues">Github
|
|
Issue Tracker</a>
|
|
|
|
### Contributing to code :
|
|
- Fork it.
|
|
- Commit your changes and give your commit message some love.
|
|
- Push to your fork on github.
|
|
- Open a Pull Request.
|
|
|
|
## Credit
|
|
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>.
|
|
|
|
Also a shout out to godlygeek who developed the incredible <a
|
|
href="http://github.com/godlygeek/tabular">Tabular</a> plugin which does most
|
|
of the grunt work behind the scenes.
|