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
 123             at the bottom of the screen with all bookmarks with
 124             titles or URLs matching <oa>filter</oa>. The resulting
 125             URLs can be clicked, or accessed via extended hint modes
 126             such as <k>;o</k>.
 127         </p>
 128
 129         <p>
 130             The special version <ex>:bmarks!</ex> works the same as
 131             <ex>:bmarks</ex> except that it opens all matching
 132             bookmarks in new tabs rather than listing them.
 133         </p>
 134
 135         <p>The bookmarks may also be filtered via the following options:</p>
 136
 137         <dl dt="width: 8em;">
 138             <dt>-keyword</dt>
 139             <dd>
 140                 The bookmark's keyword (short name <em>-k</em>).
 141             </dd>
 142             <dt>-tags</dt>
 143             <dd>
 144                 A comma-separated list of tags, all of which must be
 145                 present for a match (short name <em>-T</em>).
 146             </dd>
 147             <dt>-title</dt>
 148             <dd>
 149                 The title of the bookmark (short name <em>-t</em>).
 150             </dd>
 151             <dt>-max</dt>
 152             <dd>
 153                 The maximum number of items to list or open
 154                 (short name <em>-m</em>).
 155             </dd>
 156         </dl>
 157     </description>
 158 </item>
 159
 160 <item>
 161     <tags>:delbm :delbmarks</tags>
 162     <spec>:delbm[arks] <oa>url</oa></spec>
 163     <spec>:delbm[arks]!</spec>
 164     <description>
 165         <p>
 166             Deletes <em>all</em> bookmarks which match <oa>url</oa>.
 167             If omitted, <oa>url</oa> defaults to the URL of the
 168             current buffer.
 169         </p>
 170
 171         <p>Accepts the same options as :bmarks.</p>
 172
 173         <p>If <oa>!</oa> is specified then all bookmarks will be deleted.</p>
 174     </description>
 175 </item>
 176
 177
 178 <h2 tag="quickmarks">QuickMarks</h2>
 179
 180 <p>
 181     QuickMarks are bookmarks stripped to the bone for quickly getting to the
 182     pages that you visit most. A QuickMark is simply a URL assigned to a letter
 183     or number. They can therefore be saved or opened with only three key
 184     presses each. QuickMarks are persistent across browser sessions.
 185 </p>
 186
 187 <item>
 188     <tags>M</tags>
 189     <strut/>
 190     <spec>M<a>a-zA-Z0-9</a></spec>
 191     <description>
 192         <p>
 193             Add new QuickMark for current URL. You can later jump to
 194             the mark with <k>go</k><a>a-zA-Z0-9</a>
 195             <k>gn</k><a>a-zA-Z0-9</a>.
 196         </p>
 197     </description>
 198 </item>
 199
 200 <item>
 201     <tags>go</tags>
 202     <strut/>
 203     <spec>go<a>a-zA-Z0-9</a></spec>
 204     <description>
 205         <p>
 206             Jump to a QuickMark in the current tab. See also
 207             <k>M</k> and <ex>:qmark</ex>.
 208         </p>
 209     </description>
 210 </item>
 211
 212 <item>
 213     <tags>gn</tags>
 214     <strut/>
 215     <spec>gn<a>a-zA-Z0-9</a></spec>
 216     <description>
 217         <p>
 218             Jump to a QuickMark in a new tab. The new tab is focused
 219             only if <o>activate</o> contains <em>quickmark</em> or
 220             <em>all</em>. See also <k>M</k> and <ex>:qmark</ex>.
 221         </p>
 222         <p>Mnemonic: Go in a new tab.</p>
 223     </description>
 224 </item>
 225
 226 <item>
 227     <tags>:delqm :delqmarks</tags>
 228     <spec>:delqm<oa>arks</oa> <a>arg</a></spec>
 229     <spec>:delqm<oa>arks</oa>!</spec>
 230     <description>
 231         <p>Delete the specified QuickMarks.</p>
 232
 233         <p>Examples:</p>
 234
 235         <ul>
 236             <li><ex>:delqmarks Aa b p</ex> deletes QuickMarks A, a, b and p</li>
 237             <li><ex>:delqmarks b-p</ex> deletes all QuickMarks in the range b to p</li>
 238             <li><ex>:delqmarks!</ex> deletes all QuickMarks</li>
 239         </ul>
 240     </description>
 241 </item>
 242
 243 <item>
 244     <tags>:qma :qmark</tags>
 245     <spec>:qmark <a>a-zA-Z0-9</a> <a>url</a></spec>
 246     <description>
 247         <p>
 248             Mark <a>url</a> with a letter for quick access. See also
 249             <k>go</k>, <k>gn</k>, and <k>M</k>.
 250         </p>
 251
 252         <p>
 253             In addition to simple URLs, <a>url</a> may be any string
 254             that can be passed to <ex>:open</ex>.
 255         </p>
 256     </description>
 257 </item>
 258
 259 <item>
 260     <tags>:qmarks</tags>
 261     <strut/>
 262     <spec>:qmarks <oa>arg</oa></spec>
 263     <description>
 264         <p>
 265             List QuickMarks. If <oa>arg</oa> is given then limit the
 266             list to those QuickMarks mentioned, otherwise list them
 267             all.
 268         </p>
 269     </description>
 270 </item>
 271
 272 <h2 tag="urlmarks localmarks">Local marks and URL marks</h2>
 273
 274 <p>
 275     Local and URL marks allow you to mark your position on the current page to
 276     quickly return later. Each mark is assigned to a letter. Lowercase letters
 277     behave as local marks, while uppercase letters act as URL marks. The
 278     difference between the two is that local marks apply uniquely to each page,
 279     while URL marks mark a specific position on a specific page. So, while the
 280     mark <em>m</em> may take you to the top of the page on Site 1, it may take
 281     you to the middle on Site 2. The mark <em>M</em>, on the other hand, will
 282     always return you to Site 1, possibly switching buffers or creating a new
 283     one. All marks are persistent across browser sessions.
 284 </p>
 285
 286 <item>
 287     <tags>m</tags>
 288     <strut/>
 289     <spec>m<a>a-zA-Z</a></spec>
 290     <description>
 291         <p>
 292             Set mark at the cursor position. Marks a-z are local to the buffer, whereas
 293             A-Z are valid between buffers.
 294         </p>
 295     </description>
 296 </item>
 297
 298 <item>
 299     <tags>` '</tags>
 300     <strut/>
 301     <spec>'<a>a-zA-Z'</a></spec>
 302     <spec>`<a>a-zA-Z'</a></spec>
 303     <description>
 304         <p>
 305             Jump to the mark. Marks a-z are local to the buffer, whereas A-Z
 306             are valid between buffers. The special mark ' holds the buffer
 307             position before the last scrolling action.
 308         </p>
 309     </description>
 310 </item>
 311
 312 <item>
 313     <tags>:delm :delmarks</tags>
 314     <spec>:delm<oa>arks</oa> <a>arg</a></spec>
 315     <spec>:delm<oa>arks</oa>!</spec>
 316     <description>
 317         <p>Delete the specified marks.</p>
 318
 319         <p>Examples:</p>
 320
 321         <ul>
 322             <li><ex>:delmarks Aa b p</ex> deletes marks A, a, b, and p</li>
 323             <li><ex>:delmarks b-p</ex> deletes all marks in the range b to p</li>
 324             <li><ex>:delmarks!</ex> deletes all marks for the current buffer</li>
 325         </ul>
 326     </description>
 327 </item>
 328
 329 <item>
 330     <tags>:ma :mark</tags>
 331     <spec>:mark <a>a-zA-Z</a></spec>
 332     <description short="true">
 333         <p>Mark current location within the web page.</p>
 334     </description>
 335 </item>
 336
 337 <item>
 338     <tags>:marks</tags>
 339     <strut/>
 340     <spec>:marks <oa>arg</oa></spec>
 341     <description>
 342         <p>
 343             Show all local marks for the current web page and all
 344             URL marks. If <oa>arg</oa> is specified then limit the
 345             list to those marks mentioned.
 346         </p>
 347     </description>
 348 </item>
 349
 350 </document>
 351
 352 <!-- vim:se sts=4 sw=4 et: -->