help/tutorial.html

   1 <!DOCTYPE html
   2   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4 <!--
   5 (C) Copyright 2007 John J. Foerch
   6
   7 Use, modification, and distribution are subject to the terms specified in the
   8 COPYING file.
   9 -->
  10
  11 <html xmlns="http://www.w3.org/1999/xhtml">
  12 <head>
  13 <title>Conkeror Tutorial</title>
  14 <link rel="stylesheet" type="text/css" href="chrome://conkeror-help/content/manual.css" />
  15 </head>
  16 <body>
  17 <h1>Conkeror Tutorial</h1>
  18
  19 <h3>Welcome to Conkeror</h3>
  20
  21 <p>
  22   The first thing you need to know about Conkeror is how to read key
  23   notation.  Each key combination is written as a hyphenated list of
  24   modifiers and key.  The codes for the common modifiers are as
  25   follows: <code class="key">C</code> means Control; <code class="key">M</code> means Meta or
  26   Alt; and <code class="key">S</code> means Shift.  Therefore the key combination
  27   <code class="key">C-M-f</code> means to hold down Control and Meta and press
  28   <code class="key">f</code>.
  29 </p>
  30
  31 <p>
  32   The key to scroll down is <code class="key">C-n</code>.  The key to scroll up is
  33   <code class="key">C-p</code>
  34 </p>
  35
  36 <p>
  37   Many commands in Conkeror are run by typing a sequence of two or
  38   more key combinations.  The notation is simple.  Each combination in
  39   the sequence is written, in order, separated by spaces.  The
  40   sequence <code class="key">C-h t</code> means to press Control-h, release all
  41   keys, then press <code class="key">t</code>.  <code class="key">C-h t</code> is the key
  42   sequence to view this tutorial.
  43 </p>
  44
  45 <p>
  46   The key sequence to exit conkeror is <code class="key">C-x C-c</code>.
  47 </p>
  48
  49 <p>
  50   <code class="key">C-g</code> is the abort key.  It is used to cancel a command
  51   from the minibuffer, or stop a web page from loading.
  52 </p>
  53
  54 <p>
  55   <code class="key">Space</code> and <code class="key">Backspace</code> scroll a page down and
  56   a page up, respectfully.
  57 </p>
  58
  59
  60 <h3>Hinting</h3>
  61
  62 <p>
  63   The system for interacting with the elements of a document is called
  64   the hinting system.  With the hinting system, you can do things like
  65   follow hyperlinks, copy URLs, focus form fields, and more.  Let's
  66   use the hinting system to follow a hyperlink.  You will receive
  67   instructions about how to return here after you follow the
  68   hyperlink.  Scroll so that following numbered list and the hyperlink
  69   after it are both visible.
  70 </p>
  71
  72 <ol>
  73   <li>Press <code class="key">f</code>.  (mnemonic: follow)</li>
  74   <li>The hyperlink should be hilighted, with a number on the left
  75   side.  Type that number.</li>
  76 </ol>
  77
  78
  79 <a href="chrome://conkeror-help/content/back-forward.html">This is a
  80 hyperlink.</a>
  81
  82 <p>
  83   As a matter of fact, in addition to following links by number, you
  84   can also follow them by a substring of the link text.  You could
  85   follow the link above by typing <code class="key">f t h i s</code>.  When more
  86   than one link with similar text is in view, hinting will narrow down
  87   the choices as you type.  You can always specify the one you want by
  88   disambiguating the sequence with the hint number.
  89 </p>
  90
  91 <p>
  92   But hinting is for more than just hyperlinks.  Conkeror provides
  93   several <em>hint classes</em> for operating on different types of
  94   elements.  The hint class is specified by typing the corresponding
  95   key sequence of the class before the key sequence of the command.
  96   It was not necessary to specify a hint class for following the
  97   hyperlink above because links are the default hint class for the
  98   follow command.  The following table lists the most common hint
  99   classes.
 100 </p>
 101
 102 <table>
 103   <tr><td><em>key</em></td><td><em>hint class</em></td><td><em>mnemonic</em></td></tr>
 104   <tr><td><code class="key">n</code></td><td>links and form elements</td><td>liNk</td></tr>
 105   <tr><td><code class="key">i</code></td><td>images</td><td>Image</td></tr>
 106   <tr><td><code class="key">m</code></td><td>frameset frames and top window</td><td>fraMe</td></tr>
 107   <tr><td><code class="key">* M</code></td><td>MathML nodes</td><td>Math</td></tr>
 108 </table>
 109
 110 <p>
 111   The <code class="key">c</code> key is bound to a command to copy an URL to the
 112   clipboard.  Its default hint class is links.  To copy the URL of the
 113   page you are currently browsing, you use the frameset link class.
 114   The top level window with or without a frameset is always number 0
 115   (zero).  On this tutorial page, you can type <code class="key">m c</code> to
 116   copy the current URL.  You do not need to type 0 because this is not
 117   a frameset document.  If this were a frameset document, you would
 118   type <code class="key">m c 0</code>.
 119 </p>
 120
 121 <p>
 122   To have Conkeror prompt you for an URL and navigate there, type
 123   <code class="key">g</code>.  The mnemonic is "go".  A similar command,
 124   <code class="key">find-alternate-url</code>, is called with the sequence
 125   <code class="key">C-x C-v</code>.  When find-alternate-url prompts you for an
 126   url, the prompt will be pre-filled with the url of the current
 127   buffer, so you can edit it.
 128 </p>
 129
 130 <h3>Copying Text</h3>
 131 <p>
 132   Gecko has a feature called caret browsing that gives you a blinking
 133   cursor that you can move and select document text with the keyboard.
 134   To enter caret browsing mode in Conkeror, press <code class="key">C-q F7</code>.
 135   You can move the caret with the normal movement keys, isearch
 136   (<code class="key">C-s</code> or <code class="key">C-r</code>), or with certain browser
 137   object commands like <em>focus link</em> (<code class="key">n ;</code>).  Select
 138   text by holding shift while pressing arrow keys.  Exit caret
 139   browsing mode by pressing <code class="key">C-q F7</code> again.  Press
 140   <code class="key">M-w</code> to copy the selection to the clipboard.
 141 </p>
 142
 143 </body>
 144 </html>