common/locale/en-US/hints.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
   3
   4 <!DOCTYPE document SYSTEM "dactyl://content/dtd">
   5
   6 <document
   7     name="hints"
   8     title="&dactyl.appName; Hints"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:html="&xmlns.html;">
  11
  12 <h1 tag="quick-hints hints">Hints</h1>
  13 <toc start="2"/>
  14
  15 <p>
  16     Hints are an easy way to interact with web pages without using
  17     your mouse. In hint mode, &dactyl.appName; highlights and
  18     numbers all clickable elements. The elements can be selected
  19     either by typing their numbers, or typing parts of their text to
  20     narrow them down. While the default action is to click the
  21     selected link, other actions are available, including saving the
  22     resulting link, copying its URL, or saving an image. For each
  23     of these actions, only the set of applicable elements is
  24     highlighted.
  25 </p>
  26
  27 <item>
  28     <tags>quick-hints</tags>
  29     <tags>f QuickHint</tags>
  30     <strut/>
  31     <spec>f<a>hint</a></spec>
  32     <description>
  33         <p>
  34             Start <t>QuickHint</t> mode. In this mode, every clickable
  35             element (as defined by the <o>hinttags</o> option) is
  36             highlighted and numbered.  Elements can be selected
  37             either by typing their number, or by typing part of
  38             their text to narrow down the result. When an element
  39             has been selected, it is automatically clicked and hint
  40             mode ends. Additionally, the following keys have
  41             special meanings in QuickHint mode:
  42         </p>
  43         <dl>
  44             <dt><k name="CR"/></dt>
  45             <dd>Selects the first highlighted element, or that
  46                 focused by <k name="Tab"/>.</dd>
  47
  48             <dt><k name="Tab"/></dt>
  49             <dd>Moves the focus to the next hintable element</dd>
  50
  51             <dt><k name="Leader"/></dt>
  52             <dd>Temporarily treats all numbers (or other keys, depending on the
  53                 value of <o>hintkeys</o>) as ordinary text</dd>
  54
  55             <dt><k name="Esc"/></dt>
  56             <dd>Exits hint mode without selecting an element</dd>
  57         </dl>
  58     </description>
  59 </item>
  60
  61 <item>
  62     <tags>F</tags>
  63     <strut/>
  64     <spec>F<a>hint</a></spec>
  65     <description>
  66         <p>
  67             Start <t>QuickHint</t> mode, but the selected elements
  68             are clicked with the <k name="Shift" link="false"/> key pressed,
  69             which has the normal effect of opening it in a new tab
  70             (depending on the value of the
  71             <pref>browser.tabs.loadInBackground</pref> preference).
  72         </p>
  73     </description>
  74 </item>
  75
  76 <item>
  77     <tags>extended-hints</tags>
  78     <tags>; ExtendedHint</tags>
  79     <strut/>
  80     <spec>;<a>mode</a><a>hint</a></spec>
  81     <description>
  82         <p>
  83             Start an extended hint mode. <t>ExtendedHint</t> mode is exactly
  84             like <t>QuickHint</t> mode, except that each sub-mode highlights a
  85             more specialized set of elements, and performs a unique action on
  86             the selected link. Because of the panoply of extended hint modes
  87             available, after pressing <k>;</k>, pressing <k name="Tab"/> brings
  88             up the completion list with each hint mode and its description.
  89         </p>
  90
  91         <p><a>mode</a> may be one of:</p>
  92
  93         <ul>
  94             <li tag=";;"><em>;</em> to focus a link</li>
  95             <li tag=";?"><em>?</em> to show information about the element (incomplete)</li>
  96             <li tag=";s"><em>s</em> to save its destination</li>
  97             <li tag=";f"><em>f</em> to focus a frame</li>
  98             <li tag=";F"><em>F</em> to focus a frame or pseudo-frame</li>
  99             <li tag=";o"><em>o</em> to open its location in the current tab</li>
 100             <li tag=";t"><em>t</em> to open its location in a new tab</li>
 101             <li tag=";b"><em>b</em> to open its location in a new background tab</li>
 102             <li tag=";w"><em>w</em> to open its destination in a new window</li>
 103             <li tag=";O"><em>O</em> to generate an <ex>:open</ex> prompt with hint’s URL</li>
 104             <li tag=";T"><em>T</em> to generate a <ex>:tabopen</ex> prompt with hint’s URL (like <k>;O</k>)</li>
 105             <li tag=";W"><em>W</em> to generate a <ex>:winopen</ex> prompt with hint’s URL (like <k>;T</k>)</li>
 106             <li tag=";a"><em>a</em> to add a bookmark</li>
 107             <li tag=";S"><em>S</em> to add a search keyword for the hint’s form</li>
 108             <li tag=";v"><em>v</em> to view its destination source</li>
 109             <li tag=";V"><em>V</em> to view its destination source in the external editor</li>
 110             <li tag=";y"><em>y</em> to yank its destination location</li>
 111             <li tag=";Y"><em>Y</em> to yank its text description</li>
 112             <li tag=";c"><em>c</em> to open its context menu</li>
 113             <li tag=";i"><em>i</em> to open an image</li>
 114             <li tag=";I"><em>I</em> to open an image in a new tab.</li>
 115         </ul>
 116
 117         <p>
 118             Of the previous modes, the value of the <o>hinttags</o>
 119             option is used to choose the highlighted elements,
 120             unless an override can be found in
 121             <o>extendedhinttags</o>.
 122         </p>
 123     </description>
 124 </item>
 125
 126 <item>
 127     <tags>g;</tags>
 128     <strut/>
 129     <spec>g;<a>mode</a><a>hint</a></spec>
 130     <description>
 131         <p>
 132             Start an extended hint mode and stay there until
 133             <k name="Esc"/> is pressed. Like <k>;</k>, except that
 134             after a hint is selected, hints remain visible so that
 135             another one can be selected with the same action as the
 136             first.
 137         </p>
 138     </description>
 139 </item>
 140
 141 </document>
 142
 143 <!-- vim:se sts=4 sw=4 et: -->