1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-02-04 12:15:45 +01:00

Sync the Xulmus documentation.

This commit is contained in:
Doug Kearns
2009-07-13 16:51:04 +10:00
parent bc2324e151
commit 383d03ad97
12 changed files with 81 additions and 37 deletions

View File

@@ -21,7 +21,7 @@ section:Dialogs[dialogs]
|:addo| |:addons| +
||:addo[ns]||
________________________________________________________________________________
Show available browser Extensions and Themes.
Show available Firefox Extensions and Themes.
You can add/remove/disable browser extensions from this dialog.
Be aware that not all Firefox extensions work, because Vimperator overrides
some key bindings and changes Firefox's GUI.

View File

@@ -186,8 +186,8 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:extdelete[c]||
||[c]:extdisable[c]||
||[c]:extenable[c]||
||[c]:extoptions[c]||
||[c]:extensions[c]|| List all installed extensions +
||[c]:extoptions[c]||
||[c]:exusage[c]|| List all Ex commands with a short description +
||[c]:finish[c]|| Stop sourcing a script file +
||[c]:forward[c]|| Go forward in the browser history +

View File

@@ -138,7 +138,7 @@ subsection:Key{nbsp}sequences[:<>,key-sequence]
For most keys, the key-sequence is the same as the character you see when you
type that key, however there are some exceptions which allow for a much larger
number of keys to be used in mappings.
number of keys to be used in mappings.
* [c]<lt>[c], [c]\<[c], [c]<Space>[c], [c]\ [c] allow a literal [c]<[c] or space character.
* [c]\'[c], [c]\"[c] and [c]\\[c] must be used to avoid escaping issues when mapping a quote or backslash.
@@ -148,7 +148,7 @@ number of keys to be used in mappings.
Most keyboards have some modifiers such as the control, alt or meta keys. In
order to create a mapping that uses these keys the correct prefix must be used
within the angle brackets.
within the angle brackets.
* [c]<C-x>[c]: The control or ctrl key.
* [c]<A-x>[c]: The alt key.
@@ -157,7 +157,7 @@ within the angle brackets.
These prefixes can be combined however you see fit, though you should note that
within angle brackets all alphabetic characters are read as lowercase. In order
to force them to be uppercase, you must specify the S- prefix as well.
to force them to be uppercase, you must specify the S- prefix as well.
Additionally, you should never use the S- prefix with a number of piece of
punctuation, even if you require a shift to type that character; doing so will
give you a mapping that cannot be typed. With non-character keys, tab and
@@ -173,7 +173,7 @@ the situation:
* [c]<C-A-J>[c]: exactly the same as above
* [c]<C-A-S-j>[c]: press J while holding control and alt
subsection:Special{nbsp}Characters[map-special-chars]
subsection:Special{nbsp}characters[:map-special-chars]
|<Nop>| +
||<Nop>||

View File

@@ -96,7 +96,7 @@ section:Restarting[restarting]
|:res| |:restart| +
||:res[tart]||
________________________________________________________________________________
Force the browser to restart. Useful when installing extensions.
Force Firefox to restart. Useful when installing extensions.
________________________________________________________________________________
// vim: set filetype=asciidoc:

View File

@@ -87,6 +87,7 @@ LOGO=<div style="text-align: center;"><span class="xulmus-logo"></span></div>
[c]=#command
[m]=#mapping
[a]=#argument
[j]=#jump
# FIXME: this prevents all asciidoc attribute processing
# ^obviously it doesn't? --stepnem
{|}=argument2
@@ -101,6 +102,7 @@ option=<a class="option" href="#">|</a>
option2=<a class="option" href="#">'|'</a>
command=<a class="command" href="#">|</a>
mapping=<a class="mapping" href="#">|</a>
jump=<a class="jump" href="#">|</a>
argument=<span class="argument">|</span>
# NOTE: in certain contexts the unescaped '#' is stripped. As we're ditching
# asciidoc I won't bother investigating --djk

View File

@@ -10,11 +10,11 @@ Execute commands automatically on events.
[c]:au[tocmd][c] {event} {pat} {cmd}
Add {cmd} to the list of commands Xulmus will execute on {event} for a URL matching {pat}:
If the *-javascript* (short name *-js*) option is specified, {cmd} is executed
as JavaScript code, with any supplied arguments available as variables.
Add {cmd} to the list of commands Xulmus will execute on {event} for a URL matching {pat}:
* [c]:autocmd[!][c] {events} {pat}: list/remove autocommands filtered by {events} and {pat}
* [c]:autocmd[!][c] {events}: list/remove autocommands matching {events}
* [c]:autocmd[!][c] * {pat}: list/remove autocommands matching {pat}

View File

@@ -110,6 +110,15 @@ ________________________________________________________________________________
List all installed extensions.
________________________________________________________________________________
|:exto| |:extoptions| +
|:extp| |:extpreferences| +
||:exto[ptions][!] {extension}|| +
||:extp[references][!] {extension}|| +
________________________________________________________________________________
Open the preferences dialog for an extension. If [!] is given, open a dialog,
otherwise open a buffer. See also 'newtab'.
________________________________________________________________________________
section:Sidebar[sidebar]
|:dpcl| |:dpclose| +

View File

@@ -100,7 +100,7 @@ section:Normal{nbsp}mode[normal-index]
||[m]o[m]|| Open one or more URLs +
||[m]p[m]|| Open (put) a URL based on the current clipboard contents in the current buffer +
||[m]q[m]|| Record a key sequence into a macro +
||[m]r[m]|| Reload current web page +
||[m]r[m]|| Reload the current web page +
||[m]t[m]|| Open one or more URLs in a new tab +
||[m]u[m]|| Undo closing of a tab +
||[m]y[m]|| Yank current location to the clipboard +
@@ -225,6 +225,7 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
||[c]:extdisable[c]||
||[c]:extenable[c]||
||[c]:extensions[c]|| List all installed extensions +
||[c]:extoptions[c]||
||[c]:exusage[c]|| List all Ex commands with a short description +
||[c]:filter[c]|| Filter and show the tracks as a view +
||[c]:finish[c]|| Stop sourcing a script file +

View File

@@ -1,21 +1,25 @@
heading:Key{nbsp}mappings,{nbsp}abbreviations,{nbsp}and{nbsp}user-defined{nbsp}commands.[]
section:Key{nbsp}mapping[key-mapping,mapping,macro]
section:Key{nbsp}mapping[key-mapping,mapping,map,macro]
The key mapping commands can be used to either redefine the standard key
bindings or define new ones. A mapping consists of a key, or sequence of keys,
which are translated to a string of characters. Example:
bindings or define new ones. A mapping consists of a key, or [j]key-sequence[j],
which is translated to a string of characters. Example:
\{nbsp}[c]:map <F2> :echo new Date().toDateString()<CR>[c]
will echo the current date to the command line when [m]<F2>[m] is pressed.
There are separate key mapping tables for each of the Normal, Insert, and
Command-line modes.
|:map-modes| +
Keys can be mapped in four distinct modes:
Please note that, unlike Vim and other applications, mappings containing
the Shift key are specified with the capital letter, so e.g. [m]<C-n>[m] is
different from [m]<C-N>[m], the latter being the only way to map Shift-Ctrl-n.
* Normal mode: When browsing normally --
* Visual mode: When selecting text with the cursor keys --
* Insert mode: When interacting with text fields on a website --
* Command-line mode: When typing into the Xulmus command line. --
Warning: Mappings are NOT saved between sessions, make sure you put them in your
xulmusrc file!
subsection:Map{nbsp}commands[:map-commands]
@@ -30,11 +34,8 @@ subsection:Map{nbsp}commands[:map-commands]
|:cm| |:cmap|
||:cm[ap] {lhs} {rhs}|| +
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} for the applicable mode(s). The {rhs} is
Map the [j]key-sequence[j] {lhs} to {rhs} for the applicable mode(s). The {rhs} is
remapped, allowing for nested and recursive mappings.
Warning: Mappings are NOT saved between sessions, make sure you put them in your
vimperatorrc file!
________________________________________________________________________________
@@ -49,7 +50,7 @@ ________________________________________________________________________________
|:cno| |:cnoremap|
||:cno[remap] {lhs} {rhs}|| +
________________________________________________________________________________
Map the key sequence {lhs} to {rhs} for the applicable mode(s). No remapping of
Map the [j]key-sequence[j] {lhs} to {rhs} for the applicable mode(s). No remapping of
the {rhs} is performed.
________________________________________________________________________________
@@ -122,16 +123,6 @@ When the first argument to one of the mapping commands is [c]<silent>[c], {rhs}
is not echoed to the command line, nor, for that matter, anything else until
the command has completed.
subsection:Mapping{nbsp}and{nbsp}modes[:map-modes]
Keys can be mapped in four distinct modes:
* Normal mode
* Visual mode
* Insert mode
* Command-line mode
|map-overview| |map-modes| +
Below is an overview of which modes each map command applies to:
@@ -143,6 +134,45 @@ Below is an overview of which modes each map command applies to:
:imap :inoremap :iunmap :imapclear - Insert mode
:cmap :cnoremap :cunmap :cmapclear - Command-line mode
subsection:Key{nbsp}sequences[:<>,key-sequence]
For most keys, the key-sequence is the same as the character you see when you
type that key, however there are some exceptions which allow for a much larger
number of keys to be used in mappings.
* [c]<lt>[c], [c]\<[c], [c]<Space>[c], [c]\ [c] allow a literal [c]<[c] or space character.
* [c]\'[c], [c]\"[c] and [c]\\[c] must be used to avoid escaping issues when mapping a quote or backslash.
* [c]<Left>[c] [c]<Right>[c] [c]<Up>[c] [c]<Down>[c] [c]<PageUp>[c] [c]<PageDown>[c] [c]<Esc>[c] [c]<CR>[c] (for carriage return/enter)
* [c]<CapsLock>[c] [c]<NumLock>[c] [c]<Ins>[c] [c]<Del>[c] [c]<Tab>[c] [c]<BS>[c] (for a backspace)
* [c]<F1>[c] through [c]<F12>[c] work as expected
Most keyboards have some modifiers such as the control, alt or meta keys. In
order to create a mapping that uses these keys the correct prefix must be used
within the angle brackets.
* [c]<C-x>[c]: The control or ctrl key.
* [c]<A-x>[c]: The alt key.
* [c]<M-x>[c]: The meta key, windows key, or command key
* [c]<S-x>[c]: The shift key.
These prefixes can be combined however you see fit, though you should note that
within angle brackets all alphabetic characters are read as lowercase. In order
to force them to be uppercase, you must specify the S- prefix as well.
Additionally, you should never use the S- prefix with a number of piece of
punctuation, even if you require a shift to type that character; doing so will
give you a mapping that cannot be typed. With non-character keys, tab and
space, the S- modifier works just like C- A- and M-. Some examples may clarify
the situation:
* [c]xc[c]: type x, and then type c
* [c]<C-x>c[c]: hold control and type x, then type c without control
* [c]<C-2>[c]: type 2 while holding control
* [c]<C-@>[c]: type @ while holding control
* [c]<S-Space>[c]: press space while holding shift
* [c]<C-A-j>[c]: press j while holding control and alt
* [c]<C-A-J>[c]: exactly the same as above
* [c]<C-A-S-j>[c]: press J while holding control and alt
subsection:Special{nbsp}characters[:map-special-chars]
|<Nop>| +

View File

@@ -554,6 +554,7 @@ The possible values:
*all* All commands
*addons* [c]:addo[ns][c] command
*downloads* [c]:downl[oads][c] command
*extoptions* [c]:exto[ptions][c] command
*help* [c]:h[elp][c] command
*javascript* [c]:javascript![c] or [c]:js![c] command
*prefs* [c]:pref[erences]![c] or [c]:prefs![c] command
@@ -766,7 +767,8 @@ Set the separator regex used to separate multiple URL args. Multiple arguments
can be specified for [c]:open[c], and similar commands, using this regex as
the separator. Using whitespace alone is not generally useful since it is often
contained in a single argument. E.g. [c]:open linus torvalds[c] should perform
a single search for the key words "linus" and "torvalds"
a single search for the key words "linus" and "torvalds". If this is set to the
empty string then these arguments will never be split.
____

View File

@@ -10,7 +10,7 @@ E.g firefox -liberator "\++cmd=\'set exrc' +u=\'tempRcFile' \++noplugin"
||+c={command}||
________________________________________________________________________________
Execute a single Ex command after all initialization has been performed. See
help:initialization[starting.html#Initialization].
[j]initialization[j].
________________________________________________________________________________
@@ -18,7 +18,7 @@ ________________________________________________________________________________
||\++cmd={command}||
________________________________________________________________________________
Execute a single Ex command before any initialization has been performed. See
help:initialization[starting.html#Initialization].
[j]initialization[j].
________________________________________________________________________________

View File

@@ -37,7 +37,7 @@ duplicate the tab [count] times.
________________________________________________________________________________
//TODO: should the tab commands be moved back here?
See help::open[browsing.html#opening] for other ways to open new tabs.
See [j]opening[j] for other ways to open new tabs.
section:Changing{nbsp}tabs[changing-tabs]