1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-01-06 10:54:12 +01:00

Help edits.

- fix the outdated <C-o>/<C-i> information
- edit the Pentadactyl tutorial
- remove last remnants of CTRL in help tags
This commit is contained in:
Štěpán Němec
2011-08-10 12:33:10 +02:00
parent f58f70fd98
commit fd9fa1ebe9
4 changed files with 79 additions and 84 deletions

View File

@@ -31,7 +31,7 @@ want to bypass &dactyl.appName;'s key handling and pass keys directly to
</item> </item>
<item> <item>
<tags><![CDATA[send-key <pass-next-key> <C-v> CTRL-V]]></tags> <tags><![CDATA[send-key <pass-next-key> <C-v>]]></tags>
<spec><![CDATA[<C-v>]]></spec> <spec><![CDATA[<C-v>]]></spec>
<description> <description>
<p> <p>
@@ -41,7 +41,7 @@ want to bypass &dactyl.appName;'s key handling and pass keys directly to
</item> </item>
<item> <item>
<tags><![CDATA[pass-through <pass-all-keys> <C-z> CTRL-Z]]></tags> <tags><![CDATA[pass-through <pass-all-keys> <C-z>]]></tags>
<spec><![CDATA[<C-z>]]></spec> <spec><![CDATA[<C-z>]]></spec>
<description> <description>
<p> <p>
@@ -264,7 +264,7 @@ want to bypass &dactyl.appName;'s key handling and pass keys directly to
<h2 tag="navigating">Navigating</h2> <h2 tag="navigating">Navigating</h2>
<item> <item>
<tags><![CDATA[H CTRL-O :ba :back]]></tags> <tags><![CDATA[H :ba :back]]></tags>
<spec>:<oa>count</oa>ba<oa>ck</oa> <oa>url</oa></spec> <spec>:<oa>count</oa>ba<oa>ck</oa> <oa>url</oa></spec>
<spec>:ba<oa>ck</oa>!</spec> <spec>:ba<oa>ck</oa>!</spec>
<description> <description>
@@ -278,7 +278,7 @@ want to bypass &dactyl.appName;'s key handling and pass keys directly to
</item> </item>
<item> <item>
<tags><![CDATA[L CTRL-I :fo :fw :forward]]></tags> <tags><![CDATA[L :fo :fw :forward]]></tags>
<spec>:<oa>count</oa>fo<oa>rward</oa> <oa>url</oa></spec> <spec>:<oa>count</oa>fo<oa>rward</oa> <oa>url</oa></spec>
<spec>:fo<oa>rward</oa>!</spec> <spec>:fo<oa>rward</oa>!</spec>
<description> <description>

View File

@@ -190,10 +190,8 @@
<spec><![CDATA[[count]<C-o>]]></spec> <spec><![CDATA[[count]<C-o>]]></spec>
<description> <description>
<p> <p>
Go to an older position in the jump list. This currently Go to an older position in the jump list.
entails moving backward in page history, but in the If <oa>count</oa> is specified, jump <oa>count</oa> positions backward.
future will take into account page positions as well.
If <oa>count</oa> is specified go back <oa>count</oa> pages.
</p> </p>
</description> </description>
</item> </item>
@@ -204,10 +202,8 @@
<spec><![CDATA[[count]<C-i>]]></spec> <spec><![CDATA[[count]<C-i>]]></spec>
<description> <description>
<p> <p>
Go to an newer position in the jump list. This currently Go to a newer position in the jump list.
entails moving forward in page history, but in the If <oa>count</oa> is specified, jump <oa>count</oa> positions forward.
future will take into account page positions as well.
If <oa>count</oa> is specified go forward <oa>count</oa> pages.
</p> </p>
</description> </description>
</item> </item>
@@ -217,7 +213,10 @@
<strut/> <strut/>
<spec>[count]H</spec> <spec>[count]H</spec>
<description> <description>
<p>Go back in the browser history. If <oa>count</oa> is specified go back <oa>count</oa> pages.</p> <p>
Go back in the browser history. If <oa>count</oa> is specified, go
back <oa>count</oa> pages.
</p>
</description> </description>
</item> </item>
@@ -227,8 +226,8 @@
<spec><oa>count</oa>L</spec> <spec><oa>count</oa>L</spec>
<description> <description>
<p> <p>
Go forward in the browser history. If <oa>count</oa> is specified go forward <oa>count</oa> Go forward in the browser history. If <oa>count</oa> is specified,
pages. go forward <oa>count</oa> pages.
</p> </p>
</description> </description>
</item> </item>
@@ -239,7 +238,8 @@
<spec>:<oa>count</oa>ba<oa>ck</oa>!</spec> <spec>:<oa>count</oa>ba<oa>ck</oa>!</spec>
<description> <description>
<p> <p>
Go back in the browser history. If <oa>count</oa> is specified go back <oa>count</oa> pages. Go back in the browser history. If <oa>count</oa> is specified, go
back <oa>count</oa> pages.
</p> </p>
<p> <p>
The special version <ex>:back!</ex> goes to the beginning of the browser history. The special version <ex>:back!</ex> goes to the beginning of the browser history.
@@ -253,8 +253,8 @@
<spec>:<oa>count</oa>fo<oa>rward</oa>!</spec> <spec>:<oa>count</oa>fo<oa>rward</oa>!</spec>
<description> <description>
<p> <p>
Go forward in the browser history. If <oa>count</oa> is specified go forward <oa>count</oa> Go forward in the browser history. If <oa>count</oa> is specified,
pages. go forward <oa>count</oa> pages.
</p> </p>
<p> <p>
The special version <ex>:forward!</ex> goes to the end of the browser history. The special version <ex>:forward!</ex> goes to the end of the browser history.

View File

@@ -87,7 +87,7 @@
</item> </item>
<item> <item>
<tags><![CDATA[<redraw-screen> <C-l> CTRL-L :redr :redraw]]></tags> <tags><![CDATA[<redraw-screen> <C-l> :redr :redraw]]></tags>
<strut/> <strut/>
<spec>:redr<oa>aw</oa></spec> <spec>:redr<oa>aw</oa></spec>
<description> <description>

View File

@@ -9,11 +9,10 @@
xmlns="&xmlns.dactyl;" xmlns="&xmlns.dactyl;"
xmlns:html="&xmlns.html;"> xmlns:html="&xmlns.html;">
<!-- Initial revision: Sun Jun 8 10:07:05 UTC 2008 (penryu) -->
<h1 tag="tutorial">Quick-start tutorial</h1> <h1 tag="tutorial">Quick-start tutorial</h1>
<note> <note>
This is a quickstart tutorial to help new users get up and running This is a quick-start tutorial to help new users get up and running
in &dactyl.appName;. It is not intended as a full reference explaining all in &dactyl.appName;. It is not intended as a full reference explaining all
features. features.
</note> </note>
@@ -31,14 +30,14 @@
<p> <p>
where <k name="CR"/> represents pressing the <k name="Enter" link="false"/> where <k name="CR"/> represents pressing the <k name="Enter" link="false"/>
or <k name="Return" link="false"/> key. If you're a veteran Vim user, this or <k name="Return" link="false"/> key. If you're a veteran Vim user, this
may look familiar. It should. should look familiar.
</p> </p>
<p> <p>
However, in this author's opinion, the best way to get familiar with However, in this author's opinion, the best way to get familiar with
&dactyl.appName; is to leave these disabled for now. (The above action can be &dactyl.appName; is to leave these disabled for now. (The above action can
reversed with <se opt="go" op="&amp;"/><k name="CR"/>) You can look at the entry be reversed with <se opt="go" op="&amp;"/><k name="CR"/>) You can have a
for <o>guioptions</o> in <t>options</t> for more information on this. look at the <o>guioptions</o> help entry for more information on this.
</p> </p>
<h2 tag="modal">&dactyl.appName;'s modal interface</h2> <h2 tag="modal">&dactyl.appName;'s modal interface</h2>
@@ -47,7 +46,7 @@
&dactyl.appName;'s power, like Vim's, comes from its modal interface. Keys have &dactyl.appName;'s power, like Vim's, comes from its modal interface. Keys have
different meanings depending on which mode the browser is in. &dactyl.appName; has different meanings depending on which mode the browser is in. &dactyl.appName; has
several modes, but the 2 most important are <em>Normal</em> mode and several modes, but the 2 most important are <em>Normal</em> mode and
<em>Command Line</em> mode. <em>Command Line</em> mode (see <t>modes</t> for the full picture).
</p> </p>
<p> <p>
@@ -62,9 +61,9 @@
</p> </p>
<p> <p>
To return to Normal mode from Command Line mode, type <k name="Esc"/>. Pressing To return to Normal mode from Command Line mode, type <k name="Esc"/>.
<k name="Esc"/> will also return you to Normal mode from most other modes in Pressing <k name="Esc"/> will also return you to Normal mode from most
&dactyl.appName;. other &dactyl.appName; modes.
</p> </p>
<h2 tag="getting-help">Getting help</h2> <h2 tag="getting-help">Getting help</h2>
@@ -103,7 +102,7 @@
<h2 tag="living-mouseless">Mouseless</h2> <h2 tag="living-mouseless">Mouseless</h2>
<em> or how I learned to stop worrying and love the 80+ buttons I already have.</em> <em> or how I learned to stop worrying and love the 80+ buttons I already have.</em>
<p> <p>
The efficiency of &dactyl.appName;, as with the legendary editor it was inspired by, The efficiency of &dactyl.appName;, as with the legendary editor it was inspired by,
@@ -133,7 +132,7 @@
<dd> <dd>
scroll window left/right scroll window left/right
</dd> </dd>
<dt><k name="Space"/>/<k name="C-b"/></dt> <dt><k name="C-f"/>/<k name="C-b"/></dt>
<dd> <dd>
scroll down/up by one page scroll down/up by one page
</dd> </dd>
@@ -151,20 +150,24 @@
<h2 tag="history-navigation tab-navigation">History and tabs</h2> <h2 tag="history-navigation tab-navigation">History and tabs</h2>
<p> <p>
History navigation (e.g., <em>Back</em>, <em>Forward</em>) are done similarly to History navigation (e.g., <em>Back</em>, <em>Forward</em>) is done similarly to
scrolling. scrolling.
</p> </p>
<dl> <dl>
<dt><k>H</k>/<k>L</k></dt>
<dd>
move back/forward in the current tab's history
</dd>
<dt><k name="C-o"/>/<k name="C-i"/></dt> <dt><k name="C-o"/>/<k name="C-i"/></dt>
<dd> <dd>
move Back/Forward in the current window/tab's history, respectively move back/forward in the current tab's jump list
</dd> </dd>
</dl> </dl>
<p> <p>
Move between tabs using these keystrokes which may also be familiar to tabbing Move between tabs using these keystrokes which may also be familiar to
Vimmers. tabbing Vimmers:
</p> </p>
<dl> <dl>
@@ -187,7 +190,7 @@
</dl> </dl>
<p> <p>
To open a web page in a new tab, use the <ex>:tabopen <a>url</a></ex>. To open a URL in To open a web page in a new tab, use <ex>:tabopen <a>url</a></ex>. To open a URL in
the current tab, use <ex>:open</ex>. The Normal mode mappings <k>t</k> and <k>o</k>, the current tab, use <ex>:open</ex>. The Normal mode mappings <k>t</k> and <k>o</k>,
respectively, map to these commands, so the following pairs of sequences are respectively, map to these commands, so the following pairs of sequences are
equivalent: equivalent:
@@ -210,9 +213,10 @@
</p> </p>
<p> <p>
The answer is <em>hints</em>. Activating hints displays a number next to every link The answer is <t>hints</t>. Activating hints displays a number next to
&dactyl.appName; can find. To follow the link, simply type the number corresponding every link (or other element, depending on the mode) &dactyl.appName; can
to the hint. find. To act on the element (e.g., follow or save a link), simply type
the number corresponding to the hint.
</p> </p>
<p> <p>
@@ -234,39 +238,27 @@
upper-case <k>F</k> will open it in a new tab. upper-case <k>F</k> will open it in a new tab.
</p> </p>
<p>
Extended hint modes, started by <k>;</k> or <k>g;</k>, provide a richer way
to interact with various elements, not limited to following links.
</p>
<p> <p>
To test it, try this link: <link topic="&dactyl.apphome;">&dactyl.appName; Homepage</link>. To test it, try this link: <link topic="&dactyl.apphome;">&dactyl.appName; Homepage</link>.
Activate Hints mode with <k>f</k> or <k>F</k> to highlight all currently Activate Hints mode with <k>f</k> or <k>F</k> to highlight all currently
visible links. Then start typing the text of the link. The link should be visible links. Then start typing the text of the link. The link should be
uniquely identified soon, and &dactyl.appName; will open it. Once you're uniquely identified soon, and &dactyl.appName; will open it. Once you're
done, remember to use <k name="C-o"/> (<em>History Back</em>) or <k>d</k> done, remember to use <k>H</k> (<em>History Back</em>) or <k>d</k>
(<em>Delete Buffer</em>) to return here, depending on which key you used to (<em>Delete Buffer</em>) to return here, depending on which key you used to
activate Hints mode. activate Hints mode.
</p> </p>
<h2 tag="common-issues">Common issues</h2> <h2 tag="saving-customization">Saving for posterity—<tt>pentadactylrc</tt></h2>
<p>
Say you get half-way done typing in a new URL, only to remember that you've
already got that page open in the previous tab. Your command line might look
something like this:
</p>
<code><ex>:open my.partial.url/fooba</ex></code>
<p>
You can exit the command line and access the already loaded page with the
following:
</p>
<code><k name="Esc"/></code>
<h2 tag="pentadactylrc">Saving for posterity—<tt>pentadactylrc</tt></h2>
<p> <p>
Once you get &dactyl.appName; set up with your desired options, maps, and commands, Once you get &dactyl.appName; set up with your desired options, maps, and commands,
you'll probably want them to be available the next time you open &dactyl.appName;. you'll probably want them to be available the next time you open &dactyl.appName;.
Continuing the Vim theme, this is done with a <tt>pentadactylrc</tt> file. Continuing the Vim theme, this is done with a <tt><t>pentadactylrc</t></tt> file.
</p> </p>
<p> <p>
@@ -289,11 +281,11 @@
<dl> <dl>
<dt><ex>:xall</ex></dt> <dt><ex>:xall</ex></dt>
<dd> <dd>
command to quit and save the current browsing session for next time; the default. quit and save the current browsing session for next time; the default
</dd> </dd>
<dt><ex>:qall</ex></dt> <dt><ex>:exit</ex></dt>
<dd> <dd>
command to quit <em>without</em> saving the session quit <em>without</em> saving the session
</dd> </dd>
<dt><k>ZZ</k></dt> <dt><k>ZZ</k></dt>
<dd> <dd>
@@ -301,17 +293,17 @@
</dd> </dd>
<dt><k>ZQ</k></dt> <dt><k>ZQ</k></dt>
<dd> <dd>
Normal mode mapping equivalent to <ex>:qall</ex> Normal mode mapping equivalent to <ex>:exit</ex>
</dd> </dd>
</dl> </dl>
<h2 tag="whither-&dactyl.host;">Where did &dactyl.host; go?</h2> <h2 tag="whither-&dactyl.host;">Where did &dactyl.host; go?</h2>
<p> <p>
You might feel pretty disoriented now. Don't worry. This is still &dactyl.host; You might feel pretty disoriented now. Don't worry. This is still
underneath. Here are some ways &dactyl.appName; allows &dactyl.host; to shine through. See &dactyl.host; underneath. Here are some ways &dactyl.appName; allows
the <ex>:help</ex> for these commands and mappings for more information on how to &dactyl.host; to shine through (see the <ex>:help</ex> for these commands
make the best use of them. and mappings for more information on how to make the best use of them):
</p> </p>
<dl> <dl>
@@ -338,11 +330,9 @@
</dl> </dl>
<p> <p>
Feel free to explore at this point. If you use the <ex>:tabopen</ex> command, Feel free to explore at this point. If you get hopelessly lost, just type
remember to use the <k>gt</k>/<k>gT</k> mappings to get back to this page. If <ex>:help<k name="CR"/></ex> and click the <em>Quick-start tutorial</em>
using the <ex>:open</ex> command, use the history keys (e.g., <k>H</k>) to return. link to return here.
If you get hopelessly lost, just type <ex>:help<k name="CR"/></ex> and click the
<em>Tutorial</em> link to return.
</p> </p>
<!-- TODO: other sections? --> <!-- TODO: other sections? -->
@@ -350,30 +340,35 @@
<h2 tag="removal">Get me out of here!</h2> <h2 tag="removal">Get me out of here!</h2>
<p> <p>
If you've given it a fair shot and determined … TODO If you've given it a fair shot and determined that &dactyl.appName; is not
for you after all, you might want to disable it.
</p> </p>
<p> <p>
The &dactyl.appName; way to do this is with the command <ex>:addons</ex>. Issuing this The &dactyl.appName; way to do this is with the command <ex>:addons</ex>,
command brings up the &dactyl.host; Add-ons dialog window; you can then remove it as which displays a list of all installed extensions. You can use hints or
normal, selecting &dactyl.appName; from the list and clicking (yes, clicking) mouse to click on <em>Off</em> or <em>Del</em> to disable or remove
<em>Uninstall</em>. &dactyl.appName;, respectively.
</p> </p>
<p> <p>
Alternatively, you can do this the old-fashioned way: re-enable the menubar, Alternatively, you can do this the old-fashioned way: re-enable the menubar,
as above, with <se opt="go" op="+=">m</se>, and select <em>Add-ons</em> from the <em>Tools</em> menu. as above, with <se opt="go" op="+=">m</se>, and select <em>Add-ons</em>
from the <em>Tools</em> menu. You can also use <ex>:dialog addons</ex> to
get to the interface.
</p> </p>
<h2 tag="support">I'm interested… but lost!</h2> <h2 tag="support">I'm interested… but lost!</h2>
<p> <p>
&dactyl.appName; has an energetic and growing user base. If you've run into a problem &dactyl.appName; has an energetic and growing user base. If you've run into
that you can't seem to solve with &dactyl.appName;, or if you think you might have a problem that you can't seem to solve with &dactyl.appName;, or if you
found a bug, please let us know! There is support available on the think you might have found a bug, please let us know! There is support
<link topic="http://code.google.com/p/dactyl/w/list?q=label%3Aproject-&dactyl.name;">wiki</link> available on the <link topic="&dactyl.list.href;">mailing list</link>
(mirrored on <link topic="http://dir.gmane.org/gmane.comp.mozilla.firefox.pentadactyl">Gmane</link>)
or in the <link topic="irc://irc.oftc.net/pentadactyl">#pentadactyl</link> IRC or in the <link topic="irc://irc.oftc.net/pentadactyl">#pentadactyl</link> IRC
channel on <link topic="http://oftc.net/">OFTC</link>. channel on <link topic="http://oftc.net/">OFTC</link>. See also
<t>contact</t>.
</p> </p>
<p> <p>
@@ -381,7 +376,7 @@
hear from you as well. Developers work on &dactyl.appName; whenever possible, but we hear from you as well. Developers work on &dactyl.appName; whenever possible, but we
are neither infinite nor omnipotent; please bear with us. If you can't wait for are neither infinite nor omnipotent; please bear with us. If you can't wait for
us to get around to it, rest assured patches are welcome! See the us to get around to it, rest assured patches are welcome! See the
<link topic="developer">developer</link> page for more information. <t>developer</t> page for more information.
</p> </p>
</document> </document>