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     <li><em>History</em> marks every opened page with data on when and how often it has been visited.</li>
  26 </ul>
  27
  28 <h2 tag="bookmarks">Bookmarks</h2>
  29
  30 <p>
  31     Bookmarks are the most traditional kind of marks supported by
  32     &dactyl.appName;. They are accessible through &dactyl.host;'s
  33     bookmark menu, sidebar, and toolbar, in addition to its location
  34     bar completion system. &dactyl.appName; makes them accessible
  35     not only via several commands and its completion system (see the
  36     <o>complete</o> option), but also displays a ❤ in the status bar
  37     when a bookmarked page is displayed.
  38 </p>
  39
  40 <item>
  41     <tags>a :bma :bmark</tags>
  42     <spec>:bma<oa>rk</oa><oa>!</oa> <oa>options</oa> <oa>url</oa></spec>
  43     <spec>a</spec>
  44     <description>
  45         <p>Add a bookmark.</p>
  46
  47         <p>The following options are available:</p>
  48
  49         <dl dt="width: 8em;">
  50             <dt>-charset</dt>
  51             <dd>
  52                 Character encoding to use for the bookmark. Useful e.g. for
  53                 sites that require query parameters in encodings other than
  54                 UTF-8 (short name <em>-c</em>).
  55             </dd>
  56             <dt>-keyword</dt>
  57             <dd>
  58                 A keyword which may be used to open the bookmark via
  59                 the URL bar or <ex>:open</ex> prompt. If the
  60                 <oa>url</oa> contains the string <em>%s</em> it is
  61                 replaced by any text following the keyword when it
  62                 is opened. See also <k>;S</k>.
  63                 (short name <em>-k</em>)
  64             </dd>
  65             <dt>-post</dt>
  66             <dd>
  67                 Data to be POSTed to the server when the bookmark is
  68                 opened.
  69             </dd>
  70             <dt>-tags</dt>
  71             <dd>
  72                 Comma-separated list of tags for grouping and later
  73                 access (short name <em>-T</em>).
  74             </dd>
  75             <dt>-title</dt>
  76             <dd>
  77                 The title of the bookmark.
  78                 Defaults to the page title, if available, or
  79                 <oa>url</oa> otherwise.
  80                 (short name <em>-t</em>)
  81             </dd>
  82         </dl>
  83
  84         <p>
  85             If <oa>url</oa> is omitted, the URL of the currently loaded web
  86             page is used.
  87         </p>
  88
  89         <p>
  90             If <oa>!</oa> is present, a new bookmark is always
  91             added. Otherwise, the first bookmark matching
  92             <oa>url</oa> is updated.
  93         </p>
  94     </description>
  95 </item>
  96
  97 <item>
  98     <tags>A</tags>
  99     <strut/>
 100     <spec>A</spec>
 101     <description>
 102         <p>
 103             Toggle bookmarked state of current URL. Add/remove a
 104             bookmark for the current location, depending on whether
 105             it is already bookmarked. New bookmarks are placed in
 106             the <em>Unfiled Bookmarks</em> folder, and don't appear
 107             in the bookmarks menu or toolbar, but do appear in
 108             location bar and <em>:open</em> completions, as well as
 109             the <em>:bmarks</em> list.
 110         </p>
 111     </description>
 112 </item>
 113
 114 <item>
 115     <tags>:bmarks</tags>
 116     <spec>:bmarks<oa>!</oa> <oa>filter</oa></spec>
 117     <description>
 118         <p>
 119             List or open multiple bookmarks. Opens the message window
 120             at the bottom of the screen with all bookmarks with
 121             titles or URLs matching <oa>filter</oa>. The resulting
 122             URLs can be clicked, or accessed via extended hint modes
 123             such as <k>;o</k>.
 124         </p>
 125
 126         <p>
 127             The special version <ex>:bmarks!</ex> works the same as
 128             <ex>:bmarks</ex> except that it opens all matching
 129             bookmarks in new tabs rather than listing them.
 130         </p>
 131
 132         <p>The bookmarks may also be filtered via the following options:</p>
 133
 134         <dl dt="width: 8em;">
 135             <dt>-keyword</dt>
 136             <dd>
 137                 The bookmark's keyword (short name <em>-k</em>).
 138             </dd>
 139             <dt>-tags</dt>
 140             <dd>
 141                 A comma-separated list of tags, all of which must be
 142                 present for a match (short name <em>-T</em>).
 143             </dd>
 144             <dt>-title</dt>
 145             <dd>
 146                 The title of the bookmark (short name <em>-t</em>).
 147             </dd>
 148             <dt>-max</dt>
 149             <dd>
 150                 The maximum number of items to list or open
 151                 (short name <em>-m</em>).
 152             </dd>
 153         </dl>
 154     </description>
 155 </item>
 156
 157 <item>
 158     <tags>:delbm :delbmarks</tags>
 159     <spec>:delbm[arks] <oa>url</oa></spec>
 160     <spec>:delbm[arks]!</spec>
 161     <description>
 162         <p>
 163             Deletes <em>all</em> bookmarks which match <oa>url</oa>.
 164             If omitted, <oa>url</oa> defaults to the URL of the
 165             current buffer.
 166         </p>
 167
 168         <p>Accepts the same options as :bmarks.</p>
 169
 170         <p>If <oa>!</oa> is specified then all bookmarks will be deleted.</p>
 171     </description>
 172 </item>
 173
 174 <h2 tag="history">History</h2>
 175
 176 <p>
 177     Though not traditionally considered a mark, history behaves very
 178     similarly to bookmarks both in &dactyl.host; and
 179     &dactyl.appName;. Every visited page is marked and weighted by
 180     when and how often it is visited, and can be retrieved both in
 181     history list and location completions. Indeed, the ‘frecency’
 182     algorithm used to determine the results of location completions
 183     (see the <o>complete</o> option) means that history is often a
 184     more effective type of mark than bookmarks themselves.
 185 </p>
 186
 187 <item>
 188     <tags><![CDATA[<C-o>]]></tags>
 189     <strut/>
 190     <spec><![CDATA[[count]<C-o>]]></spec>
 191     <description>
 192         <p>
 193             Go to an older position in the jump list. This currently
 194             entails moving backward in page history, but in the
 195             future will take into account page positions as well.
 196             If <oa>count</oa> is specified go back <oa>count</oa> pages.
 197         </p>
 198     </description>
 199 </item>
 200
 201 <item>
 202     <tags><![CDATA[<C-i>]]></tags>
 203     <strut/>
 204     <spec><![CDATA[[count]<C-i>]]></spec>
 205     <description>
 206         <p>
 207             Go to an newer position in the jump list. This currently
 208             entails moving forward in page history, but in the
 209             future will take into account page positions as well.
 210             If <oa>count</oa> is specified go forward <oa>count</oa> pages.
 211         </p>
 212     </description>
 213 </item>
 214
 215 <item>
 216     <tags><![CDATA[<M-Left> <A-Left> H]]></tags>
 217     <strut/>
 218     <spec>[count]H</spec>
 219     <description>
 220         <p>Go back in the browser history. If <oa>count</oa> is specified go back <oa>count</oa> pages.</p>
 221     </description>
 222 </item>
 223
 224 <item>
 225     <tags><![CDATA[<M-Right> <A-Right> L]]></tags>
 226     <strut/>
 227     <spec><oa>count</oa>L</spec>
 228     <description>
 229         <p>
 230             Go forward in the browser history. If <oa>count</oa> is specified go forward <oa>count</oa>
 231             pages.
 232         </p>
 233     </description>
 234 </item>
 235
 236 <item>
 237     <tags>:ba :back</tags>
 238     <spec>:<oa>count</oa>ba<oa>ck</oa> <oa>url</oa></spec>
 239     <spec>:<oa>count</oa>ba<oa>ck</oa>!</spec>
 240     <description>
 241         <p>
 242             Go back in the browser history. If <oa>count</oa> is specified go back <oa>count</oa> pages.
 243         </p>
 244         <p>
 245             The special version <ex>:back!</ex> goes to the beginning of the browser history.
 246         </p>
 247     </description>
 248 </item>
 249
 250 <item>
 251     <tags>:fw :fo :forward</tags>
 252     <spec>:<oa>count</oa>fo<oa>rward</oa> <oa>url</oa></spec>
 253     <spec>:<oa>count</oa>fo<oa>rward</oa>!</spec>
 254     <description>
 255         <p>
 256             Go forward in the browser history. If <oa>count</oa> is specified go forward <oa>count</oa>
 257             pages.
 258         </p>
 259         <p>
 260             The special version <ex>:forward!</ex> goes to the end of the browser history.
 261         </p>
 262     </description>
 263 </item>
 264
 265 <item>
 266     <tags>:hs :hist :history</tags>
 267     <spec>:hist<oa>ory</oa><oa>!</oa> <oa>filter</oa></spec>
 268     <description>
 269         <p>
 270             Show recently visited URLs. Opens the message window at the bottom of the screen
 271             with all history items whose page titles or URLs match
 272             <oa>filter</oa>.
 273         </p>
 274
 275         <p>
 276             The special version <ex>:history!</ex> works the same as
 277             <ex>:history</ex> except that it opens all matching
 278             pages in new tabs rather than listing them.
 279         </p>
 280
 281         <p>The pages may also be filtered via the following options,</p>
 282
 283         <dl dt="width: 8em;">
 284             <dt>-max</dt>
 285             <dd>
 286                 The maximum number of items to list or open
 287                 (short name <em>-m</em>).
 288             </dd>
 289             <dt>-sort</dt>
 290             <dd>
 291                 The sort order of the results
 292                 (short name <em>-s</em>).
 293             </dd>
 294         </dl>
 295     </description>
 296 </item>
 297
 298 <h2 tag="quickmarks">QuickMarks</h2>
 299
 300 <p>
 301     QuickMarks are bookmarks stripped to the bone for quickly getting to the
 302     pages that you visit most. A QuickMark is simply a URL assigned to a letter
 303     or number. They can therefore be saved or opened with only three key
 304     presses each. QuickMarks are persistent across browser sessions.
 305 </p>
 306
 307 <item>
 308     <tags>M</tags>
 309     <strut/>
 310     <spec>M<a>a-zA-Z0-9</a></spec>
 311     <description>
 312         <p>
 313             Add new QuickMark for current URL. You can later jump to
 314             the mark with <k>go</k><a>a-zA-Z0-9</a>
 315             <k>gn</k><a>a-zA-Z0-9</a>.
 316         </p>
 317     </description>
 318 </item>
 319
 320 <item>
 321     <tags>go</tags>
 322     <strut/>
 323     <spec>go<a>a-zA-Z0-9</a></spec>
 324     <description>
 325         <p>
 326             Jump to a QuickMark in the current tab. See also
 327             <k>M</k> and <ex>:qmark</ex>.
 328         </p>
 329     </description>
 330 </item>
 331
 332 <item>
 333     <tags>gn</tags>
 334     <strut/>
 335     <spec>gn<a>a-zA-Z0-9</a></spec>
 336     <description>
 337         <p>
 338             Jump to a QuickMark in a new tab. The new tab is focused
 339             only if <o>activate</o> contains <em>quickmark</em> or
 340             <em>all</em>. See also <k>M</k> and <ex>:qmark</ex>.
 341         </p>
 342         <p>Mnemonic: Go in a new tab.</p>
 343     </description>
 344 </item>
 345
 346 <item>
 347     <tags>:delqm :delqmarks</tags>
 348     <spec>:delqm<oa>arks</oa> <a>arg</a></spec>
 349     <spec>:delqm<oa>arks</oa>!</spec>
 350     <description>
 351         <p>Delete the specified QuickMarks.</p>
 352
 353         <p>Examples:</p>
 354
 355         <ul>
 356             <li><ex>:delqmarks Aa b p</ex> deletes QuickMarks A, a, b and p</li>
 357             <li><ex>:delqmarks b-p</ex> deletes all QuickMarks in the range b to p</li>
 358             <li><ex>:delqmarks!</ex> deletes all QuickMarks</li>
 359         </ul>
 360     </description>
 361 </item>
 362
 363 <item>
 364     <tags>:qma :qmark</tags>
 365     <spec>:qmark <a>a-zA-Z0-9</a> <a>url</a></spec>
 366     <description>
 367         <p>
 368             Mark <a>url</a> with a letter for quick access. See also
 369             <k>go</k>, <k>gn</k>, and <k>M</k>.
 370         </p>
 371
 372         <p>
 373             In addition to simple URLs, <a>url</a> may be any string
 374             that can be passed to <ex>:open</ex>.
 375         </p>
 376     </description>
 377 </item>
 378
 379 <item>
 380     <tags>:qmarks</tags>
 381     <strut/>
 382     <spec>:qmarks <oa>arg</oa></spec>
 383     <description>
 384         <p>
 385             List QuickMarks. If <oa>arg</oa> is given then limit the
 386             list to those QuickMarks mentioned, otherwise list them
 387             all.
 388         </p>
 389     </description>
 390 </item>
 391
 392 <h2 tag="urlmarks localmarks">Local marks and URL marks</h2>
 393
 394 <p>
 395     Local and URL marks allow you to mark your position on the current page to
 396     quickly return later. Each mark is assigned to a letter. Lowercase letters
 397     behave as local marks, while uppercase letters act as URL marks. The
 398     difference between the two is that local marks apply uniquely to each page,
 399     while URL marks mark a specific position on a specific page. So, while the
 400     mark <em>m</em> may take you to the top of the page on Site 1, it may take
 401     you to the middle on Site 2. The mark <em>M</em>, on the other hand, will
 402     always return you to Site 1, possibly switching buffers or creating a new
 403     one. All marks are persistent across browser sessions.
 404 </p>
 405
 406 <item>
 407     <tags>m</tags>
 408     <strut/>
 409     <spec>m<a>a-zA-Z</a></spec>
 410     <description>
 411         <p>
 412             Set mark at the cursor position. Marks a-z are local to the buffer, whereas
 413             A-Z are valid between buffers.
 414         </p>
 415     </description>
 416 </item>
 417
 418 <item>
 419     <tags>` '</tags>
 420     <strut/>
 421     <spec>'<a>a-zA-Z'</a></spec>
 422     <spec>`<a>a-zA-Z'</a></spec>
 423     <description>
 424         <p>
 425             Jump to the mark. Marks a-z are local to the buffer, whereas A-Z
 426             are valid between buffers. The special mark ' holds the buffer
 427             position before the last scrolling action.
 428         </p>
 429     </description>
 430 </item>
 431
 432 <item>
 433     <tags>:delm :delmarks</tags>
 434     <spec>:delm<oa>arks</oa> <a>arg</a></spec>
 435     <spec>:delm<oa>arks</oa>!</spec>
 436     <description>
 437         <p>Delete the specified marks.</p>
 438
 439         <p>Examples:</p>
 440
 441         <ul>
 442             <li><ex>:delmarks Aa b p</ex> deletes marks A, a, b, and p</li>
 443             <li><ex>:delmarks b-p</ex> deletes all marks in the range b to p</li>
 444             <li><ex>:delmarks!</ex> deletes all marks for the current buffer</li>
 445         </ul>
 446     </description>
 447 </item>
 448
 449 <item>
 450     <tags>:ma :mark</tags>
 451     <spec>:mark <a>a-zA-Z</a></spec>
 452     <description short="true">
 453         <p>Mark current location within the web page.</p>
 454     </description>
 455 </item>
 456
 457 <item>
 458     <tags>:marks</tags>
 459     <strut/>
 460     <spec>:marks <oa>arg</oa></spec>
 461     <description>
 462         <p>
 463             Show all local marks for the current web page and all
 464             URL marks. If <oa>arg</oa> is specified then limit the
 465             list to those marks mentioned.
 466         </p>
 467     </description>
 468 </item>
 469
 470 </document>
 471
 472 <!-- vim:se sts=4 sw=4 et: -->