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