Mostly typos/omissions/markup errors, more remarkable e. g. changing
'b' to 'B' in tutorial reflecting a change from 1.2.
Also uncommented [macros] section in asciidoc.conf (is that right?).
Signed-off-by: Doug Kearns <dougkearns@gmail.com>
This commit is in the spirit of
a3fc60c011b8ed42c2efec2147b1268abc10d578.
Vim's help format really numbers everything manually? Sections too?
That's unbelievable.
Also added rough documentation for insert mode.
TODO: Abbreviations should also expand on <CR> and <Tab>, but right now
adding <CR> to the mappings.add() has no effect, and adding <Tab> to the
mappings.add() breaks tab completion.
TODO: Rather than listing non-keyword characters in two places (ui.js
and mappings.js), they should be specified in one location (that could
someday be trumped by an 'iskeyword' option).
At the moment, only "syntax=asciidoc" was specified. The
asciidoc_filetype.vim that is distributed with Asciidoc gives the
installer two options -- to either associate every *.txt file with
asciidoc or to try to decipher whether or not the file is an asciidoc
using the first 50 lines.
So it's not given that a developer will open the *.txt files with
ft=asciidoc, and so it's helpful to have it explicitly in the modeline.
Again, by Chicago Manual of Style (CMOS) and several other style guides, we
hyphenate compound /modifiers/ when they come /before/ the word being
modified.
So the "command line" is not hyphenated, but the "command-line mode" is.
This is consistent with Vim help style conventions as well.
For now, the internal equivalent of "iskeyword" is [^\s'"].
In the future, the internal "iskeyword" equivalent can be expanded. It may
be overboard to add an "iskeyword" option, as it applies to lots more
things than :abbr. Additionally, it's not clear why it's bad to call
keyword characters everything except whitespace and quotes.
TODO: Should abbreviations be triggered by any non-keyword character?
TODO: Should abbreviations be triggered by <CR>?
TODO: Should abbreviations be able to include <Left>, etc.?
Most of the special case asciidoc replacements were also removed since
they're a bit confusing and doing so results in a 60% improvement in the
time taken by asciidoc to process the help pages. Unfortunately, I'm
now limited to preparing a three course menu for my guests while it runs
rather than the degustation extravaganzas of the past but such is life.
It's still a bit of a mess but since we're almost certainly moving to
something else in the near future it's probably not worth cleaning it up
before 2.0 is released.
