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