mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2025-12-20 07:28:00 +01:00
Further mode names normalisation in docs.
--HG-- extra : rebase_source : 6c4be66d8c4ac56d10e7d86fc45da7b80ff484aa
This commit is contained in:
@@ -13,7 +13,7 @@
|
||||
* inserted expansion string.
|
||||
*
|
||||
* Abbreviations have a left-hand side (LHS) whose text is replaced by that of
|
||||
* the right-hand side (RHS) when triggered by an input mode expansion key.
|
||||
* the right-hand side (RHS) when triggered by an Input mode expansion key.
|
||||
* E.g. an abbreviation with a LHS of "gop" and RHS of "Grand Old Party" will
|
||||
* replace the former with the latter.
|
||||
*
|
||||
|
||||
@@ -1432,7 +1432,7 @@ var CommandLine = Module("commandline", {
|
||||
mappings: function init_mappings() {
|
||||
|
||||
mappings.add([modes.COMMAND],
|
||||
[":"], "Enter command-line mode",
|
||||
[":"], "Enter Command Line mode",
|
||||
function () { CommandExMode().open(""); });
|
||||
|
||||
mappings.add([modes.INPUT_MULTILINE],
|
||||
|
||||
@@ -669,14 +669,14 @@ var Editor = Module("editor", {
|
||||
function () Events.PASS);
|
||||
|
||||
mappings.add([modes.INSERT],
|
||||
["<Space>", "<Return>"], "Expand insert mode abbreviation",
|
||||
["<Space>", "<Return>"], "Expand Insert mode abbreviation",
|
||||
function () {
|
||||
editor.expandAbbreviation(modes.INSERT);
|
||||
return Events.PASS_THROUGH;
|
||||
});
|
||||
|
||||
mappings.add([modes.INSERT],
|
||||
["<C-]>", "<C-5>"], "Expand insert mode abbreviation",
|
||||
["<C-]>", "<C-5>"], "Expand Insert mode abbreviation",
|
||||
function () { editor.expandAbbreviation(modes.INSERT); });
|
||||
|
||||
// text edit mode
|
||||
|
||||
@@ -396,7 +396,7 @@ var HintSession = Class("HintSession", CommandMode, {
|
||||
},
|
||||
|
||||
/**
|
||||
* Handle a hint mode event.
|
||||
* Handle a hints mode event.
|
||||
*
|
||||
* @param {Event} event The event to handle.
|
||||
*/
|
||||
@@ -774,7 +774,7 @@ var Hints = Module("hints", {
|
||||
hintSession: Modes.boundProperty(),
|
||||
|
||||
/**
|
||||
* Creates a new hint mode.
|
||||
* Creates a new hints mode.
|
||||
*
|
||||
* @param {string} mode The letter that identifies this mode.
|
||||
* @param {string} prompt The description to display to the user
|
||||
@@ -1245,7 +1245,7 @@ var Hints = Module("hints", {
|
||||
});
|
||||
|
||||
options.add(["hinttags", "ht"],
|
||||
"XPath or CSS selector strings of hintable elements for hint mode",
|
||||
"XPath or CSS selector strings of hintable elements for Hints mode",
|
||||
"stringlist", "input:not([type=hidden]),a[href],area,iframe,textarea,button,select," +
|
||||
"[onclick],[onmouseover],[onmousedown],[onmouseup],[oncommand]," +
|
||||
"[tabindex],[role=link],[role=button],[contenteditable=true]",
|
||||
|
||||
@@ -691,7 +691,7 @@ var Mappings = Module("mappings", {
|
||||
if (mode.char && !commands.get(mode.char + "map", true))
|
||||
addMapCommands(mode.char,
|
||||
[m.mask for (m in modes.mainModes) if (m.char == mode.char)],
|
||||
[mode.name]);
|
||||
mode.displayName);
|
||||
|
||||
let args = {
|
||||
getMode: function (args) findMode(args["-mode"]),
|
||||
|
||||
@@ -89,11 +89,11 @@
|
||||
</item>
|
||||
<h2 tag="autocmd-examples">Examples</h2>
|
||||
|
||||
<p>Enable <em>passthrough</em> mode on all Google sites:</p>
|
||||
<p>Enable <em>Pass Through</em> mode on all Google sites:</p>
|
||||
|
||||
<code><ex>:autocmd LocationChange</ex> <str delim="">google.com</str> <ex>:normal!</ex> <k name="C-z"/></code>
|
||||
|
||||
<p>Enable <em>passthrough</em> mode on <em>some</em> Google sites:</p>
|
||||
<p>Enable <em>Pass Through</em> mode on <em>some</em> Google sites:</p>
|
||||
|
||||
<code><ex>:autocmd LocationChange</ex> <str delim="'">^https?://(www|mail)\.google\.com/</str> <ex>:normal!</ex> <k name="C-z"/></code>
|
||||
|
||||
|
||||
@@ -9,11 +9,11 @@
|
||||
xmlns="&xmlns.dactyl;"
|
||||
xmlns:html="&xmlns.html;">
|
||||
|
||||
<h1 tag="command-line-mode command-line mode-cmdline">Command-line mode</h1>
|
||||
<h1 tag="command-line-mode command-line mode-cmdline">Command Line mode</h1>
|
||||
<toc start="2"/>
|
||||
|
||||
<p>
|
||||
&dactyl.appName;'s command-line mode is perhaps its most
|
||||
&dactyl.appName;'s Command Line mode is perhaps its most
|
||||
powerful interface. In this mode, the command input bar at the
|
||||
bottom of the window is given the keyboard focus for any of a
|
||||
variety of required inputs. In addition to access to almost
|
||||
@@ -27,9 +27,9 @@
|
||||
|
||||
<p>
|
||||
Included among the several command-line modes are Ex command
|
||||
mode (the standard mode for entering commands), find mode (for
|
||||
searching the current page), prompt mode (for selecting files,
|
||||
confirming actions), and hint mode (for selecting links and
|
||||
mode (the standard mode for entering commands), Find mode (for
|
||||
searching the current page), Prompt mode (for selecting files,
|
||||
confirming actions), and Hints mode (for selecting links and
|
||||
other items on a page).
|
||||
</p>
|
||||
|
||||
@@ -60,7 +60,7 @@
|
||||
<tags><![CDATA[c_<C-c>]]></tags>
|
||||
<spec><C-c></spec>
|
||||
<description short="true">
|
||||
<p>Quit Command-line mode without executing.</p>
|
||||
<p>Quit Command Line mode without executing.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
|
||||
@@ -148,7 +148,7 @@ precommit = <str delim="">python:common/contrib/fix_symlinks.py:fix_symlinks</st
|
||||
<p>
|
||||
See the <o>passkeys</o> option to automatically pass specific
|
||||
keys on sites of your choosing, or <t>autocmd-examples</t> to
|
||||
automatically enter <em>PASS THROUGH</em> mode for certain websites.
|
||||
automatically enter <em>Pass Through</em> mode for certain websites.
|
||||
</p>
|
||||
|
||||
<h3 tag="faq-passkeys-autocmd">Why doesn't my modes.passAllKeys autocmd work anymore?</h3>
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
<p>
|
||||
Hints are an easy way to interact with web pages without using
|
||||
your mouse. In hint mode, &dactyl.appName; highlights and
|
||||
your mouse. In Hints mode, &dactyl.appName; highlights and
|
||||
numbers all clickable elements. The elements can be selected
|
||||
either by typing their numbers, or typing parts of their text to
|
||||
narrow them down. While the default action is to click the
|
||||
@@ -38,7 +38,7 @@
|
||||
their text to narrow down the result. When an element
|
||||
has been selected, it is automatically clicked and hint
|
||||
mode ends. Additionally, the following keys have
|
||||
special meanings in hint mode:
|
||||
special meanings in Hints mode:
|
||||
</p>
|
||||
<dl>
|
||||
<dt><k name="CR"/></dt>
|
||||
@@ -53,7 +53,7 @@
|
||||
value of <o>hintkeys</o>) as ordinary text</dd>
|
||||
|
||||
<dt><k name="Esc"/></dt>
|
||||
<dd>Exits hint mode without selecting an element</dd>
|
||||
<dd>Exits Hints mode without selecting an element</dd>
|
||||
</dl>
|
||||
</description>
|
||||
</item>
|
||||
@@ -80,12 +80,12 @@
|
||||
<spec>;<a>mode</a><a>hint</a></spec>
|
||||
<description>
|
||||
<p>
|
||||
Start an extended hint mode. Extended hints are exactly like
|
||||
Start an extended Hints mode. Extended hints are exactly like
|
||||
<t>quick-hints</t>, except that each sub-mode highlights a
|
||||
more specialized set of elements, and performs a unique action on
|
||||
the selected link. Because of the panoply of extended hint modes
|
||||
available, after pressing <k>;</k>, pressing <k name="Tab"/> brings
|
||||
up the completion list with each hint mode and its description.
|
||||
up the completion list with each hints mode and its description.
|
||||
</p>
|
||||
|
||||
<p><a>mode</a> may be one of:</p>
|
||||
@@ -129,7 +129,7 @@
|
||||
<spec>g;<a>mode</a><a>hint</a></spec>
|
||||
<description>
|
||||
<p>
|
||||
Start an extended hint mode and stay there until
|
||||
Start an extended hints mode and stay there until
|
||||
<k name="Esc"/> is pressed. Like <k>;</k>, except that
|
||||
after a hint is selected, hints remain visible so that
|
||||
another one can be selected with the same action as the
|
||||
|
||||
@@ -26,9 +26,9 @@
|
||||
<p>
|
||||
Key mappings are the most basic means &dactyl.appName; provides
|
||||
for altering the actions of key presses. Each key mapping is
|
||||
associated with a mode, such as <link topic="insert-mode">insert</link>,
|
||||
<link>normal</link>, or
|
||||
<link topic="command-line-mode">command-line</link>, and only
|
||||
associated with a mode, such as <link topic="insert-mode">Insert</link>,
|
||||
<link>Normal</link>, or
|
||||
<link topic="command-line-mode">Command Line</link>, and only
|
||||
has effect when that mode is active. Although each mode has a
|
||||
full suite of internal mappings, they may be easily augmented,
|
||||
altered, or removed with the <ex>:map</ex> command and its
|
||||
@@ -54,17 +54,17 @@
|
||||
<dt>n</dt> <dd>Normal mode: When browsing normally</dd>
|
||||
<dt>v</dt> <dd>Visual mode: When selecting text with the cursor keys</dd>
|
||||
<dt>i</dt> <dd>Insert mode: When interacting with text fields on a website</dd>
|
||||
<dt>t</dt> <dd>TextEdit mode: When editing text fields in Vim-like NORMAL mode</dd>
|
||||
<dt>c</dt> <dd>Command-line mode: When typing into the &dactyl.appName; command line</dd>
|
||||
<dt>t</dt> <dd>Text Edit mode: When editing text fields in Vim-like Normal mode</dd>
|
||||
<dt>c</dt> <dd>Command Line mode: When typing into the &dactyl.appName; command line</dd>
|
||||
</dl>
|
||||
|
||||
<p>
|
||||
The ordinary <ex>:map</ex> and <ex>:noremap</ex> commands
|
||||
add mappings for normal and visual mode. In order to map key
|
||||
add mappings for Normal and Visual mode. In order to map key
|
||||
bindings in a different mode, any of the mapping commands may be
|
||||
prefixed with one of the above letters. For instance,
|
||||
<ex>:imap</ex> creates a new key mapping in insert mode, while
|
||||
<ex>:cunmap</ex> removes a key mapping from command-line mode.
|
||||
<ex>:imap</ex> creates a new key mapping in Insert mode, while
|
||||
<ex>:cunmap</ex> removes a key mapping from Command Line mode.
|
||||
Other modes can be specified using the -modes option described below.
|
||||
</p>
|
||||
|
||||
@@ -78,8 +78,8 @@
|
||||
<p tag="modes">
|
||||
The following tree represents all of the modes understood by
|
||||
dactyl. Mappings for a mode also apply to its children and
|
||||
descendants. So a mapping in the BASE mode, for instance, is
|
||||
also active in NORMAL and EX mode.
|
||||
descendants. So a mapping in the Base mode, for instance, is
|
||||
also active in Normal and Ex mode.
|
||||
</p>
|
||||
|
||||
&modes.tree;
|
||||
@@ -125,7 +125,7 @@
|
||||
<dt>:vmap :vnoremap :vunmap</dt> <dd>Visual mode</dd>
|
||||
<dt>:imap :inoremap :iunmap</dt> <dd>Insert mode</dd>
|
||||
<dt>:tmap :tnoremap :tunmap</dt> <dd>Text Edit mode</dd>
|
||||
<dt>:cmap :cnoremap :cunmap</dt> <dd>Command-line mode</dd>
|
||||
<dt>:cmap :cnoremap :cunmap</dt> <dd>Command Line mode</dd>
|
||||
</dl>
|
||||
|
||||
<note>
|
||||
@@ -470,9 +470,9 @@
|
||||
<spec>:ca<oa>bbreviate</oa></spec>
|
||||
<description>
|
||||
<p>
|
||||
Abbreviate a key sequence for Command-line mode. Same as
|
||||
Abbreviate a key sequence for Command Line mode. Same as
|
||||
<ex>:ab<oa>breviate</oa></ex>, but for
|
||||
<t>command-line</t> mode only.
|
||||
<t>Command Line</t> mode only.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -485,7 +485,7 @@
|
||||
<description>
|
||||
<p>
|
||||
Abbreviate a key sequence for Insert mode. Same as
|
||||
<ex>:ab<oa>breviate</oa></ex>, but for insert mode only.
|
||||
<ex>:ab<oa>breviate</oa></ex>, but for Insert mode only.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -505,9 +505,9 @@
|
||||
<spec>:cuna<oa>bbreviate</oa>!</spec>
|
||||
<description>
|
||||
<p>
|
||||
Remove abbreviation(s) for Command-line mode. Same as
|
||||
Remove abbreviation(s) for Command Line mode. Same as
|
||||
<ex>:una<oa>bbreviate</oa></ex>, but for
|
||||
<t>command-line</t> mode only.
|
||||
<t>Command Line</t> mode only.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
@@ -972,7 +972,7 @@
|
||||
</p>
|
||||
|
||||
<p>
|
||||
TextEdit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
|
||||
Text Edit mode can be entered with <k name="C-t" mode="I"/> from Insert mode.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
sensitive data.
|
||||
</p>
|
||||
|
||||
<h2 tag="private-mode porn-mode">Private mode browsing</h2>
|
||||
<h2 tag="private-mode porn-mode">Private browsing</h2>
|
||||
|
||||
<p>
|
||||
&dactyl.appName; fully supports &dactyl.host;'s private browsing mode.
|
||||
|
||||
@@ -262,7 +262,7 @@
|
||||
<p>
|
||||
Start Caret mode. This mode resembles the Vim's Normal mode where
|
||||
the text cursor is visible on the web page. The <k link="false">v</k> key
|
||||
enters visual mode, where text is selected as the cursor moves.
|
||||
enters Visual mode, where text is selected as the cursor moves.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
@@ -701,7 +701,7 @@ var JavaScript = Module("javascript", {
|
||||
modes.addMode("REPL", {
|
||||
description: "JavaScript Read Eval Print Loop",
|
||||
bases: [modes.COMMAND_LINE],
|
||||
displayName: "REPL"
|
||||
displayName: Class.memoize(function () this.name)
|
||||
});
|
||||
},
|
||||
commandline: function initCommandLine(dactyl, modules, window) {
|
||||
|
||||
@@ -301,7 +301,7 @@ Controller.prototype = {
|
||||
}),
|
||||
|
||||
/**
|
||||
* Returns dactyl to normal mode.
|
||||
* Returns dactyl to Normal mode.
|
||||
*/
|
||||
setNormalMode: wrapAssertNoErrors(function () {
|
||||
// XXX: Normal mode test
|
||||
@@ -313,9 +313,9 @@ Controller.prototype = {
|
||||
utils.assert("dactyl.setNormalMode", this.modules.modes.stack.length == 1,
|
||||
"Failed to return to Normal mode");
|
||||
|
||||
this.assertMessageWindowOpen(false, "Returning to normal mode: Multi-line output not closed");
|
||||
this.assertMessageLine(function (msg) !msg, "Returning to normal mode: Message not cleared");
|
||||
}, "Returning to normal mode"),
|
||||
this.assertMessageWindowOpen(false, "Returning to Normal mode: Multi-line output not closed");
|
||||
this.assertMessageLine(function (msg) !msg, "Returning to Normal mode: Message not cleared");
|
||||
}, "Returning to Normal mode"),
|
||||
|
||||
/**
|
||||
* Returns dactyl to Ex mode.
|
||||
|
||||
@@ -41,7 +41,7 @@
|
||||
etc.)
|
||||
</li>
|
||||
<li>
|
||||
<link topic="cmdline">Command-line mode</link>:
|
||||
<link topic="cmdline">Command Line mode</link>:
|
||||
Command-line editing.
|
||||
</li>
|
||||
<li>
|
||||
|
||||
@@ -48,8 +48,8 @@
|
||||
quotes, i.e., 'fo\o''bar' ⇒ fo\o'bar [b1]
|
||||
• The command line is now hidden by default. Added c, C, and M to
|
||||
'guioptions'. [b4]
|
||||
• Hint mode improvements, including:
|
||||
- Added g; continued extended hint mode, which allows
|
||||
• Hints mode improvements, including:
|
||||
- Added g; continued extended hints mode, which allows
|
||||
selecting multiple hints. Removed ;F. [b1]
|
||||
- Hints are now updated after scrolling and window resizing. [b3]
|
||||
- ;s now prompts for a filename on the command-line rather
|
||||
|
||||
@@ -117,7 +117,7 @@ var Config = Module("config", ConfigBase, {
|
||||
LocationChange: "Triggered when changing tabs or when navigation to a new location",
|
||||
PageLoadPre: "Triggered after a page load is initiated",
|
||||
PageLoad: "Triggered when a page gets (re)loaded/opened",
|
||||
PrivateMode: "Triggered when private mode is activated or deactivated",
|
||||
PrivateMode: "Triggered when private browsing mode is activated or deactivated",
|
||||
Sanitize: "Triggered when a sanitizeable item is cleared",
|
||||
ShellCmdPost: "Triggered after executing a shell command with :!cmd",
|
||||
Enter: "Triggered after Firefox starts",
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
<dt>LocationChange</dt> <dd>Triggered when changing tabs or when navigating to a new location</dd>
|
||||
<dt>PageLoadPre</dt> <dd>Triggered after a page load is initiated</dd>
|
||||
<dt>PageLoad</dt> <dd>Triggered when a page gets (re)loaded/opened</dd>
|
||||
<dt>PrivateMode</dt> <dd>Triggered when private mode is activated or deactivated</dd>
|
||||
<dt>PrivateMode</dt> <dd>Triggered when private browsing mode is activated or deactivated</dd>
|
||||
<dt>Sanitize</dt> <dd>Triggered when private data are sanitized</dd>
|
||||
<dt>ShellCmdPost</dt> <dd>Triggered after executing a shell command with <ex>:!</ex><a>cmd</a></dd>
|
||||
<dt>Enter</dt> <dd>Triggered after &dactyl.host; starts</dd>
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
etc.)
|
||||
</li>
|
||||
<li>
|
||||
<link topic="cmdline">Command-line mode</link>:
|
||||
<link topic="cmdline">Command Line mode</link>:
|
||||
Command-line editing.
|
||||
</li>
|
||||
<li>
|
||||
|
||||
@@ -47,7 +47,7 @@
|
||||
&dactyl.appName;'s power, like Vim's, comes from its modal interface. Keys have
|
||||
different meanings depending on which mode the browser is in. &dactyl.appName; has
|
||||
several modes, but the 2 most important are <em>Normal</em> mode and
|
||||
<em>Command-line</em> mode.
|
||||
<em>Command Line</em> mode.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
@@ -56,13 +56,13 @@
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The other core mode of &dactyl.appName;, Command-line mode, can be entered from
|
||||
The other core mode of &dactyl.appName;, Command Line mode, can be entered from
|
||||
Normal mode by typing a <k>:</k> (colon). You will frequently see &dactyl.appName;
|
||||
commands start with a <k>:</k>, indicating that what follows is a command.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To return to Normal mode from Command-line mode, type <k name="Esc"/>. Pressing
|
||||
To return to Normal mode from Command Line mode, type <k name="Esc"/>. Pressing
|
||||
<k name="Esc"/> will also return you to Normal mode from most other modes in
|
||||
&dactyl.appName;.
|
||||
</p>
|
||||
@@ -229,19 +229,19 @@
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The most common hint mode is called <t>quick-hints</t>.
|
||||
To activate QuickHint mode, press either <k>f</k> or <k>F</k>. The lower-case
|
||||
<k>f</k> will open the resulting link in the current tab, while the upper-case
|
||||
<k>F</k> will open it in a new tab.
|
||||
To activate Hints mode, press either <k>f</k> or <k>F</k>. The lower-case
|
||||
<k>f</k> will open the resulting link in the current tab, while the
|
||||
upper-case <k>F</k> will open it in a new tab.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To test it, try this link: <link topic="&dactyl.apphome;">&dactyl.appName; Homepage</link>.
|
||||
Activate QuickHint mode with <k>f</k> or <k>F</k> to highlight all currently
|
||||
Activate Hints mode with <k>f</k> or <k>F</k> to highlight all currently
|
||||
visible links. Then start typing the text of the link. The link should be
|
||||
uniquely identified soon, and &dactyl.appName; will open it. Once you're done,
|
||||
remember to use <k name="C-o"/> (<em>History Back</em>) or <k>d</k> (<em>Delete Buffer</em>)
|
||||
to return here, depending on which key you used to activate QuickHint mode.
|
||||
uniquely identified soon, and &dactyl.appName; will open it. Once you're
|
||||
done, remember to use <k name="C-o"/> (<em>History Back</em>) or <k>d</k>
|
||||
(<em>Delete Buffer</em>) to return here, depending on which key you used to
|
||||
activate Hints mode.
|
||||
</p>
|
||||
|
||||
<h2 tag="common-issues">Common issues</h2>
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
etc.)
|
||||
</li>
|
||||
<li>
|
||||
<link topic="cmdline">Command-line mode</link>:
|
||||
<link topic="cmdline">Command Line mode</link>:
|
||||
Command-line editing.
|
||||
</li>
|
||||
<li>
|
||||
|
||||
Reference in New Issue
Block a user