1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-23 23:52:26 +01:00

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

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

File diff suppressed because one or more lines are too long

View File

@@ -57,18 +57,18 @@ ________________________________________________________________________________
|:doautoa| |:doautoall|
||:doautoa[ll] {event} [url]|| +
||:doautoa[ll] {event} [a][url][a]|| +
________________________________________________________________________________
Apply the autocommands matching the specified URL to all buffers. If no [url]
is specified use the current URL.
Apply the autocommands matching the specified URL to all buffers. If no
[a][url][a] is specified use the current URL.
________________________________________________________________________________
|:do| |:doautocmd|
||:do[autocmd] {event} [url]|| +
||:do[autocmd] {event} [a][url][a]|| +
________________________________________________________________________________
Apply the autocommands matching the specified URL to the current buffer. If no
[url] is specified use the current URL.
[a][url][a] is specified use the current URL.
________________________________________________________________________________
section:Examples[autocmd-examples]

View File

@@ -30,7 +30,7 @@ ________________________________________________________________________________
section:Opening{nbsp}web{nbsp}pages[opening]
|o| |:o| |:open|
||:o[pen][!] [arg1], [arg2], ...|| +
||:o[pen][!] [a][arg1][a], [a][arg2][a], ...|| +
||o||
________________________________________________________________________________
Open one or more URLs in the current tab.
@@ -65,7 +65,7 @@ ________________________________________________________________________________
|t| |:t| |:tabopen| |:tabnew| |:tabe| |:tabedit|
||:tabopen[!] [arg1], [arg2], ...|| +
||:tabopen[!] [a][arg1][a], [a][arg2][a], ...|| +
||t||
________________________________________________________________________________
Just like [c]:open[c], but opens the resulting web page(s)
@@ -100,7 +100,7 @@ ________________________________________________________________________________
|:winopen| |:wopen| |:winedit|
||:wino[pen][!] [arg1], [arg2], ...|| +
||:wino[pen][!] [a][arg1][a], [a][arg2][a], ...|| +
________________________________________________________________________________
Just like help::open[browsing.html#opening], but opens the resulting web page(s)
in a new window.
@@ -274,11 +274,10 @@ ________________________________________________________________________________
section:Writing[writing,save-file]
|:w| |:write| |:sav| |:saveas| +
||:sav[eas][!] [file]||
||:sav[eas][!] [a][file][a]||
________________________________________________________________________________
Save current web page to disk. If [file] is omitted, save to the page's
default filename. Existing documents will only be overwritten if [!] is
given.
Save current web page to disk. If [a][file][a] is omitted, save to the page's
default filename. Existing documents will only be overwritten if [!] is given.
________________________________________________________________________________
section:Quitting[quitting,save-session]

View File

@@ -47,9 +47,9 @@ ________________________________________________________________________________
|:vie| |:viewsource|
||:vie[wsource][!] [url]|| +
||:vie[wsource][!] [a][url][a]|| +
________________________________________________________________________________
View source code of current document. If [url] is specified then view the
View source code of current document. If [a][url][a] is specified then view the
source of that document. When [!] is given, it is opened with the external
editor.
________________________________________________________________________________
@@ -306,12 +306,12 @@ ________________________________________________________________________________
|:zo| |:zoom|
||:zo[om][!] [value]|| +
||:zo[om][!] [a][value][a]|| +
||:zo[om][!] +{value} | -{value}|| +
________________________________________________________________________________
Set zoom value of current web page. [value] can be an absolute value between 30
and 300% or a relative value if prefixed with "-" or "+". If [value] is
omitted, zoom is reset to 100%.
Set zoom value of current web page. [a][value][a] can be an absolute value
between 30 and 300% or a relative value if prefixed with "-" or "+". If
[a][value][a] is omitted, zoom is reset to 100%.
Normally this command operates on the text zoom, if used with [!] it operates
on full zoom.
@@ -339,14 +339,14 @@ ________________________________________________________________________________
section:Alternate{nbsp}style{nbsp}sheets[alternate-stylesheet]
Page authors may specify alternate style sheets for an HTML document. Users
can then switch between these various style sheets, selecting their favorite.
Page authors may specify alternate style sheets for an HTML document. Users can
then switch between these various style sheets, selecting their favorite.
|:pagest| |:pagestyle|
||:pagest[yle] [stylesheet]|| +
||:pagest[yle] [a][stylesheet][a]|| +
________________________________________________________________________________
Select the author style sheet to apply. If [stylesheet] is not specified the
page's default style sheet is used.
Select the author style sheet to apply. If [a][stylesheet][a] is not specified
the page's default style sheet is used.
All author styling can be removed by setting the 'usermode' option.
________________________________________________________________________________

View File

@@ -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:

View File

@@ -8,10 +8,9 @@ INTRO TO BE WRITTEN...
||:ec[ho] {expr}||
________________________________________________________________________________
Echo the expression. Useful for showing informational messages. Multiple lines
can be separated by \n. {expr} can either be a quoted string, or any
expression which can be fed to eval() like 4+5. You can also view the source
code of objects and functions if the return value of {expr} is an object or
function.
can be separated by \n. {expr} can either be a quoted string, or any expression
which can be fed to eval() like 4+5. You can also view the source code of
objects and functions if the return value of {expr} is an object or function.
________________________________________________________________________________

View File

@@ -15,7 +15,7 @@ Vimperator supports a number of different marks:
section:Bookmarks[bookmarks]
|a| |:bma| |:bmark|
||:bma[rk][!] [-title=title] [-keyword=kw] [-tags=tag1,tag2] [url]|| +
||:bma[rk][!] [a][-title=title][a] [a][-keyword=kw][a] [a][-tags=tag1,tag2][a] [a][url][a]|| +
||a||
____________________________________________________________________________
Add a bookmark. +
@@ -27,12 +27,12 @@ The following options are interpreted:
- -keyword=keyword (short option: -k)
If [!] is present, a new bookmark is always added. Otherwise, the first
bookmark matching [url] is updated.
bookmark matching [a][url][a] is updated.
When creating a new bookmark, if [a][-title][a] isn't given, either the web
page's title or URL is used. You can omit the optional [url] argument, so just
do [c]:bmark[c] to bookmark the currently loaded web page with a default title
and without any tags.
page's title or URL is used. You can omit the optional [a][url][a] argument, so
just do [c]:bmark[c] to bookmark the currently loaded web page with a default
title and without any tags.
____________________________________________________________________________
@@ -47,10 +47,11 @@ ________________________________________________________________________________
|:bmarks|
||:bmarks[!] [filter]|| +
||:bmarks[!] [a][filter][a]|| +
________________________________________________________________________________
List or open multiple bookmarks. Open the message window at the bottom of the
screen with all bookmarks which match [filter] either in the title or URL.
screen with all bookmarks which match [a][filter][a] either in the title or
URL.
The special version [c]:bmarks![c] works the same as [c]:bmarks[c] except it
opens all the found bookmarks in new tabs.
@@ -62,10 +63,10 @@ ________________________________________________________________________________
|:delbm| |:delbmarks|
||:delbm[arks] [url]|| +
||:delbm[arks] [a][url][a]|| +
________________________________________________________________________________
Delete a bookmark. Deletes *all* bookmarks which match the [url].
If omitted, [url] defaults to the URL of the current buffer. Use [m]<Tab>[m]
Delete a bookmark. Deletes *all* bookmarks which match the [a][url][a]. If
omitted, [a][url][a] defaults to the URL of the current buffer. Use [m]<Tab>[m]
key on a string to complete the URL which you want to delete.
The following options WILL be interpreted in the future:
@@ -106,7 +107,7 @@ ________________________________________________________________________________
|:ba| |:back|
||:[count]ba[ck][!] [url]|| +
||:[count]ba[ck][!] [a][url][a]|| +
________________________________________________________________________________
Go back in the browser history. Count is supported, [c]:3back[c] goes back 3
pages in the browser history. +
@@ -115,7 +116,7 @@ ________________________________________________________________________________
|:fw| |:fo| |:forward|
||:[count]fo[rward][!] [url]|| +
||:[count]fo[rward][!] [a][url][a]|| +
________________________________________________________________________________
Go forward in the browser history. Count is supported, [c]:3forward[c] goes
forward 3 pages in the browser history. The special version [c]:forward![c]
@@ -124,10 +125,10 @@ ________________________________________________________________________________
|:hs| |:hist| |:history|
||:hist[ory][!] [filter]|| +
||:hist[ory][!] [a][filter][a]|| +
________________________________________________________________________________
Show recently visited URLs. Open the message window at the bottom of the
screen with all history items which match [filter] either in the title or URL.
Show recently visited URLs. Open the message window at the bottom of the screen
with all history items which match [a][filter][a] either in the title or URL.
The special version [c]:history![c] works the same as [c]:history[c] except
it opens all the found items in new tabs.
@@ -183,7 +184,7 @@ ________________________________________________________________________________
|:qma| |:qmark|
||:qma[rk] {a-zA-Z0-9} [url]|| +
||:qma[rk] {a-zA-Z0-9} [a][url][a]|| +
________________________________________________________________________________
Mark a URL with a letter for quick access. You can also mark whole groups like this: +
[c]:qmark f \http://forum1.com, \http://forum2.com, imdb some artist[c]
@@ -191,9 +192,10 @@ ________________________________________________________________________________
|:qmarks|
||:qmarks [arg]||
||:qmarks [a][arg][a]||
________________________________________________________________________________
Show all QuickMarks. If [arg] is specified then limit the list to those QuickMarks mentioned.
Show all QuickMarks. If [a][arg][a] is specified then limit the list to those
QuickMarks mentioned.
________________________________________________________________________________
section:Local{nbsp}marks[localmarks]
@@ -237,9 +239,10 @@ ________________________________________________________________________________
|:marks| +
||:marks [arg]||
||:marks [a][arg][a]||
________________________________________________________________________________
Show all location marks of current web page. If [arg] is specified then limit the list to those marks mentioned.
Show all location marks of current web page. If [a][arg][a] is specified then
limit the list to those marks mentioned.
________________________________________________________________________________
// vim: set syntax=asciidoc:

View File

@@ -239,9 +239,9 @@ ____
|\'ds'| |\'defsearch'|
||'defsearch' 'ds'|| string (default: "google")
____
Sets the default search engine.
The default search engine name is used in the [c]:[tab]open [arg][c] command if
[[arg]] neither looks like a URL or like a specified search engine/keyword.
Sets the default search engine. The default search engine name is used in the
[c]:[tab]open [arg][c] command if [a][arg][a] neither looks like a URL or like
a specified search engine/keyword.
This means, it you set 'defsearch' to "youtube", then [c]:open arnold
schwarzenegger[c] will be exactly the same as [c]:open youtube arnold
@@ -249,7 +249,7 @@ schwarzenegger[c]. Therefore, you need to add a keyword or search engine
"youtube" first.
If 'defsearch' is empty, then Firefox will always attempt to open the
raw [[arg]].
raw [a][arg][a].
____

View File

@@ -4,8 +4,8 @@ HEADER
Vimperator provides a Vim-like interface to Firefox's standard text search
functionality. There is no support for using regular expressions in search
commands as Firefox does not provide native regexp support. It is unlikely
that this will ever be available.
commands as Firefox does not provide native regexp support. It is unlikely that
this will ever be available.
|/| +
||/\\{pattern\\}[/]<CR>|| +

View File

@@ -16,10 +16,10 @@ ____________________________________________________________________________
|:macros|
||:mac[ros] [args]|| +
||:mac[ros] [a][pat][a]|| +
________________________________________________________________________________
List recorded macros matching the optional regular expression [args]. If no
regexp is given, list all macros.
List recorded macros matching the optional regular expression [a][pat][a]. If
no regexp is given, list all macros.
________________________________________________________________________________

View File

@@ -34,11 +34,12 @@ _%HOMEDRIVE%%HOMEPATH%_.
section:Saving{nbsp}settings[save-settings]
|:mkv| |:mkvimperatorrc|
||:mkv[imperatorrc][!] [file]|| +
||:mkv[imperatorrc][!] [a][file][a]|| +
________________________________________________________________________________
Write current key mappings and changed options to [file]. If no [file] is
specified then _~/.vimperatorrc_ is written unless this file already exists. The
special version [c]:mkvimperatorrc![c] will overwrite [file] if it exists.
Write current key mappings and changed options to [a][file][a]. If no
[a][file][a] is specified then _~/.vimperatorrc_ is written unless this file
already exists. The special version [c]:mkvimperatorrc![c] will overwrite
[a][file][a] if it exists.
Warning: this differs from Vim's behavior which defaults to writing the file
in the current directory.

View File

@@ -9,11 +9,11 @@ result many buffer and tab commands are interchangeable.
section:Listing{nbsp}tabs[listing-tabs]
|B| |:tabs| |:ls| |:files| |:buffers|
||:buffers [filter]|| +
||:buffers [a][filter][a]|| +
||B||
________________________________________________________________________________
Show a list of buffers (=tabs) matching [filter]. Without [filter] list all
tabs.
Show a list of buffers (=tabs) matching [a][filter][a]. Without [a][filter][a]
list all tabs.
________________________________________________________________________________
section:Opening{nbsp}tabs[opening-tabs]
@@ -174,16 +174,16 @@ ________________________________________________________________________________
section:Closing{nbsp}tabs[closing-tabs]
|d| |:tabc| |:tabclose| |:bun| |:bunload| |:bw| |:bwipeout| |:bd| |:bdelete|
||:[count]bd[elete][!] [arg]|| +
||:[count]bd[elete][!] [a][arg][a]|| +
||[count]d||
________________________________________________________________________________
Delete current buffer (=tab). Count is supported, [c]:2bd[c] removes two tabs
and the one to the right is selected. Afterwards, the tab to the right of the
deleted one is selected.
When used with [arg], remove all tabs which contain [arg] in the hostname.
[!] forces this command to also search for [arg] in the full URL and also
the title of the tab. Use with care.
When used with [a][arg][a], remove all tabs which contain [a][arg][a] in the
hostname. [!] forces this command to also search for [a][arg][a] in the full
URL and also the title of the tab. Use with care.
________________________________________________________________________________
@@ -195,11 +195,11 @@ ________________________________________________________________________________
|u| |:u| |:undo|
||:[count]u[ndo] [url]|| +
||:[count]u[ndo] [a][url][a]|| +
||[count]u||
________________________________________________________________________________
Undo closing of a tab. If a count is given, don't close the last but the
[count]th last tab. With [url] restores the tab matching the URL.
[count]th last tab. With [a][url][a] restores the tab matching the URL.
________________________________________________________________________________

View File

@@ -11,9 +11,9 @@ section:Quick-start{nbsp}tutorial[tutorial]
If you've started using Vimperator from scratch (i.e., without any
customization), you should be looking at this help page in a relatively
bare-looking window. The menubar, navigation bar, and bookmark bars are
hidden. In case you missed the notice in the help:Introduction[intro.html],
you can regain these by issuing the command
bare-looking window. The menubar, navigation bar, and bookmark bars are hidden.
In case you missed the notice in the help:Introduction[intro.html], you can
regain these by issuing the command
:set go+=mTb<CR>
@@ -32,8 +32,8 @@ different meanings depending on which mode the browser is in. Vimperator has
several modes, but the 2 most important are ``normal'' mode and
``command-line'' mode.
When Vimperator starts, it is in normal mode by default. This is probably
where you will spend the majority of your time.
When Vimperator starts, it is in normal mode by default. This is probably where
you will spend the majority of your time.
The other core mode of Vimperator, command-line mode, can be entered from
normal mode by typing a \':' (colon). You will frequently see Vimperator
@@ -45,11 +45,11 @@ Vimperator.
section:Getting{nbsp}help[getting-help]
Vim is a great editor but it's not much of a web browser. So even seasoned
Vim users will probably have to look at Vimperator documentation sooner or
later. Most of the documentation for Vimperator's features are easily found
using the [c]:help[c] command. For example, you can find help on the
[c]:help[c] command by typing
Vim is a great editor but it's not much of a web browser. So even seasoned Vim
users will probably have to look at Vimperator documentation sooner or later.
Most of the documentation for Vimperator's features are easily found using the
[c]:help[c] command. For example, you can find help on the [c]:help[c] command
by typing
:help :help<CR>
@@ -114,10 +114,10 @@ Vimmers.
* [m]d[m] --
close the active tab (delete the buffer)
To open a web page in a new tab, use the [c]:tabopen {url}[c]. To open a URL
in the current tab, use [c]:open[c]. The normal mode
mappings [m]t[m] and [m]o[m], respectively, map to these commands, so the
following pairs sequences are equivalent:
To open a web page in a new tab, use the [c]:tabopen {url}[c]. To open a URL in
the current tab, use [c]:open[c]. The normal mode mappings [m]t[m] and [m]o[m],
respectively, map to these commands, so the following pairs sequences are
equivalent:
:open my.webmail.com<CR>
omy.webmail.com<CR>
@@ -131,14 +131,14 @@ So now you can navigate around in Vimperator. But wait... how do you *open* a
page or tab linked in a web page? How do you ``click'' on all those links
without your tailed friend?
The answer is ``hints''. Activating hints displays a number next to every
link Vimperator can find. To follow the link, simply type the number
corresponding to the hint, a white number inside a red square by default.
The answer is ``hints''. Activating hints displays a number next to every link
Vimperator can find. To follow the link, simply type the number corresponding
to the hint, a white number inside a red square by default.
For text links, there's an additional shortcut; you can type some text
contained in the link and Vimperator will search all the links it can find and
only hint the matching links, further narrowing down the list. If the text
you type uniquely identifies any given link, Vimperator will follow that link
only hint the matching links, further narrowing down the list. If the text you
type uniquely identifies any given link, Vimperator will follow that link
immediately without any further user input.
Whichever way you choose to indicate your target link, once Vimperator has
@@ -171,10 +171,9 @@ following:
section:Saving{nbsp}for{nbsp}posterity{nbsp}-{nbsp}vimperatorrc[vimperatorrc]
Once you get Vimperator set up with your desired options, maps, and
commands, you'll probably want them to be available the next time you
open Vimperator. Continuing the Vim theme, this is done with a
vimperatorrc file.
Once you get Vimperator set up with your desired options, maps, and commands,
you'll probably want them to be available the next time you open Vimperator.
Continuing the Vim theme, this is done with a vimperatorrc file.
To save your current settings and allow them to be loaded automatically
next time you start Vimperator, issue the [c]:mkv[c] command.
@@ -196,9 +195,9 @@ Vimperator supports all of Vim's classic methods of exiting.
section:Where{nbsp}did{nbsp}Firefox{nbsp}go?[whither-firefox]
You might feel pretty disoriented now. Don't worry. This is still Firefox
underneath. Here are some ways Vimperator allows Firefox to shine through.
See the [c]:help[c] for these commands and mappings for more information on
how to make the best use of them.
underneath. Here are some ways Vimperator allows Firefox to shine through. See
the [c]:help[c] for these commands and mappings for more information on how to
make the best use of them.
* [c]:dialog[c] --
To access some of Firefox's many dialog windows, you can use the
@@ -239,16 +238,16 @@ as above, with [c]:set go+=m[c], and select *Add-ons* from the *Tools* menu.
section:I'm{nbsp}interested...but{nbsp}lost![support]
Vimperator has an energetic and growing user base. If you've run into a
problem that you can't seem to solve with Vimperator, or if you think you might
have found a bug, please let us know! There is support available on the
Vimperator has an energetic and growing user base. If you've run into a problem
that you can't seem to solve with Vimperator, or if you think you might have
found a bug, please let us know! There is support available on the
http://vimperator.cutup.org/index.php?title=Main_Page[wiki], or in the
#vimperator IRC channel on http://freenode.net/[freenode].
If you have any feature requests or (even better) offers to help, we'd love to
hear from you as well. Developers work on Vimperator whenever possible, but
we are neither infinite nor omnipotent; please bear with us. If you can't
wait for us to get around to it, rest assured patches are welcome! See
the help:Developer[developer.html] page for more information.
hear from you as well. Developers work on Vimperator whenever possible, but we
are neither infinite nor omnipotent; please bear with us. If you can't wait for
us to get around to it, rest assured patches are welcome! See the
help:Developer[developer.html] page for more information.
// vim: set syntax=asciidoc: