common/locale/en-US/gui.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="gui"
   8     title="&dactyl.appName; GUI"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:dactyl="&xmlns.dactyl;"
  11     xmlns:html="&xmlns.html;">
  12
  13 <h1 tag="gui">&dactyl.host;'s GUI</h1>
  14 <toc start="2"/>
  15
  16 <p>
  17     Although &dactyl.appName; offers access to the most frequently used
  18     &dactyl.host; functionality via Ex and Normal mode commands, there may be
  19     times when direct access to the &dactyl.host; GUI is required. For such
  20     eventualities, there are commands to access menu items and to launch
  21     standard &dactyl.host; dialogs.
  22 </p>
  23
  24 <h2 tag="menu">Menus</h2>
  25
  26 <item>
  27     <tags>:emenu</tags>
  28     <strut/>
  29     <spec>:emenu <a>menu</a></spec>
  30     <description>
  31         <p>
  32             Execute <a>menu</a> from the command line. This command provides command-line access
  33             to all menu items available from the main &dactyl.host; menubar. <a>menu</a> is a
  34             hierarchical path to the menu item with each submenu separated by a period.
  35             E.g. <ex>:emenu File.Open File…</ex> launches the standard
  36             &dactyl.host; ‘Open File’ dialog.
  37         </p>
  38     </description>
  39 </item>
  40
  41 <h2 tag="dialogs">Dialogs</h2>
  42
  43 <item>
  44     <tags>:ao :addo :addons</tags>
  45     <strut/>
  46     <spec>:addo<oa>ns</oa></spec>
  47     <description>
  48         <p>Opens the add-on list.</p>
  49     </description>
  50 </item>
  51
  52 <item>
  53     <tags>:dia :dialog</tags>
  54     <spec>:dia<oa>log</oa> <oa>&dactyl.host;-dialog</oa></spec>
  55     <description>
  56         <p>Open a &dactyl.host; dialog. Available dialogs include:</p>
  57
  58         <dl tag="dialog-list"/>
  59     </description>
  60 </item>
  61
  62 <item>
  63     <tags>:dl :downl :downloads</tags>
  64     <strut/>
  65     <spec>:downl<oa>oads</oa></spec>
  66     <description>
  67         <p>
  68             Show progress of current downloads. Here, downloads can
  69             be paused, resumed, and canceled.
  70         </p>
  71
  72         <p>Available options include:</p>
  73
  74         <dl>
  75             <dt>-sort</dt> <dd>Sort order (see <o>downloadsort</o>) (short name: <em>-s</em>)</dd>
  76         </dl>
  77     </description>
  78 </item>
  79
  80 <item>
  81     <tags>:dlc :dlclear</tags>
  82     <strut/>
  83     <spec>:dlc<oa>lear</oa></spec>
  84     <description>
  85         <p>Clear completed downloads.</p>
  86     </description>
  87 </item>
  88
  89 <h2 tag="extensions add-ons">Add-ons</h2>
  90
  91 <p>
  92     The following commands manipulate the currently installed
  93     add-ons. With the exception of <ex>:extadd</ex>, they all except
  94     the following arguments:
  95 </p>
  96
  97 <dl>
  98     <dt>-types</dt> <dd>The types of add-ons to operate on, the most
  99         common types being <tt>extension</tt>, <tt>theme</tt>, and <tt>plugin</tt> (short names <em>-type</em>,
 100         <em>-t</em>)</dd>
 101 </dl>
 102
 103 <item>
 104     <tags>:exta :extadd</tags>
 105     <spec>:exta<oa>dd</oa> <a>file|url</a></spec>
 106     <strut/>
 107     <description>
 108         <p>
 109             Install an extension. <a>file|uri</a> must be the local file
 110             path or URL of an XPInstall (.xpi) file.
 111         </p>
 112     </description>
 113 </item>
 114
 115 <item>
 116     <tags>:extde :extdelete</tags>
 117     <spec>:extde<oa>lete</oa> <a>extension</a></spec>
 118     <spec>:extde<oa>lete</oa>!</spec>
 119     <strut/>
 120     <description>
 121         <p>
 122             Uninstall an extension. <a>extension</a> is the extension's name. When <oa>!</oa> is given
 123             all extensions are uninstalled.
 124         </p>
 125     </description>
 126 </item>
 127
 128 <item>
 129     <tags>:extd :extdisable</tags>
 130     <spec>:extd<oa>isable</oa> <a>extension</a></spec>
 131     <spec>:extd<oa>isable</oa>!</spec>
 132     <strut/>
 133     <description>
 134         <p>
 135             Disable an extension. <a>extension</a> is the extension's name. When <oa>!</oa> is given
 136             all extensions are disabled.
 137         </p>
 138     </description>
 139 </item>
 140
 141 <item>
 142     <tags>:exte :extenable</tags>
 143     <spec>:exte<oa>nable</oa> <a>extension</a></spec>
 144     <spec>:exte<oa>nable</oa>!</spec>
 145     <strut/>
 146     <description>
 147         <p>
 148             Enable an extension. <a>extension</a> is the extension's name. When <oa>!</oa> is given all
 149             extensions are enabled.
 150         </p>
 151     </description>
 152 </item>
 153
 154 <item>
 155     <tags>:exto :extoptions</tags>
 156     <spec>:exto<oa>ptions</oa><oa>!</oa> <a>extension</a></spec>
 157     <tags>:extp :extpreferences</tags>
 158     <spec>:extp<oa>references</oa><oa>!</oa> <a>extension</a></spec>
 159     <description>
 160         <p>
 161             Open the preferences dialog for an extension. If <oa>!</oa> is given, open a dialog,
 162             otherwise open a buffer. See also <o>newtab</o>.
 163         </p>
 164     </description>
 165 </item>
 166
 167 <item>
 168     <tags>:extr :extrehash</tags>
 169     <spec>:extr<oa>ehash</oa> <a>extension</a></spec>
 170     <spec>:extr<oa>ehash</oa></spec>
 171     <description>
 172         <p>
 173             Toggle an extension's enabled status twice. This is useful for rebooting
 174             a restartless extension.
 175         </p>
 176     </description>
 177 </item>
 178
 179 <item>
 180     <tags>:extt :exttoggle</tags>
 181     <spec>:extt<oa>oggle</oa> <a>extension</a></spec>
 182     <spec>:extt<oa>oggle</oa></spec>
 183     <description>
 184         <p>
 185             Toggle an extension's enabled status.
 186         </p>
 187     </description>
 188 </item>
 189
 190 <item>
 191     <tags>:extu :extupdate</tags>
 192     <spec>:extu<oa>pdate</oa> <a>extension</a></spec>
 193     <spec>:extu<oa>pdate</oa><oa>!</oa></spec>
 194     <description>
 195         <p>
 196             Update an extension. When <oa>!</oa> is given, update all
 197             extensions.
 198         </p>
 199     </description>
 200 </item>
 201
 202 <h2 tag="sidebar">Sidebar</h2>
 203
 204 <item>
 205     <tags>:sbcl :sbclose</tags>
 206     <spec>:sbcl<oa>ose</oa></spec>
 207     <description short="true">
 208         <p>Close the sidebar window.</p>
 209     </description>
 210 </item>
 211
 212 <item>
 213     <tags>:sbope :sbopen :sb :sbar :sideb :sidebar</tags>
 214     <spec>:sidebar <a>name</a></spec>
 215     <description>
 216         <p>
 217             Open the sidebar window. <a>name</a> is any of the menu items listed under the
 218             standard &dactyl.host; View->Sidebar menu. Add-ons, Preferences and Downloads are
 219             also available in the sidebar.
 220         </p>
 221     </description>
 222 </item>
 223 <item>
 224     <spec>:sidebar! <oa>name</oa></spec>
 225     <description>
 226         <p>
 227             Toggle the sidebar window. When <oa>name</oa> is provided, the
 228             semantics are as follows: If the named sidebar is currently open,
 229             it is closed. Otherwise the named sidebar is opened. When
 230             <oa>name</oa> is not provided, the semantics are as follows: If the
 231             sidebar is currently open, it is closed. Otherwise the previously
 232             open sidebar panel is re-opened.
 233         </p>
 234     </description>
 235 </item>
 236
 237
 238 <h2 tag="status-line status-bar">Status line</h2>
 239
 240 <p>
 241     The status line appears at the bottom of each window. You can use
 242     <o>guioptions</o> to specify if and when the status line appears, as well
 243     as its relation to the command line and messages.
 244 </p>
 245
 246 <p>
 247     The status line contains several fields that provide information about the
 248     state of the current buffer. These are, in order:
 249 </p>
 250
 251 <ul>
 252     <li>
 253         <em>URL</em>: The URL of the currently loaded page. While the page is loading,
 254         progress messages are also output to this field.
 255     </li>
 256     <li>
 257         <em>History and bookmark status</em> (<tt>[+-❤⋯]</tt>): The position
 258         of the current page in the tab's session history; <tt>-</tt> and
 259         <tt>+</tt> indicate that it is possible to move backwards and forwards
 260         through the history respectively. ❤ indicates that the current page is
 261         bookmarked. Any other character indicates a QuickMark matching the
 262         current page.
 263     </li>
 264     <li>
 265         <em>Tab index</em> (<tt>[N/M]</tt>): <tt>N</tt> is the index of the
 266         currently selected tab and <tt>M</tt> is the total number of tabs in
 267         the current window.
 268     </li>
 269     <li>
 270         <em>Vertical scroll</em>: The vertical scroll percentage of the current buffer,
 271         or Top or Bot for the top and bottom of the buffer respectively.
 272     </li>
 273     <li>
 274         <em>Security</em>: The security information button is displayed when appropriate
 275         as per &dactyl.host;. The color of the status bar also changes to reflect the
 276         current security status of the loaded page.
 277         <dl>
 278             <dt style="border:1px solid white" dactyl:highlight="StatusLineNormal">black</dt>
 279             <dd>The site's identity is unverified and the connection is unencrypted</dd>
 280
 281             <dt style="border:1px solid white" dactyl:highlight="StatusLineBroken">red</dt>
 282             <dd>The connection is encrypted, but the site's identity has not been verified or it contains unencrypted content</dd>
 283
 284             <dt style="border:1px solid white" dactyl:highlight="StatusLineSecure">blue</dt>
 285             <dd>The site's domain has been verified and the connection is encrypted</dd>
 286
 287             <dt style="border:1px solid white" dactyl:highlight="StatusLineExtended">green</dt>
 288             <dd>The site's domain and owner have been fully verified via an Extended Validation certificate and the connection is encrypted</dd>
 289         </dl>
 290     </li>
 291     <li>
 292         <em>Extensions</em>: Any extension buttons that would normally be installed to the
 293         &dactyl.host; status bar are appended to the end of the status line.
 294     </li>
 295 </ul>
 296
 297 <h2 tag="toolbar">Toolbars</h2>
 298
 299 <item>
 300     <tags>:tbs :tbshow :toolbars :toolbarshow</tags>
 301     <spec>:toolbarshow <a>name</a></spec>
 302     <description>
 303         <p>Shows the named toolbar.</p>
 304     </description>
 305 </item>
 306
 307 <item>
 308     <tags>:tbh :tbhide :toolbarh  :toolbarhide</tags>
 309     <spec>:toolbarhide <a>name</a></spec>
 310     <description>
 311         <p>Hides the named toolbar.</p>
 312     </description>
 313 </item>
 314
 315 <item>
 316     <tags>:tbt :tbtoggle :toolbart :toolbartoggle</tags>
 317     <spec>:toolbartoggle <a>name</a></spec>
 318     <description>
 319         <p>Toggles the named toolbar.</p>
 320     </description>
 321 </item>
 322
 323 </document>
 324
 325 <!-- vim:se sts=4 sw=4 et: -->