gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-02-23 10:15:45 +01:00
Code Issues Projects Releases Wiki Activity

Fix missing help pages resulting from non-well-formed markup.

Browse Source 
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.
This commit is contained in:
Doug Kearns
2008-12-29 22:37:34 +11:00
parent 8bbd1c92fc
commit 41f7bc12be
16 changed files with 142 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
vimperator/locale/en-US/developer.txt
View File

@@ -8,7 +8,7 @@ http://www.methods.co.nz/asciidoc/index.html[asciidoc] version 8.x or
newer. The are placed in the _src/locale/en-US/_ directory and compiled with
_make doc_. Please refer to the
http://www.methods.co.nz/asciidoc/userguide.html[asciidoc documentation] above
for details. Usually you can just write text as is, and mostly it will be
for details. Usually you can just write text as is, and mostly it will be
interpreted correctly. The only difficult part is to write special sections
like for help::help[various.html#online-help].
@@ -53,10 +53,11 @@ Some notes about the code above:
- The actual help code for this command is embedded in at least 4 underscores
(_). This generates a quoteblock and indents the text so it is more clear
that it belongs to the command.
- Wrap things in *$$[c]$$* and they are drawn like a :command. Also *$$[o]$$*
and *$$[m]$$* are available to show options and mappings.
- Any string within \{...\} and $$[arg]$$, $$[url]$$, $$[count]$$ and $$[!]$$ are
automatically drawn in a blue color.
- Wrap things in *$$[c]$$* and they are drawn like a :command. Also *$$[o]$$*,
*$$[m]$$* and *$$[a]$$* are available to markup options, mappings, and
arguments.
- As a convenience, any string within \{...\} and $$[count]$$ and $$[!]$$ are
automatically marked up as an argument.
There are also some additional asciidoc commands specifically for writing
Vimperator documentation: