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     </description>
  72 </item>
  73
  74 <h2 tag="extensions add-ons">Add-ons</h2>
  75
  76 <item>
  77     <tags>:exta :extadd</tags>
  78     <spec>:exta<oa>dd</oa> <a>file|url</a></spec>
  79     <strut/>
  80     <description>
  81         <p>
  82             Install an extension. <a>file|uri</a> must be the local file
  83             path or URL of an XPInstall (.xpi) file.
  84         </p>
  85     </description>
  86 </item>
  87
  88 <item>
  89     <tags>:extde :extdelete</tags>
  90     <spec>:extde<oa>lete</oa> <a>extension</a></spec>
  91     <spec>:extde<oa>lete</oa>!</spec>
  92     <strut/>
  93     <description>
  94         <p>
  95             Uninstall an extension. <a>extension</a> is the extension's name. When <oa>!</oa> is given
  96             all extensions are uninstalled.
  97         </p>
  98     </description>
  99 </item>
 100
 101 <item>
 102     <tags>:extd :extdisable</tags>
 103     <spec>:extd<oa>isable</oa> <a>extension</a></spec>
 104     <spec>:extd<oa>isable</oa>!</spec>
 105     <strut/>
 106     <description>
 107         <p>
 108             Disable an extension. <a>extension</a> is the extension's name. When <oa>!</oa> is given
 109             all extensions are disabled.
 110         </p>
 111     </description>
 112 </item>
 113
 114 <item>
 115     <tags>:exte :extenable</tags>
 116     <spec>:exte<oa>nable</oa> <a>extension</a></spec>
 117     <spec>:exte<oa>nable</oa>!</spec>
 118     <strut/>
 119     <description>
 120         <p>
 121             Enable an extension. <a>extension</a> is the extension's name. When <oa>!</oa> is given all
 122             extensions are enabled.
 123         </p>
 124     </description>
 125 </item>
 126
 127 <item>
 128     <tags>:exto :extoptions</tags>
 129     <spec>:exto<oa>ptions</oa><oa>!</oa> <a>extension</a></spec>
 130     <tags>:extp :extpreferences</tags>
 131     <spec>:extp<oa>references</oa><oa>!</oa> <a>extension</a></spec>
 132     <description>
 133         <p>
 134             Open the preferences dialog for an extension. If <oa>!</oa> is given, open a dialog,
 135             otherwise open a buffer. See also <o>newtab</o>.
 136         </p>
 137     </description>
 138 </item>
 139
 140 <item>
 141     <tags>:extr :extrehash</tags>
 142     <spec>:extr<oa>ehash</oa> <a>extension</a></spec>
 143     <spec>:extr<oa>ehash</oa></spec>
 144     <description>
 145         <p>
 146             Toggle an extension's enabled status twice. This is useful for rebooting
 147             a restartless extension.
 148         </p>
 149     </description>
 150 </item>
 151
 152 <item>
 153     <tags>:extt :exttoggle</tags>
 154     <spec>:extt<oa>oggle</oa> <a>extension</a></spec>
 155     <spec>:extt<oa>oggle</oa></spec>
 156     <description>
 157         <p>
 158             Toggle an extension's enabled status.
 159         </p>
 160     </description>
 161 </item>
 162
 163 <item>
 164     <tags>:extu :extupdate</tags>
 165     <spec>:extu<oa>pdate</oa> <a>extension</a></spec>
 166     <spec>:extu<oa>pdate</oa><oa>!</oa></spec>
 167     <description>
 168         <p>
 169             Update an extension. When <oa>!</oa> is given, update all
 170             extensions.
 171         </p>
 172     </description>
 173 </item>
 174
 175 <h2 tag="sidebar">Sidebar</h2>
 176
 177 <item>
 178     <tags>:sbcl :sbclose</tags>
 179     <spec>:sbcl<oa>ose</oa></spec>
 180     <description short="true">
 181         <p>Close the sidebar window.</p>
 182     </description>
 183 </item>
 184
 185 <item>
 186     <tags>:sbope :sbopen :sb :sbar :sideb :sidebar</tags>
 187     <spec>:sidebar <a>name</a></spec>
 188     <description>
 189         <p>
 190             Open the sidebar window. <a>name</a> is any of the menu items listed under the
 191             standard &dactyl.host; View->Sidebar menu. Add-ons, Preferences and Downloads are
 192             also available in the sidebar.
 193         </p>
 194     </description>
 195 </item>
 196 <item>
 197     <spec>:sidebar! <oa>name</oa></spec>
 198     <description>
 199         <p>
 200             Toggle the sidebar window. When <oa>name</oa> is provided, the
 201             semantics are as follows: If the named sidebar is currently open,
 202             it is closed. Otherwise the named sidebar is opened. When
 203             <oa>name</oa> is not provided, the semantics are as follows: If the
 204             sidebar is currently open, it is closed. Otherwise the previously
 205             open sidebar panel is re-opened.
 206         </p>
 207     </description>
 208 </item>
 209
 210
 211 <h2 tag="status-line status-bar">Status line</h2>
 212
 213 <p>
 214     The status line appears at the bottom of each window. You can use
 215     <o>guioptions</o> to specify if and when the status line appears, as well
 216     as its relation to the command line and messages.
 217 </p>
 218
 219 <p>
 220     The status line contains several fields that provide information about the
 221     state of the current buffer. These are, in order:
 222 </p>
 223
 224 <ul>
 225     <li>
 226         <em>URL</em>: The URL of the currently loaded page. While the page is loading,
 227         progress messages are also output to this field.
 228     </li>
 229     <li>
 230         <em>History and bookmark status</em> (<tt>[+-❤⋯]</tt>): The position
 231         of the current page in the tab's session history; <tt>+</tt> and
 232         <tt>-</tt> indicate that it is possible to move backwards and forwards
 233         through the history respectively. ❤ indicates that the current page is
 234         bookmarked. Any other character indicates a QuickMark matching the
 235         current page.
 236     </li>
 237     <li>
 238         <em>Tab index</em> (<tt>[N/M]</tt>): <tt>N</tt> is the index of the
 239         currently selected tab and <tt>M</tt> is the total number of tabs in
 240         the current window.
 241     </li>
 242     <li>
 243         <em>Vertical scroll</em>: The vertical scroll percentage of the current buffer,
 244         or Top or Bot for the top and bottom of the buffer respectively.
 245     </li>
 246     <li>
 247         <em>Security</em>: The security information button is displayed when appropriate
 248         as per &dactyl.host;. The color of the status bar also changes to reflect the
 249         current security status of the loaded page.
 250         <dl>
 251             <dt style="border:1px solid white" dactyl:highlight="StatusLineNormal">black</dt>
 252             <dd>The site's identity is unverified and the connection is unencrypted</dd>
 253
 254             <dt style="border:1px solid white" dactyl:highlight="StatusLineBroken">red</dt>
 255             <dd>The connection is encrypted, but the site's identity has not been verified or it contains unencrypted content</dd>
 256
 257             <dt style="border:1px solid white" dactyl:highlight="StatusLineSecure">blue</dt>
 258             <dd>The site's domain has been verified and the connection is encrypted</dd>
 259
 260             <dt style="border:1px solid white" dactyl:highlight="StatusLineExtended">green</dt>
 261             <dd>The site's domain and owner have been fully verified via an Extended Validation certificate and the connection is encrypted</dd>
 262         </dl>
 263     </li>
 264     <li>
 265         <em>Extensions</em>: Any extension buttons that would normally be installed to the
 266         &dactyl.host; status bar are appended to the end of the status line.
 267     </li>
 268 </ul>
 269
 270 <h2 tag="toolbar">Toolbars</h2>
 271
 272 <item>
 273     <tags>:tbs :tbshow :toolbars :toolbarshow</tags>
 274     <spec>:toolbarshow <a>name</a></spec>
 275     <description>
 276         <p>Shows the named toolbar.</p>
 277     </description>
 278 </item>
 279
 280 <item>
 281     <tags>:tbh :tbhide :toolbarh  :toolbarhide</tags>
 282     <spec>:toolbarhide <a>name</a></spec>
 283     <description>
 284         <p>Hides the named toolbar.</p>
 285     </description>
 286 </item>
 287
 288 <item>
 289     <tags>:tbt :tbtoggle :toolbart :toolbartoggle</tags>
 290     <spec>:toolbartoggle <a>name</a></spec>
 291     <description>
 292         <p>Toggles the named toolbar.</p>
 293     </description>
 294 </item>
 295
 296 </document>
 297
 298 <!-- vim:se sts=4 sw=4 et: -->