Provide handy shortcuts for :Tabular #11
Conversation
jjaderberg
left a comment
jjaderberg
left a comment
There was a problem hiding this comment.
This looks like a nice addition.
Thanks for taking the time to contribute back. 👍
I made an initial review pass and generated some comments, change requests.
|
|
||
| ==== Aligning | ||
|
|
||
| When the https://github.com/godlygeek/tabular[Tabular Plugin] is |
There was a problem hiding this comment.
One sentence per line. ,spl pls
There was a problem hiding this comment.
And lvl2 is to communicate "one idea per sentence".
If Tabular is highly recommended, it deserves it's own sentence.
Don't squeeze it into a parenthesis in the middle of a sentence.
Doing so interferes with the thought communicated in the surrounding sentence.
Suggest something like:
... is a popular plugin for aligning text.
The plugin is very useful for working with Asciidoc tables.
When the Tabular plugin is installed, tables can be aligned using `kbd:[+,|+]`.
This feature is limited to tables that ...
|
|
||
| .Before | ||
| .... | ||
| [%header] |
There was a problem hiding this comment.
The % stuff is a nice feature but it's only noise in this context. I don't see how this adds any value for the reader. If it does it should be added in one fell swoop everywhere.
|
|
||
| .After | ||
| .... | ||
| [%header] |
| |=== | ||
| .... | ||
|
|
||
| If the option `g:asciidoc_table_autoalign` is set to 1 (which is set to 0 |
| " }}} | ||
|
|
||
| " Tabular ================================================== {{{ | ||
| if exists(':Tabularize') |
There was a problem hiding this comment.
Have you thought about the options here?
This might be the right choice.
First thought would be exists('g:tabular_loaded').
But if I have the plugin on path and don't want to load it for whatever reason, I would set that to prevent the plugin from loading.
Have you given thought to doing this particular check, or is it an "it's good enough" kind of thing?
|
|
||
| " Tabular ================================================== {{{ | ||
| if exists(':Tabularize') | ||
| " Use <Leader>| to realign tables with the Tabuliarize plugin |
There was a problem hiding this comment.
| " Use <Leader>| to realign tables with the Tabuliarize plugin | |
| " Use <LocalLeader>| to realign tables with the Tabuliarize plugin |
| alignment of tables is possible via kbd:[+,|+]. This applies only to tables | ||
| that use the Bar kbd:[+|+] as separator between cells. | ||
|
|
||
| Be aware that this only works for basic tables and certain features like |
There was a problem hiding this comment.
If you really want the user to be aware, use an admonition.
In this case I think it is enough to say, simply:
The align feature does not work well for tables with cell spanning.
I am not sure what "the cell spanning will not be visualized in the asciidoc sourcecode" means.
2 participants
Use
tabularvim plugin to align tables (if available).