common/locale/en-US/marks.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="marks"
   8     title="&dactyl.appName; Marks"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:html="&xmlns.html;">
  11
  12 <h1 tag="marks">Marks</h1>
  13 <toc start="2"/>
  14
  15 <p>
  16     &dactyl.appName; supports a number of different methods of
  17     marking your place, in order to easily return later:
  18 </p>
  19
  20 <ul>
  21     <li><em>Bookmarks</em> are the standard marks of &dactyl.host;, and are fully supported.</li>
  22     <li><em>QuickMarks</em> allow you to quickly save and return to as many as 62 (a-zA-Z0-9) different web sites with a quick keyboard shortcut.</li>
  23     <li><em>Local marks</em> allow you to store and return to a position within the current web page.</li>
  24     <li><em>URL marks</em> allow you to store and return to the position and URL of the current web page.</li>
  25 </ul>
  26
  27 <h2 tag="bookmarks">Bookmarks</h2>
  28
  29 <p>
  30     Bookmarks are the most traditional kind of marks supported by
  31     &dactyl.appName;. They are accessible through &dactyl.host;'s
  32     bookmark menu, sidebar, and toolbar, in addition to its location
  33     bar completion system. &dactyl.appName; makes them accessible
  34     not only via several commands and its completion system (see the
  35     <o>complete</o> option), but also displays a ❤ in the status bar
  36     when a bookmarked page is displayed.
  37 </p>
  38
  39 <item>
  40     <tags>a :bma :bmark</tags>
  41     <spec>:bma<oa>rk</oa><oa>!</oa> <oa>options</oa> <oa>url</oa></spec>
  42     <spec>a</spec>
  43     <description>
  44         <p>Add a bookmark.</p>
  45
  46         <p>The following options are available:</p>
  47
  48         <dl dt="width: 8em;">
  49             <dt>-charset</dt>
  50             <dd>
  51                 Character encoding to use for the bookmark. Useful e.g. for
  52                 sites that require query parameters in encodings other than
  53                 UTF-8 (short name <em>-c</em>).
  54             </dd>
  55             <dt>-id</dt>
  56             <dd>
  57                 The numerical ID of a bookmark to update.
  58             </dd>
  59             <dt>-keyword</dt>
  60             <dd>
  61                 A keyword which may be used to open the bookmark via
  62                 the URL bar or <ex>:open</ex> prompt. If the
  63                 <oa>url</oa> contains the string <em>%s</em> it is
  64                 replaced by any text following the keyword when it
  65                 is opened. See also <k>;S</k>.
  66                 (short name <em>-k</em>)
  67             </dd>
  68             <dt>-post</dt>
  69             <dd>
  70                 Data to be POSTed to the server when the bookmark is
  71                 opened.
  72             </dd>
  73             <dt>-tags</dt>
  74             <dd>
  75                 Comma-separated list of tags for grouping and later
  76                 access (short name <em>-T</em>).
  77             </dd>
  78             <dt>-title</dt>
  79             <dd>
  80                 The title of the bookmark.
  81                 Defaults to the page title, if available, or
  82                 <oa>url</oa> otherwise.
  83                 (short name <em>-t</em>)
  84             </dd>
  85         </dl>
  86
  87         <p>
  88             If <oa>url</oa> is omitted, the URL of the currently loaded web
  89             page is used.
  90         </p>
  91
  92         <p>
  93             If <oa>!</oa> is present, a new bookmark is always
  94             added. Otherwise, the first bookmark matching
  95             <oa>id</oa>, <oa>keyword</oa>, or <oa>url</oa> is updated.
  96         </p>
  97     </description>
  98 </item>
  99
 100 <item>
 101     <tags>A</tags>
 102     <strut/>
 103     <spec>A</spec>
 104     <description>
 105         <p>
 106             Toggle bookmarked state of current URL. Add/remove a
 107             bookmark for the current location, depending on whether
 108             it is already bookmarked. New bookmarks are placed in
 109             the <em>Unfiled Bookmarks</em> folder, and don't appear
 110             in the bookmarks menu or toolbar, but do appear in
 111             location bar and <em>:open</em> completions, as well as
 112             the <em>:bmarks</em> list.
 113         </p>
 114     </description>
 115 </item>
 116
 117 <item>
 118     <tags>:bmarks</tags>
 119     <spec>:bmarks<oa>!</oa> <oa>filter</oa></spec>
 120     <description>
 121         <p>
 122             List or open multiple bookmarks. Opens the message window at the
 123             bottom of the screen with all bookmarks with URLs matching
 124             <oa>filter</oa>. The resulting URLs can be clicked, or accessed via
 125             extended hint modes such as <k>;o</k>.
 126         </p>
 127
 128         <p>
 129             The special version <ex>:bmarks!</ex> works the same as
 130             <ex>:bmarks</ex> except that it opens all matching
 131             bookmarks in new tabs rather than listing them.
 132         </p>
 133
 134         <p>The bookmarks may also be filtered via the following options:</p>
 135
 136         <dl dt="width: 8em;">
 137             <dt>-keyword</dt>
 138             <dd>
 139                 The bookmark's keyword (short name <em>-k</em>).
 140             </dd>
 141             <dt>-tags</dt>
 142             <dd>
 143                 A comma-separated list of tags, all of which must be
 144                 present for a match (short name <em>-T</em>).
 145             </dd>
 146             <dt>-title</dt>
 147             <dd>
 148                 The title of the bookmark (short name <em>-t</em>).
 149             </dd>
 150             <dt>-max</dt>
 151             <dd>
 152                 The maximum number of items to list or open
 153                 (short name <em>-m</em>).
 154             </dd>
 155         </dl>
 156     </description>
 157 </item>
 158
 159 <item>
 160     <tags>:delbm :delbmarks</tags>
 161     <spec>:delbm[arks] <oa>url</oa></spec>
 162     <spec>:delbm[arks]!</spec>
 163     <description>
 164         <p>
 165             Deletes <em>all</em> bookmarks which match <oa>url</oa>.
 166             If omitted, <oa>url</oa> defaults to the URL of the
 167             current buffer.
 168         </p>
 169
 170         <p>Accepts the same options as :bmarks.</p>
 171
 172         <p>If <oa>!</oa> is specified then all bookmarks will be deleted.</p>
 173     </description>
 174 </item>
 175
 176
 177 <h2 tag="quickmarks">QuickMarks</h2>
 178
 179 <p>
 180     QuickMarks are bookmarks stripped to the bone for quickly getting to the
 181     pages that you visit most. A QuickMark is simply a URL assigned to a letter
 182     or digit. They can therefore be saved or opened with only three key
 183     presses each. QuickMarks are persistent across browser sessions.
 184 </p>
 185
 186 <item>
 187     <tags>M</tags>
 188     <strut/>
 189     <spec>M<a>a-zA-Z0-9</a></spec>
 190     <description>
 191         <p>
 192             Add new QuickMark for current URL. You can later jump to
 193             the mark with <k>go</k><a>a-zA-Z0-9</a>
 194             <k>gn</k><a>a-zA-Z0-9</a>.
 195         </p>
 196     </description>
 197 </item>
 198
 199 <item>
 200     <tags>go</tags>
 201     <strut/>
 202     <spec>go<a>a-zA-Z0-9</a></spec>
 203     <description>
 204         <p>
 205             Jump to a QuickMark in the current tab. See also
 206             <k>M</k> and <ex>:qmark</ex>.
 207         </p>
 208     </description>
 209 </item>
 210
 211 <item>
 212     <tags>gn</tags>
 213     <strut/>
 214     <spec>gn<a>a-zA-Z0-9</a></spec>
 215     <description>
 216         <p>
 217             Jump to a QuickMark in a new tab. The new tab is focused
 218             only if <o>activate</o> contains <em>quickmark</em> or
 219             <em>all</em>. See also <k>M</k> and <ex>:qmark</ex>.
 220         </p>
 221         <p>Mnemonic: Go in a new tab.</p>
 222     </description>
 223 </item>
 224
 225 <item>
 226     <tags>:delqm :delqmarks</tags>
 227     <spec>:delqm<oa>arks</oa> <a>arg</a></spec>
 228     <spec>:delqm<oa>arks</oa>!</spec>
 229     <description>
 230         <p>Delete the specified QuickMarks.</p>
 231
 232         <p>Examples:</p>
 233
 234         <ul>
 235             <li><ex>:delqmarks Aa b p</ex> deletes QuickMarks A, a, b and p</li>
 236             <li><ex>:delqmarks b-p</ex> deletes all QuickMarks in the range b to p</li>
 237             <li><ex>:delqmarks!</ex> deletes all QuickMarks</li>
 238         </ul>
 239     </description>
 240 </item>
 241
 242 <item>
 243     <tags>:qma :qmark</tags>
 244     <spec>:qmark <a>a-zA-Z0-9</a> <a>url</a></spec>
 245     <description>
 246         <p>
 247             Mark <a>url</a> with a letter or digit for quick access. See also
 248             <k>go</k>, <k>gn</k>, and <k>M</k>.
 249         </p>
 250
 251         <p>
 252             In addition to simple URLs, <a>url</a> may be any string
 253             that can be passed to <ex>:open</ex>.
 254         </p>
 255     </description>
 256 </item>
 257
 258 <item>
 259     <tags>:qmarks</tags>
 260     <strut/>
 261     <spec>:qmarks <oa>arg</oa></spec>
 262     <description>
 263         <p>
 264             List QuickMarks. If <oa>arg</oa> is given then limit the
 265             list to those QuickMarks mentioned, otherwise list them
 266             all.
 267         </p>
 268     </description>
 269 </item>
 270
 271 <h2 tag="urlmarks localmarks">Local marks and URL marks</h2>
 272
 273 <p>
 274     Local and URL marks allow you to mark your position on the current page to
 275     quickly return later. Each mark is assigned to a letter. Lowercase letters
 276     behave as local marks, while uppercase letters act as URL marks. The
 277     difference between the two is that local marks apply uniquely to each page,
 278     while URL marks mark a specific position on a specific page. So, while the
 279     mark <em>m</em> may take you to the top of the page on Site 1, it may take
 280     you to the middle on Site 2. The mark <em>M</em>, on the other hand, will
 281     always return you to Site 1, possibly switching buffers or creating a new
 282     one. All marks are persistent across browser sessions.
 283 </p>
 284
 285 <item>
 286     <tags>m</tags>
 287     <strut/>
 288     <spec>m<a>a-zA-Z</a></spec>
 289     <description>
 290         <p>
 291             Set mark at the cursor position. Marks a-z are local to the buffer, whereas
 292             A-Z are valid between buffers.
 293         </p>
 294     </description>
 295 </item>
 296
 297 <item>
 298     <tags>` '</tags>
 299     <strut/>
 300     <spec>'<a>a-zA-Z'</a></spec>
 301     <spec>`<a>a-zA-Z'</a></spec>
 302     <description>
 303         <p>
 304             Jump to the mark. Marks a-z are local to the buffer, whereas A-Z
 305             are valid between buffers. The special mark ' holds the buffer
 306             position before the last scrolling action.
 307         </p>
 308     </description>
 309 </item>
 310
 311 <item>
 312     <tags>:delm :delmarks</tags>
 313     <spec>:delm<oa>arks</oa> <a>arg</a></spec>
 314     <spec>:delm<oa>arks</oa>!</spec>
 315     <description>
 316         <p>Delete the specified marks.</p>
 317
 318         <p>Examples:</p>
 319
 320         <ul>
 321             <li><ex>:delmarks Aa b p</ex> deletes marks A, a, b, and p</li>
 322             <li><ex>:delmarks b-p</ex> deletes all marks in the range b to p</li>
 323             <li><ex>:delmarks!</ex> deletes all marks for the current buffer</li>
 324         </ul>
 325     </description>
 326 </item>
 327
 328 <item>
 329     <tags>:ma :mark</tags>
 330     <spec>:mark <a>a-zA-Z</a></spec>
 331     <description short="true">
 332         <p>Mark current location within the web page.</p>
 333     </description>
 334 </item>
 335
 336 <item>
 337     <tags>:marks</tags>
 338     <strut/>
 339     <spec>:marks <oa>arg</oa></spec>
 340     <description>
 341         <p>
 342             Show all local marks for the current web page and all
 343             URL marks. If <oa>arg</oa> is specified then limit the
 344             list to those marks mentioned.
 345         </p>
 346     </description>
 347 </item>
 348
 349 </document>
 350
 351 <!-- vim:se sts=4 sw=4 et: -->