mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-03-08 02:05:45 +01:00
Major documentation updates and formatting fixes, and many, many other changes thanks to an MQ glitch, including:
* Significant completion speed improvements * Significantly improve startup speed, in large part by lazily instantiating Options and Commands, lazily installing highlight stylesheets, etc. * Update logos and icons, fix atrocious about page * Fix Teledactyl * JavaScript completion now avoids accessing property values * Add Option#persist to define which options are saved with :mkp * Add new Dactyl component which holds add-on-specific configuration information and removes need for separate components for each dactyl host * Several fixes for latest nightlies * Significant code cleanup and many bug fixes --HG-- rename : muttator/AUTHORS => teledactyl/AUTHORS rename : muttator/Donors => teledactyl/Donors rename : muttator/Makefile => teledactyl/Makefile rename : muttator/NEWS => teledactyl/NEWS rename : muttator/TODO => teledactyl/TODO rename : muttator/chrome.manifest => teledactyl/chrome.manifest rename : muttator/components/commandline-handler.js => teledactyl/components/commandline-handler.js rename : muttator/components/protocols.js => teledactyl/components/protocols.js rename : muttator/content/addressbook.js => teledactyl/content/addressbook.js rename : muttator/content/compose/compose.js => teledactyl/content/compose/compose.js rename : muttator/content/compose/compose.xul => teledactyl/content/compose/compose.xul rename : muttator/content/compose/dactyl.dtd => teledactyl/content/compose/dactyl.dtd rename : muttator/content/compose/dactyl.xul => teledactyl/content/compose/dactyl.xul rename : muttator/content/config.js => teledactyl/content/config.js rename : muttator/content/dactyl.dtd => teledactyl/content/dactyl.dtd rename : muttator/content/logo.png => teledactyl/content/logo.png rename : muttator/content/mail.js => teledactyl/content/mail.js rename : muttator/content/muttator.xul => teledactyl/content/pentadactyl.xul rename : muttator/contrib/vim/Makefile => teledactyl/contrib/vim/Makefile rename : muttator/contrib/vim/ftdetect/muttator.vim => teledactyl/contrib/vim/ftdetect/muttator.vim rename : muttator/contrib/vim/mkvimball.txt => teledactyl/contrib/vim/mkvimball.txt rename : muttator/contrib/vim/syntax/muttator.vim => teledactyl/contrib/vim/syntax/muttator.vim rename : muttator/install.rdf => teledactyl/install.rdf rename : muttator/locale/en-US/Makefile => teledactyl/locale/en-US/Makefile rename : muttator/locale/en-US/all.xml => teledactyl/locale/en-US/all.xml rename : muttator/locale/en-US/autocommands.xml => teledactyl/locale/en-US/autocommands.xml rename : muttator/locale/en-US/gui.xml => teledactyl/locale/en-US/gui.xml rename : muttator/locale/en-US/intro.xml => teledactyl/locale/en-US/intro.xml rename : muttator/skin/icon.png => teledactyl/skin/icon.png
This commit is contained in:
Kris Maglione
@@ -6,102 +6,127 @@
|
||||
<document
|
||||
name="hints"
|
||||
title="&dactyl.appname; Hints"
|
||||
xmlns="http://vimperator.org/namespaces/liberator"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml">
|
||||
xmlns="&xmlns.dactyl;"
|
||||
xmlns:html="&xmlns.html;">
|
||||
<h1 tag="quick-hints hints">Hints</h1>
|
||||
<toc start="2"/>
|
||||
|
||||
Hints are the way in which &dactyl.appname; allows you to follow links on a page. By
|
||||
providing each link with a suitable hint, you can access all links with a
|
||||
similar amount of minimal effort. This contrasts strongly with the traditional
|
||||
approaches offered by the mouse, in which you must first find and then aim for
|
||||
the link you would like, and by using repeated tabbing which quickly becomes
|
||||
tedious unless you always visit the first link on a page.
|
||||
<p>
|
||||
Hints are an easy way to interact with web pages without using
|
||||
your mouse. In hint 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
|
||||
selected link, other actions are available, including saving the
|
||||
resulting link, copying its URL, or saving an image. For each
|
||||
of these actions, only the set of applicable elements is
|
||||
highlighted.
|
||||
</p>
|
||||
|
||||
<item>
|
||||
<tags>f</tags>
|
||||
<tags>quick-hints</tags>
|
||||
<tags>f QuickHint</tags>
|
||||
<strut/>
|
||||
<spec>f<a>hint</a></spec>
|
||||
<description>
|
||||
<p>
|
||||
Start QuickHint mode. In QuickHint mode, every hintable item
|
||||
(according to the <o>hinttags</o> XPath query) is assigned a
|
||||
unique number. You can either type this number or type part of the
|
||||
link text as specified by the <o>hintmatching</o> option, and it
|
||||
is followed as soon as it can be uniquely identified. Often it can
|
||||
be useful to combine these techniques to narrow down results with
|
||||
some letters, and then typing a single digit to make the match
|
||||
unique. Pressing <k name="Leader"/> (defaults to
|
||||
<ex>:let mapleader = "\"</ex>) toggles "escape-mode", where numbers are
|
||||
treated as normal text. <k name="Esc"/> stops this mode at any
|
||||
time.
|
||||
Start <t>QuickHint</t> mode. In this mode, every clickable
|
||||
element (as definied by the <o>hinttags</o> option) is
|
||||
highlighted and numbered. Elements can be selected
|
||||
either by typing their number, or by typing part of
|
||||
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 QuickHint mode:
|
||||
</p>
|
||||
<dl>
|
||||
<dt><k name="Return"/></dt>
|
||||
<dd>Selects the first highlighted element, or that
|
||||
fucused by <k name="Tab"/>.</dd>
|
||||
|
||||
<dt><k name="Tab"/></dt>
|
||||
<dd>Moves the focus to the next hintable element</dd>
|
||||
|
||||
<dt><k name="Leader"/></dt>
|
||||
<dd>Temporarilly treats all numbers as ordinary text</dd>
|
||||
|
||||
<dt><k name="Esc"/></dt>
|
||||
<dd>Exitts hint mode without selecting an element</dd>
|
||||
</dl>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
|
||||
<item>
|
||||
<tags>F</tags>
|
||||
<strut/>
|
||||
<spec>F<a>hint</a></spec>
|
||||
<description>
|
||||
<p>
|
||||
Start QuickHint mode, but open link in a new tab. Like normal QuickHint
|
||||
mode (activated with <k>f</k>) but opens the link in a new tab. The new
|
||||
tab will be loaded in background according to the
|
||||
<str>browser.tabs.loadInBackground</str> &dactyl.host; preference.
|
||||
Start <t>QuickHint</t> mode, but the selected elements
|
||||
are clicked with the <k name="Shift"/> key pressed,
|
||||
which has the normal effect of opening it in a new tab
|
||||
(depending on the value of the
|
||||
<pref>browser.tabs.loadInBackground</pref> preference).
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
|
||||
<tags>extended-hints</tags>
|
||||
|
||||
<item>
|
||||
<tags>;</tags>
|
||||
<spec>;<a>mode</a><a>empty</a><a>hint</a></spec>
|
||||
<tags>extended-hints</tags>
|
||||
<tags>; ExtendedHint</tags>
|
||||
<strut/>
|
||||
<spec>;<a>mode</a><a>hint</a></spec>
|
||||
<description>
|
||||
<p>
|
||||
Start an extended hint mode. ExtendedHint mode is useful for
|
||||
performing operations on hinted elements other than the default
|
||||
left mouse click. For example, you can yank link locations, open
|
||||
them in a new window or save images. If you want to yank the
|
||||
location of hint <em>24</em>, press <k>;y</k> to start this hint
|
||||
mode. Then press <em>24</em> to copy the hint location.
|
||||
Start an extended hint mode. <t>ExtendedHint</t> mode is
|
||||
exactly like <t>QuickHint</t> mode, 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 extend hint modes available,
|
||||
after pressing <k>;</k>, pressing <k name="Tab"/> brings
|
||||
up the <k>completion-list</k> with a list of each hint
|
||||
mode and its description.
|
||||
</p>
|
||||
|
||||
<p><a>mode</a> can be one of:</p>
|
||||
<p><a>mode</a> may be one of:</p>
|
||||
|
||||
<ul>
|
||||
<li><tag>;;</tag> <em>;</em> to focus a link and hover it with the mouse</li>
|
||||
<li><tag>;?</tag> <em>?</em> to show information about the element (incomplete)</li>
|
||||
<li><tag>;s</tag> <em>s</em> to save its destination</li>
|
||||
<li><tag>;a</tag> <em>a</em> to save its destination (prompting for save location)</li>
|
||||
<li><tag>;f</tag> <em>f</em> to focus a frame</li>
|
||||
<li><tag>;o</tag> <em>o</em> to open its location in the current tab</li>
|
||||
<li><tag>;t</tag> <em>t</em> to open its location in a new tab</li>
|
||||
<li><tag>;b</tag> <em>b</em> to open its location in a new background tab</li>
|
||||
<li><tag>;w</tag> <em>w</em> to open its destination in a new window</li>
|
||||
<li><tag>;F</tag> <em>F</em> to follow a sequence of <k name="CR"/>-delimited hints in background tabs</li>
|
||||
<li><tag>;O</tag> <em>O</em> to generate an <ex>:open</ex> with hint's URL (like <k>O</k>)</li>
|
||||
<li><tag>;T</tag> <em>T</em> to generate a <ex>:tabopen</ex> with hint's URL (like <k>T</k>)</li>
|
||||
<li><tag>;W</tag> <em>W</em> to generate a <ex>:winopen</ex> with hint's URL</li>
|
||||
<li><tag>;v</tag> <em>v</em> to view its destination source</li>
|
||||
<li><tag>;V</tag> <em>V</em> to view its destination source in the external editor</li>
|
||||
<li><tag>;y</tag> <em>y</em> to yank its destination location</li>
|
||||
<li><tag>;Y</tag> <em>Y</em> to yank its text description</li>
|
||||
<li><tag>;c</tag> <em>c</em> to open its context menu</li>
|
||||
<li><tag>;i</tag> <em>i</em> to open an image</li>
|
||||
<li><tag>;I</tag> <em>I</em> to open an image in a new tab.</li>
|
||||
<li tag=";;"><em>;</em> to focus a link and hover it with the mouse</li>
|
||||
<li tag=";?"><em>?</em> to show information about the element (incomplete)</li>
|
||||
<li tag=";s"><em>s</em> to save its destination</li>
|
||||
<li tag=";a"><em>a</em> to save its destination (prompting for save location)</li>
|
||||
<li tag=";f"><em>f</em> to focus a frame</li>
|
||||
<li tag=";o"><em>o</em> to open its location in the current tab</li>
|
||||
<li tag=";t"><em>t</em> to open its location in a new tab</li>
|
||||
<li tag=";b"><em>b</em> to open its location in a new background tab</li>
|
||||
<li tag=";w"><em>w</em> to open its destination in a new window</li>
|
||||
<li tag=";F"><em>F</em> to follow a sequence of <k name="CR"/>-delimited hints in background tabs</li>
|
||||
<li tag=";O"><em>O</em> to generate an <ex>:open</ex> with hint's URL (like <k>;O</k>)</li>
|
||||
<li tag=";T"><em>T</em> to generate a <ex>:tabopen</ex> with hint's URL (like <k>;T</k>)</li>
|
||||
<li tag=";W"><em>W</em> to generate a <ex>:winopen</ex> with hint's URL</li>
|
||||
<li tag=";v"><em>v</em> to view its destination source</li>
|
||||
<li tag=";V"><em>V</em> to view its destination source in the external editor</li>
|
||||
<li tag=";y"><em>y</em> to yank its destination location</li>
|
||||
<li tag=";Y"><em>Y</em> to yank its text description</li>
|
||||
<li tag=";c"><em>c</em> to open its context menu</li>
|
||||
<li tag=";i"><em>i</em> to open an image</li>
|
||||
<li tag=";I"><em>I</em> to open an image in a new tab.</li>
|
||||
</ul>
|
||||
|
||||
<!-- TODO: These are completely arbitrary and need to be
|
||||
- changed before release. Hopefully they will be...
|
||||
-->
|
||||
<p>
|
||||
Depending on the value of <o>complete</o>, you can get a list of
|
||||
extended hint modes by pressing <k name="Tab"/> from the <k>;</k>
|
||||
prompt.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Hintable elements for all extended hint modes can be set in the
|
||||
<o>extendedhinttags</o> XPath string.
|
||||
Of the previous modes, the value of the <o>hinttags</o>
|
||||
option os used to choose the highlighted elements for
|
||||
the modes, <k>;;</k>, <k>;?</k>, <k>;w</k>, <k>;v</k>,
|
||||
<k>;V</k>, <k>;Y</k> and <k>;c</k>. The value of
|
||||
<o>extendedhinttags</o> is used to choose the elements
|
||||
for, <k>;s</k>, <k>;a</k>, <k>;o</k>, <k>;t</k>,
|
||||
<k>;b</k>, <k>;O</k>, <k>;T</k>, <k>;W</k>, <k>;y</k>,
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
Reference in New Issue
Block a user