mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-01-06 05:04:11 +01:00
Rename appname/idname to appName/idName in help files to maintain parity with code.
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
|
||||
<document
|
||||
name="tutorial"
|
||||
title="&dactyl.appname; Tutorial"
|
||||
title="&dactyl.appName; Tutorial"
|
||||
xmlns="&xmlns.dactyl;"
|
||||
xmlns:html="&xmlns.html;">
|
||||
<!-- Initial revision: Sun Jun 8 10:07:05 UTC 2008 (penryu) -->
|
||||
@@ -14,12 +14,12 @@
|
||||
|
||||
<html:p style="text-align: center">
|
||||
This is a quickstart 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.
|
||||
</html:p>
|
||||
|
||||
<p>
|
||||
If you've started using &dactyl.appname; from scratch (i.e., without any
|
||||
If you've started using &dactyl.appName; from scratch (i.e., without any
|
||||
customization), you should be looking at this help page in a relatively
|
||||
bare-looking window. The menubar, navigation bar, and bookmark bars are hidden.
|
||||
In case you missed the notice in the <t>intro</t>, you can
|
||||
@@ -35,43 +35,43 @@
|
||||
|
||||
<p>
|
||||
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 be
|
||||
reversed with <ex>:set go=<k name="CR"/></ex>) You can look at the entry for <o>guioptions</o> in
|
||||
<t>options</t> for more information on this.
|
||||
</p>
|
||||
|
||||
<h2 tag="modal">&dactyl.appname;'s modal interface</h2>
|
||||
<h2 tag="modal">&dactyl.appName;'s modal interface</h2>
|
||||
|
||||
<p>
|
||||
&dactyl.appname;'s power, like Vim's, comes from it's modal interface. Keys have
|
||||
different meanings depending on which mode the browser is in. &dactyl.appname; has
|
||||
&dactyl.appName;'s power, like Vim's, comes from it's modal interface. Keys have
|
||||
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
|
||||
<em>Command-line</em> mode.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
When &dactyl.appname; starts, it is in Normal mode by default. This is probably where
|
||||
When &dactyl.appName; starts, it is in Normal mode by default. This is probably where
|
||||
you will spend the majority of your time.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The other core mode of &dactyl.appname;, Command-line mode, can be entered from
|
||||
Normal mode by typing a <k>:</k> (colon). You will frequently see &dactyl.appname;
|
||||
The other core mode of &dactyl.appName;, Command-line mode, can be entered from
|
||||
Normal mode by typing a <k>:</k> (colon). You will frequently see &dactyl.appName;
|
||||
commands start with a <k>:</k>, indicating that what follows is a command.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To return to Normal mode from Command-line mode, type <k name="Esc"/>. Pressing
|
||||
<k name="Esc"/> will also return you to Normal mode from most other modes in
|
||||
&dactyl.appname;.
|
||||
&dactyl.appName;.
|
||||
</p>
|
||||
|
||||
<h2 tag="getting-help">Getting help</h2>
|
||||
|
||||
<p>
|
||||
Vim is a great editor but it's not much of a web browser. So even seasoned Vim
|
||||
users will probably have to look at &dactyl.appname;'s documentation sooner or later.
|
||||
Most of the documentation for &dactyl.appname;'s features are easily found using the
|
||||
users will probably have to look at &dactyl.appName;'s documentation sooner or later.
|
||||
Most of the documentation for &dactyl.appName;'s features are easily found using the
|
||||
<ex>:help</ex> command. For example, you can find help on the <ex>:help</ex> command
|
||||
by typing
|
||||
</p>
|
||||
@@ -104,16 +104,16 @@
|
||||
<em>– or how I learned to stop worrying and love the 80+ buttons I already have.</em>
|
||||
|
||||
<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,
|
||||
relies on the user being able to keep his fingers on the keyboard where they
|
||||
can do the most good. While there are some areas where the mouse is clearly
|
||||
superior at, such as GUI design or some games, &dactyl.appname; acts on the
|
||||
superior at, such as GUI design or some games, &dactyl.appName; acts on the
|
||||
assumption that a web browser doesn't have to be one of those.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Here are some areas where the mouse is typically considered indisposable, and
|
||||
how &dactyl.appname; challenges this preconception.
|
||||
how &dactyl.appName; challenges this preconception.
|
||||
</p>
|
||||
|
||||
<h2 tag="keyboard-scrolling">Scrolling</h2>
|
||||
@@ -202,27 +202,27 @@
|
||||
<h2 tag="hints-tutorial">Some hints about surfing…</h2>
|
||||
|
||||
<p>
|
||||
So now you can navigate around in &dactyl.appname;. But wait… how do you <em>open</em> a
|
||||
So now you can navigate around in &dactyl.appName;. But wait… how do you <em>open</em> a
|
||||
page or tab linked in a web page? How do you <em>click</em> on all those links
|
||||
without your tailed friend?
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The answer is <em>hints</em>. Activating hints displays a number next to every link
|
||||
&dactyl.appname; can find. To follow the link, simply type the number corresponding
|
||||
&dactyl.appName; can find. To follow the link, simply type the number corresponding
|
||||
to the hint, a white number inside a red square by default.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
For text links, there's an additional shortcut; you can type some text
|
||||
contained in the link and &dactyl.appname; will search all the links it can find and
|
||||
contained in the link and &dactyl.appName; will search all the links it can find and
|
||||
only hint the matching links, further narrowing down the list. If the text you
|
||||
type uniquely identifies any given link, &dactyl.appname; will follow that link
|
||||
type uniquely identifies any given link, &dactyl.appName; will follow that link
|
||||
immediately without any further user input.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Whichever way you choose to indicate your target link, once &dactyl.appname; has
|
||||
Whichever way you choose to indicate your target link, once &dactyl.appName; has
|
||||
highlighted the link you want, simply hit <k name="Enter"/> to open it.
|
||||
</p>
|
||||
|
||||
@@ -234,10 +234,10 @@
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To test it, try this link: <link target="&dactyl.apphome;">&dactyl.appname; Homepage</link>.
|
||||
To test it, try this link: <link target="&dactyl.apphome;">&dactyl.appName; Homepage</link>.
|
||||
Activate QuickHint 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
|
||||
uniquely identified soon, and &dactyl.appname; will open it. Once you're done,
|
||||
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> (<em>Delete Buffer</em>)
|
||||
to return here, depending on which key you used to activate QuickHint mode.
|
||||
</p>
|
||||
@@ -262,14 +262,14 @@
|
||||
<h2 tag="pentadactylrc">Saving for posterity—<tt>pentadactylrc</tt></h2>
|
||||
|
||||
<p>
|
||||
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;.
|
||||
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;.
|
||||
Continuing the Vim theme, this is done with a <tt>pentadactylrc</tt> file.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To save your current settings and allow them to be loaded automatically
|
||||
next time you start &dactyl.appname;, issue the <ex>:mkp</ex> command.
|
||||
next time you start &dactyl.appName;, issue the <ex>:mkp</ex> command.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
@@ -281,7 +281,7 @@
|
||||
<h2 tag="quitting-without-menus">Find the exit nearest you</h2>
|
||||
|
||||
<p>
|
||||
&dactyl.appname; supports all of Vim's classic methods of exiting.
|
||||
&dactyl.appName; supports all of Vim's classic methods of exiting.
|
||||
</p>
|
||||
|
||||
<dl>
|
||||
@@ -307,7 +307,7 @@
|
||||
|
||||
<p>
|
||||
You might feel pretty disoriented now. Don't worry. This is still &dactyl.host;
|
||||
underneath. Here are some ways &dactyl.appname; allows &dactyl.host; to shine through. See
|
||||
underneath. Here are some ways &dactyl.appName; allows &dactyl.host; to shine through. See
|
||||
the <ex>:help</ex> for these commands and mappings for more information on how to
|
||||
make the best use of them.
|
||||
</p>
|
||||
@@ -320,18 +320,18 @@
|
||||
</dd>
|
||||
<dt><ex>:bmarks</ex></dt>
|
||||
<dd>
|
||||
&dactyl.appname; provides a new interface to bookmarks, but they're still your
|
||||
&dactyl.appName; provides a new interface to bookmarks, but they're still your
|
||||
standard &dactyl.host; bookmarks under the hood. <ex>:bmark</ex> will add a new
|
||||
bookmark, while <ex>:bmarks</ex> will list the bookmarks currently defined.
|
||||
</dd>
|
||||
<dt><ex>:history</ex></dt>
|
||||
<dd>
|
||||
It's exactly what it sounds like. This command will display a colorized,
|
||||
scrollable and clickable list of the locations in &dactyl.appname;'s history.
|
||||
scrollable and clickable list of the locations in &dactyl.appName;'s history.
|
||||
</dd>
|
||||
<dt><ex>:emenu</ex></dt>
|
||||
<dd>
|
||||
Access the &dactyl.host; menus through the &dactyl.appname; command line.
|
||||
Access the &dactyl.host; menus through the &dactyl.appName; command line.
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -354,9 +354,9 @@
|
||||
</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>. Issuing this
|
||||
command brings up the &dactyl.host; Add-ons dialog window; you can then remove it as
|
||||
normal, selecting &dactyl.appname; from the list and clicking (yes, clicking)
|
||||
normal, selecting &dactyl.appName; from the list and clicking (yes, clicking)
|
||||
<em>Uninstall</em>.
|
||||
</p>
|
||||
|
||||
@@ -369,8 +369,8 @@
|
||||
<h2 tag="support">I'm interested… but lost!</h2>
|
||||
|
||||
<p>
|
||||
&dactyl.appname; has an energetic and growing user base. If you've run into a problem
|
||||
that you can't seem to solve with &dactyl.appname;, or if you think you might have
|
||||
&dactyl.appName; has an energetic and growing user base. If you've run into a problem
|
||||
that you can't seem to solve with &dactyl.appName;, or if you think you might have
|
||||
found a bug, please let us know! There is support available on the
|
||||
<link target="http://code.google.com/p/pentadactyl-labs/w/list?q=label%3Aproject-pentadactyl">wiki</link>
|
||||
or in the <link target="irc://irc.freenode.net/pentadactyl">#pentadactyl</link> IRC
|
||||
@@ -379,7 +379,7 @@
|
||||
|
||||
<p>
|
||||
If you have any feature requests or (even better) offers to help, we'd love to
|
||||
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
|
||||
us to get around to it, rest assured patches are welcome! See the
|
||||
<t>developer</t> page for more information.
|
||||
|
||||
Reference in New Issue
Block a user