1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-01-21 09:54:11 +01:00

Update Xulmus docs, in theory.

--HG--
branch : xslt
rename : common/locale/en-US/intro.xml => vimperator/locale/en-US/intro.xml
rename : common/locale/en-US/tutorial.xml => vimperator/locale/en-US/tutorial.xml
This commit is contained in:
Kris Maglione
2009-10-24 18:45:11 -04:00
parent 2c1f7316a6
commit c697b165a0
61 changed files with 550 additions and 6072 deletions

View File

@@ -1,6 +1,7 @@
<!ENTITY liberator.mainWindow "main-window">
<!ENTITY liberator.name "vimperator">
<!ENTITY liberator.idname "VIMPERATOR">
<!ENTITY liberator.appname "Vimperator">
<!ENTITY liberator.host "Firefox">
<!ENTITY liberator.statusBefore "statusbar-display">

View File

@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE overlay SYSTEM "chrome://liberator/content/liberator.dtd">
<overlay
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<include href="tutorial" tag="tutorial.html" insertafter="intro.html" />
</overlay>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE overlay SYSTEM "chrome://liberator/content/liberator.dtd">
<overlay
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<dl tag="autocommand-list" replace="autocommand-list">
<dt>BookmarkAdd</dt> <dd>Triggered after a page is bookmarked</dd>
<dt>ColorScheme</dt> <dd>Triggered after a color scheme has been loaded</dd>
<dt>DOMLoad</dt> <dd>Triggered when a page's DOM content has fully loaded</dd>
<dt>DownloadPost</dt> <dd>Triggered when a download has completed</dd>
<dt>Fullscreen</dt> <dd>Triggered when the browser's fullscreen state changes</dd>
<dt>LocationChange</dt> <dd>Triggered when changing tabs or when navigating to a new location</dd>
<dt>PageLoadPre</dt> <dd>Triggered after a page load is initiated</dd>
<dt>PageLoad</dt> <dd>Triggered when a page gets (re)loaded/opened</dd>
<dt>PrivateMode</dt> <dd>Triggered when private mode is activated or deactivated</dd>
<dt>Sanitize</dt> <dd>Triggered when privata data are sanitized</dd>
<dt>ShellCmdPost</dt> <dd>Triggered after executing a shell command with <ex>:!</ex><a>cmd</a></dd>
<dt>VimperatorEnter</dt> <dd>Triggered after Firefox starts</dd>
<dt>VimperatorLeavePre</dt><dd>Triggered before exiting Firefox, just before destroying each module</dd>
<dt>VimperatorLeave</dt> <dd>Triggered before exiting Firefox</dd>
</dl>
<dl tag="autocommand-args" replace="autocommand-args">
<dt>&lt;url></dt> <dd>The URL against which the event was selected.</dd>
<dt>&lt;title></dt> <dd>The page, bookmark or download title.</dd>
<dt>&lt;doc></dt> <dd>The document for which the event occurred. Only for <em>DOMLoad</em>, <em>PageLoad</em> and <em>PageLoadPre</em>.</dd>
<dt>&lt;tab></dt> <dd>The tab in which the event occurred. Only for <em>DOMLoad</em>, <em>PageLoad</em> and <em>PageLoadPre</em>.</dd>
<dt>&lt;tags></dt> <dd>The tags applied to &lt;url>. Only for <em>BookmarkAdd</em>.</dd>
<dt>&lt;keyword></dt> <dd>The keywords applied to the bookmark. Only for <em>BookmarkAdd</em>.</dd>
<dt>&lt;icon></dt> <dd>The icon associated with &lt;url>. Only for <em>BookmarkAdd</em>.</dd>
<dt>&lt;size></dt> <dd>The size of a downloaded file. Only for <em>DownloadPost</em>.</dd>
<dt>&lt;file></dt> <dd>The target destination of a download. Only for <em>DownloadPost</em>.</dd>
<dt>&lt;state></dt> <dd>The new state. Only for "Fullscreen" and <em>PrivateMode</em>.</dd>
<dt>&lt;name></dt> <dd>The name of the item. Only for <em>ColorScheme</em> and <em>Sanitize</em>.</dd>
</dl>
</overlay>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE overlay SYSTEM "chrome://liberator/content/liberator.dtd">
<overlay
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<dl tag="dialog-list" replace="dialog-list">
<dt>about</dt> <dd>About Mozilla &liberator.host;;</dd>
<dt>addbookmark</dt> <dd>Add bookmark for the current page</dd>
<dt>addons</dt> <dd>Manage Add-ons</dd>
<dt>bookmarks</dt> <dd>List your bookmarks</dd>
<dt>checkupdates</dt> <dd>Check for updates</dd>
<dt>cleardata</dt> <dd>Clear private data</dd>
<dt>cookies</dt> <dd>List your cookies</dd>
<dt>console</dt> <dd>JavaScript console</dd>
<dt>customizetoolbar</dt><dd>Customize the Toolbar</dd>
<dt>dominspector</dt> <dd>DOM Inspector</dd>
<dt>downloads</dt> <dd>Manage Downloads</dd>
<dt>history</dt> <dd>List your history</dd>
<dt>import</dt> <dd>Import Preferences, Bookmarks, History, etc. from other browsers</dd>
<dt>openfile</dt> <dd>Open the file selector dialog</dd>
<dt>pageinfo</dt> <dd>Show information about the current page</dd>
<dt>pagesource</dt> <dd>View page source</dd>
<dt>places</dt> <dd>Places Organizer: Manage your bookmarks and history</dd>
<dt>preferences</dt> <dd>Show &liberator.host; preferences dialog</dd>
<dt>printpreview</dt> <dd>Preview the page before printing</dd>
<dt>printsetup</dt> <dd>Setup the page size and orientation before printing</dd>
<dt>print</dt> <dd>Show print dialog</dd>
<dt>saveframe</dt> <dd>Save frame to disk</dd>
<dt>savepage</dt> <dd>Save page to disk</dd>
<dt>searchengines</dt> <dd>Manage installed search engines</dd>
<dt>selectionsource</dt> <dd>View selection source</dd>
</dl>
</overlay>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -0,0 +1,211 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE document SYSTEM "chrome://liberator/content/liberator.dtd">
<document
name="intro"
title="&liberator.appname; Introduction"
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<logo/>
<html:p style="text-align: center; font-weight: bold;">
First there was a Navigator, then there was an Explorer.
Later it was time for a Konqueror. Now it's time for an Imperator, the
VIMperator :)
</html:p>
<h1 tag="intro">Introduction</h1>
<link topic="http://vimperator.org">&liberator.appname;</link> is a free browser add-on for &liberator.host;,
which makes it look and behave like the
<link topic="http://www.vim.org">Vim</link>
text editor. It has similar key bindings, and you could call it a modal
web browser, as key bindings differ according to which mode you are in.
<warning tag="warning">
To provide the most authentic Vim experience, the &liberator.host; menubar and toolbar are hidden.
</warning>
<p>If you really need them, type: <ex>:set guioptions+=mT</ex> to get them back.</p>
<p>
If you don't like &liberator.appname; at all, you can uninstall it by typing
<ex>:extdelete &liberator.appname;</ex> or <ex>:extdisable &liberator.appname;</ex> to disable it.
</p>
<p>
If you like it but can't remember the shortcuts, then press
<key name="F1"/> or <ex>:help</ex> to get this help window back.
</p>
<tags>author donaton sponsor</tags>
<p>
&liberator.appname; was initially written by
<link topic="mailto:stubenschrott@vimperator.org">Martin
Stubenschrott</link> but has found many other
<link topic="http://vimperator.org/trac/wiki/&liberator.appname;/Authors">contributors</link>
in the meanwhile. If you appreciate the work on &liberator.appname; and want to
encourage us working on it more, you can send us greetings, patches, or
donations (thanks a lot to
<link topic="http://vimperator.org/trac/wiki/&liberator.appname;/Donors">these
people</link>
who already did):
</p>
<html:form style="text-align: center;" action="https://www.paypal.com/cgi-bin/webscr" method="post"><fieldset class="paypal">
<input type="hidden" name="cmd" value="_s-xclick"/>
<input type="image" src="chrome://liberator/content/x-click-but21.gif" name="submit" alt="Make payments with PayPal - it's fast, free and secure!"/>
<input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIHPwYJKoZIhvcNAQcEoIIHMDCCBywCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYBDDJfc+lXLBSAM9XSWv/ebzG/L7PTqYiIXaWVg8pfinDsfYaAcifcgCTuApg4v/VaZIQ/hLODzQu2EvmjGXP0twErA/Q8G5gx0l197PJSyVXb1sLwd1mgOdLF4t0HmDCdEI9z3H6CMhsb3xVwlfpzllSfCIqzlSpx4QtdzEZGzLDELMAkGBSsOAwIaBQAwgbwGCSqGSIb3DQEHATAUBggqhkiG9w0DBwQI8ZOwn5QkHgaAgZjjtPQxB7Vw2rS7Voap9y+xdVLoczUQ97hw+bOdZLcGykBtfoVjdn76MS51QKjGp1fEmxkqTuQ+Fxv8+OVtHu0QF/qlrhmC3fJBRJ0IFWxKdXS+Wod4615BDaG2X1hzvCL443ffka8XlLSiFTuW43BumQs/O+6Jqsk2hcReP3FIQOvtWMSgGTALnZx7x5c60u/3NSKW5qvyWKCCA4cwggODMIIC7KADAgECAgEAMA0GCSqGSIb3DQEBBQUAMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTAeFw0wNDAyMTMxMDEzMTVaFw0zNTAyMTMxMDEzMTVaMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwUdO3fxEzEtcnI7ZKZL412XvZPugoni7i7D7prCe0AtaHTc97CYgm7NsAtJyxNLixmhLV8pyIEaiHXWAh8fPKW+R017+EmXrr9EaquPmsVvTywAAE1PMNOKqo2kl4Gxiz9zZqIajOm1fZGWcGS0f5JQ2kBqNbvbg2/Za+GJ/qwUCAwEAAaOB7jCB6zAdBgNVHQ4EFgQUlp98u8ZvF71ZP1LXChvsENZklGswgbsGA1UdIwSBszCBsIAUlp98u8ZvF71ZP1LXChvsENZklGuhgZSkgZEwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tggEAMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAgV86VpqAWuXvX6Oro4qJ1tYVIT5DgWpE692Ag422H7yRIr/9j/iKG4Thia/Oflx4TdL+IFJBAyPK9v6zZNZtBgPBynXb048hsP16l2vi0k5Q2JKiPDsEfBhGI+HnxLXEaUWAcVfCsQFvd2A1sxRr67ip5y2wwBelUecP3AjJ+YcxggGaMIIBlgIBATCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTA3MDMyMTIyMzI1OFowIwYJKoZIhvcNAQkEMRYEFCirrvlwYVHQiNEEbM6ikfx9+Dm5MA0GCSqGSIb3DQEBAQUABIGAtbsR8GdCdURLziozXLSdtY+zJZUPPeQFXXy2V1S/3ldiN+pRvd4HI7xz8mOY1UaKJZpwZnOosy9MflL1/hbiEtEyQ2Dm/s4jnTcJng/NjLIZu+0NYxXRJhB+zMJubnMMMjzNrGlqI4F2HAB/bCA1eOJ5B83Of3dA4rk/T/8GoSQ=-----END PKCS7-----"/>
</fieldset>
</html:form>
<p>
If you prefer getting some nice products for your money, you can also support
us by buying some cool
<link topic="http://www.zazzle.com/maxauthority*">merchandise</link> like
t-shirts or mugs. Of course, as we believe in free, open source software, only
support us financially if you really like &liberator.appname; and the money doesn't hurt
— otherwise just use it, recommend it, and like it :)
</p>
<h2 tag="overview">Help topics</h2>
<ol>
<li>
<link topic="tutorial">Quick-start tutorial</link>:
A quick-start tutorial for new users.
</li>
<li>
<link topic="starting">Starting &liberator.appname;</link>:
How &liberator.appname; starts up, where it reads the config file…
</li>
<li>
<link topic="browsing">Browsing</link>:
Basic mappings and commands needed for a browsing session (how to open
a web page or go back in history).
</li>
<li>
<link topic="buffer">Buffer</link>:
Operations on the current document like scrolling or copying text.
</li>
<li>
<link topic="cmdline">Command-line mode</link>:
Command-line editing.
</li>
<li>
<link topic="insert">Insert mode</link>:
Insert-mode editing.
</li>
<li>
<link topic="options">Options</link>:
A description of all options.
</li>
<li>
<link topic="pattern">Text search commands</link>:
Searching for text in the current buffer.
</li>
<li>
<link topic="tabs">Tabs</link>:
Managing your tabbed browsing session.
</li>
<li>
<link topic="hints">Hints</link>:
Selecting hyperlinks and other page elements.
</li>
<li>
<link topic="">Key mappings, abbreviations, and user-defined commands</link>:
Defining new key mappings, abbreviations and user commands.
</li>
<li>
<link topic="eval">Expression evaluation</link>:
Executing JavaScript.
</li>
<li>
<link topic="marks">Marks</link>:
Using bookmarks, QuickMarks, history and local marks.
</li>
<li>
<link topic="repeat">Repeating commands</link>:
Using macros to repeat recurring workflows.
</li>
<li>
<link topic="autocommands">Automatic commands</link>:
Automatically executing code on certain events.
</li>
<li>
<link topic="print">Printing</link>:
Printing pages.
</li>
<li>
<link topic="gui">&liberator.appname;'s GUI</link>:
Accessing &liberator.host; menus, dialogs and the sidebar.
</li>
<li>
<link topic="styling">Styling the GUI and web pages</link>:
Changing the styling of content pages and &liberator.appname; itself.
</li>
<li>
<link topic="message">Error and informational messages</link>:
A description of messages and error messages.
</li>
<li>
<link topic="developer">Developer information</link>:
How to write docs or plugins.
</li>
<li>
<link topic="various">Various commands</link>:
Other help which didn't fit into any other category.
</li>
<li>
<link topic="index">Index</link>:
An index of all commands and options.
</li>
</ol>
<p>
You can also jump directly to the help of a specific command with <ex>:help o</ex>
or <ex>:help :set</ex>.
</p>
<h2 tag="features">Features</h2>
<ul>
<li>Vim-like keybindings (<k>h</k>, <k>j</k>, <k>k</k>, <k>l</k>, <k>gg</k>, <k>G</k>, <k>0</k>, <k>$</k>, <k>ZZ</k>, <k name="C-f"/>, etc.)</li>
<li>Ex commands (<ex>:quit</ex>, <ex>:open www.foo.com</ex>, …)</li>
<li>Tab completion available for all commands with support for "longest" matching when set in 'wildmode'</li>
<li>Hit-a-hint like navigation of links (start with <k>f</k> to follow a link)</li>
<li>Advanced completion of bookmark and history URLs (searching also in title, not only URL)</li>
<li>Vim-like statusline with a Wget-like progress bar</li>
<li>Minimal GUI (easily hide useless menubar and toolbar with <ex>:set guioptions=</ex>)</li>
<li>Ability to <ex>:source</ex> JavaScript files, and to use a <em>~/.vimperatorrc</em> file with syntax highlighting if you install vimperator.vim</li>
<li>Easy quick searches (<ex>:open foo</ex> will search for "foo" in google, <ex>:open ebay terminator</ex> will search for "terminator" on ebay) with support for &liberator.host; keyword bookmarks and search engines</li>
<li>Count supported for many commands (<em>3</em><k name="C-o"/> will go back 3 pages)</li>
<li>Beep on errors</li>
<li>Marks support (<k>m</k><em>a</em> to set mark a on a web page, <k>'</k><em>a</em> to go there)</li>
<li>QuickMarks support (quickly go to previously marked web pages with <k>go</k><a>a-zA-Z0-9</a>)</li>
<li><ex>:map</ex> and <ex>:command</ex> support (and feedkeys() for script writers)</li>
<li><ex>:time</ex> support for profiling</li>
<li>Move the text cursor and select text with Vim keys and a Visual mode</li>
<li>External editor support</li>
<li>Macros to replay key strokes</li>
<li>AutoCommands to execute actions on certain events</li>
<li>A comprehensive help system, explaining all commands, mappings and options</li>
</ul>
<h2 tag="contact">Contact</h2>
<p>
Please send comments/bug reports/patches to the mailing list, where we will
properly answer any questions. You can also join the
<link topic="irc://irc.freenode.net/vimperator">#vimperator</link> IRC channel
on <link target="http://www.freenode.net/">Freenode</link> or check the
<link topic="http://vimperator.org/trac/wiki/&liberator.appname;/Wiki">Wiki</link> for
<link topic="http://vimperator.org/trac/wiki/&liberator.appname;/FAQ">
frequently asked questions (FAQ)
</link>. Make sure, you have read the TODO file first, as we are aware of many
things which can be improved when we find time for it or receive patches.
</p>
</document>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE overlay SYSTEM "chrome://liberator/content/liberator.dtd">
<overlay
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<item insertbefore=":set">
<tags>:seg :way</tags>
<spec>:se[a]</spec>
<description>
<p>Show all options that differ from their default value.</p>
</description>
</item>
<item insertafter=":set-default">
<tags>:sturm :drang</tags>
<spec>:und</spec>
<description>
<p>Show all options that differ from their default value.</p>
</description>
</item>
</overlay>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -0,0 +1,369 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE document SYSTEM "chrome://liberator/content/liberator.dtd">
<document
name="tutorial"
title="&liberator.appname; Tutorial"
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<!-- Initial revision: Sun Jun 8 10:07:05 UTC 2008 (penryu) -->
<h1 tag="tutorial">Quick-start tutorial</h1>
<html:p style="text-align: center">
This is a quickstart tutorial to help get new users up and running
in &liberator.appname;. It is not intended as a full reference explaining all
features.
</html:p>
<p>
If you've started using &liberator.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
regain these by issuing the command
</p>
<code><ex>:set go+=mTB<key name="CR"/></ex></code>
<p>
where <k name="CR"/> represents pressing the <key name="Enter"/> or <key name="Return"/> key.
If you're a veteran Vim user, this may look familiar. It should.
</p>
<p>
However, in this author's opinion, the best way to get familiar with
&liberator.appname; is to leave these disabled for now. (The above action can be
reversed with <ex>:set go=<key 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">&liberator.appname;'s modal interface</h2>
<p>
&liberator.appname;'s power, like Vim's, comes from it's modal interface. Keys have
different meanings depending on which mode the browser is in. &liberator.appname; has
several modes, but the 2 most important are <em>Normal</em> mode and
<em>Command-line</em> mode.
</p>
<p>
When &liberator.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 &liberator.appname;, Command-line mode, can be entered from
Normal mode by typing a <k>:</k> (colon). You will frequently see &liberator.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
&liberator.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 &liberator.appname; documentation sooner or later.
Most of the documentation for &liberator.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>
<code><ex>:help :help<key name="CR"/></ex></code>
<p>
Similarly, help on configurable options is available with
<ex>:help '<a>option_name</a>'</ex>. (Note the single quotes
around the option name as in Vim.) Information on all available
options is, predictably, <ex>:help options</ex>.
</p>
<p>
And you can find out about the <k>gt</k> and <k>gT</k> mapping with
</p>
<code>
<ex>:help gt<key name="CR"/></ex>
<ex>:help gT<key name="CR"/></ex>
</code>
<p>
Finally, in addition to the help system itself, <ex>:exusage</ex>, <ex>:viusage</ex>
and <ex>:optionusage</ex> are useful quick-reference commands.
</p>
<h2 tag="living-mouseless">Mouseless</h2>
<em> or how I learned to stop worrying and love the 80+ buttons I already have.</em>
<p>
The efficiency of &liberator.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, &liberator.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 &liberator.appname; challenges this preconception.
</p>
<h2 tag="keyboard-scrolling">Scrolling</h2>
<p>
Scrolling the browser window is done with simple keystrokes:
</p>
<ul>
<li><k>j</k>/<k>k</k>
scroll window down/up by one line, respectively
</li>
<li><k>h</k>/<k>l</k>
scroll window left/right
</li>
<li><k name="Space"/>/<k name="C-b"/>
scroll down/up by one page
</li>
<li><k name="C-d"/>/<k name="C-u"/>
scroll down/up by 1/2 page
</li>
</ul>
<p>
Your standard buttons (<k name="Up"/>/<k name="Down"/>/<k name="PgUp"/>/<k name="PgDn"/>) will
also work as expected.
</p>
<h2 tag="history-navigation tab-navigation">History and tabs</h2>
<p>
History navigation (e.g., <em>Back</em>, <em>Forward</em>) are done similarly to
scrolling.
</p>
<ul>
<li><k name="C-o"/>/<k name="C-i"/>
move Back/Forward in the current window/tab's history, respectively
</li>
</ul>
<p>
Move between tabs using these keystrokes which may also be familiar to tabbing
Vimmers.
</p>
<ul>
<li><k>gt</k>/<k name="C-n"/>
go to the next tab
</li>
<li><k>gT</k>/<k name="C-p"/>
go to the previous tab
</li>
<li><k>g0</k>/<k>g$</k>
go to the first/last tab
</li>
<li><k>d</k>
close the active tab (delete the buffer)
</li>
</ul>
<p>
To open a web page in a new tab, use the <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>,
respectively, map to these commands, so the following pairs of sequences are
equivalent:
</p>
<code>
<ex>:open my.webmail.com<key name="CR"/></ex>
<k>o</k>my.webmail.com<key name="CR"/>
<ex>:tabopen vimperator.org<key name="CR"/></ex>
<k>t</k>vimperator.org<key name="CR"/>
</code>
<h2 tag="hints-tutorial">Some hints about surfing…</h2>
<p>
So now you can navigate around in &liberator.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
&liberator.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 &liberator.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, &liberator.appname; will follow that link
immediately without any further user input.
</p>
<p>
Whichever way you choose to indicate your target link, once &liberator.appname; has
highlighted the link you want, simply hit <k name="Enter"/> to open it.
</p>
<p>
The most common hint mode is called <t>quick-hints</t>.
To activate QuickHint mode, press either <k>f</k> or <k>F</k>. The lower-case
<k>f</k> will open the resulting link in the current tab, while the upper-case
<k>F</k> will open it in a new tab.
</p>
<p>
To test it, try this link: <link target="http://vimperator.org/">&liberator.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 &liberator.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>
<h2 tag="common-issues">Common issues</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="vimperatorrc">Saving for posterity - vimperatorrc</h2>
<p>
Once you get &liberator.appname; set up with your desired options, maps, and commands,
you'll probably want them to be available the next time you open &liberator.appname;.
Continuing the Vim theme, this is done with a vimperatorrc file.
</p>
<p>
To save your current settings and allow them to be loaded automatically
next time you start &liberator.appname;, issue the <ex>:mkv</ex> command.
</p>
<p>
This will create the file <em>$HOME/.vimperatorrc</em> containing your settings.
It is a simple text file, just like a vimrc file and can be easily
edited to suit your preferences.
</p>
<h2 tag="quitting-without-menus">Find the exit nearest you</h2>
<p>
&liberator.appname; supports all of Vim's classic methods of exiting.
</p>
<ul>
<li><ex>:xall</ex> command to quit and save the current browsing
session for next time; the default.
</li>
<li><ex>:qall</ex> command to quit <em>without</em> saving the session
</li>
<li><k>ZZ</k> Normal mode mapping equivalent to <ex>:xall</ex>
</li>
<li><k>ZQ</k> Normal mode mapping equivalent to <ex>:qall</ex>
</li>
</ul>
<h2 tag="whither-firefox">Where did &liberator.host; go?</h2>
<p>
You might feel pretty disoriented now. Don't worry. This is still &liberator.host;
underneath. Here are some ways &liberator.appname; allows &liberator.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>
<ul>
<li><ex>:dialog</ex>
To access some of &liberator.host;'s many dialog windows, you can use the
<ex>:dialog</ex> command. See <ex>:help :dialog</ex>.
</li>
<li><ex>:bmarks</ex>
&liberator.appname; provides a new interface to bookmarks, but they're still your
standard &liberator.host; bookmarks under the hood. <ex>:bmark</ex> will add a new
bookmark, while <ex>:bmarks</ex> will list the bookmarks currently defined.
</li>
<li><ex>:history</ex>
It's exactly what it sounds like. This command will display a colorized,
scrollable and clickable list of the locations in &liberator.appname;'s history.
</li>
<li><ex>:emenu</ex>
Access the &liberator.host; menus through the &liberator.appname; command line.
</li>
</ul>
<p>
Feel free to explore at this point. If you use the <ex>:tabopen</ex> command,
remember to use the <k>gt</k>/<k>gT</k> mappings to get back to this page. If
using the <ex>:open</ex> command, use the history keys (e.g., <k>H</k>) to return.
If you get hopelessly lost, just type <ex>:help<key name="CR"/></ex> and click the
<em>Tutorial</em> link to return.
</p>
<!-- TODO: other sections? -->
<h2 tag="removal">Get me out of here!</h2>
<p>
If you've given it a fair shot and determined … TODO
</p>
<p>
The &liberator.appname; way to do this is with the command <ex>:addons</ex>. Issuing this
command brings up the &liberator.host; Add-ons dialog window; you can then remove it as
normal, selecting &liberator.appname; from the list and clicking (yes, clicking)
<em>Uninstall</em>.
</p>
<p>
Alternatively, you can do this the old-fashioned way: re-enable the menubar,
as above, with <ex>:set go+=m</ex>, and select <em>Add-ons</em> from the <em>Tools</em> menu.
</p>
<h2 tag="support">I'm interested… but lost!</h2>
<p>
&liberator.appname; has an energetic and growing user base. If you've run into a problem
that you can't seem to solve with &liberator.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/vimperator-labs/w/list?q=label%3Aproject-vimperator">wiki</link>
or in the <link target="irc://irc.freenode.net/vimperator">#vimperator</link> IRC
channel on <link target="http://freenode.net/">freenode</link>.
</p>
<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 &liberator.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.
</p>
</document>
<!-- vim:se sts=4 sw=4 et: -->

View File

@@ -1,360 +0,0 @@
/* TODO: this file is a total debacle. Find out exactly which version it was
* based on and extract the Vimperator required modifications to a separate
* file. It's not called "Cascading" for nothing! --djk */
/* keep the mozdev header */
/* @import url(http://www.mozdev.org/skin/color/mozdev2k.css); */
/*
CSS stylesheet for XHTML produced by DocBook XSL stylesheets.
Tested with XSL stylesheets 1.61.2, 1.67.2
*/
span.strong {
font-weight: bold;
}
a {
color: #4A708B;
text-decoration: none;
}
body blockquote {
margin-top: .75em;
line-height: 1.5;
margin-bottom: .75em;
}
html body {
/*margin: 1em 5% 1em 5%;*/
margin: auto;
padding-left: 25px;
padding-right: 25px;
line-height: 1.2;
font-family: -moz-fixed;
max-width: 800px;
}
body div {
margin: 0;
}
h1, h2, h3, h4, h5, h6,
div.toc p b,
div.list-of-figures p b,
div.list-of-tables p b,
div.abstract p.title
{
color: #527bbd;
}
div.toc p:first-child,
div.list-of-figures p:first-child,
div.list-of-tables p:first-child,
div.example p.title
{
margin-bottom: 0.1em;
}
body h1 {
margin: .0em 0 0 -4%;
line-height: 1.3;
border-bottom: 1px solid silver;
}
body h2 {
/* necessary, because we put h2 into tables */
margin-top: 20px !important;
margin-bottom: 0px !important;
line-height: 1.3;
/*border-bottom: 1px solid silver;*/
}
body h3 {
margin: .8em 0 0 -3%;
line-height: 1.3;
}
body h4 {
margin: .8em 0 0 -3%;
line-height: 1.3;
}
body h5 {
margin: .8em 0 0 -2%;
line-height: 1.3;
}
body h6 {
margin: .8em 0 0 -1%;
line-height: 1.3;
}
body hr {
border: none; /* Broken on IE6 */
}
div.footnotes hr {
border: 1px solid silver;
}
div.navheader th, div.navheader td, div.navfooter td {
font-size: 0.9em;
font-weight: bold;
color: #527bbd;
}
div.navheader img, div.navfooter img {
border-style: none;
}
div.navheader a, div.navfooter a {
font-weight: normal;
}
div.navfooter hr {
border: 1px solid silver;
}
body td {
line-height: 1.2
}
body th {
line-height: 1.2;
}
ol {
line-height: 1.2;
}
ul, body dir, body menu {
line-height: 1.2;
}
html {
margin: 0;
padding: 0;
}
body h1, body h2, body h3, body h4, body h5, body h6 {
margin-left: 0
}
body pre {
margin: 0.5em 10% 0.5em 1em;
line-height: 1.2;
color: navy;
}
tt.literal, code.literal {
color: navy;
}
.programlisting, .screen, .listingblock {
border: 1px solid silver;
background: #f4f4f4;
margin: 0.5em 10% 0.5em 0;
padding: 0.5em 1em;
}
div.sidebar {
background: #ffffee;
margin: 1.0em 10% 0.5em 0;
padding: 0.5em 1em;
border: 1px solid silver;
}
div.sidebar * { padding: 0; }
div.sidebar div { margin: 0; }
div.sidebar p.title {
margin-top: 0.5em;
margin-bottom: 0.2em;
}
div.bibliomixed {
margin: 0.5em 5% 0.5em 1em;
}
#footer {
margin: 15px;
text-align: center;
color: gray;
}
div.glossary dt {
font-weight: bold;
}
div.glossary dd p {
margin-top: 0.2em;
}
dl {
margin: .8em 0;
line-height: 1.2;
}
dt {
margin-top: 0.5em;
}
dt span.term {
font-style: italic;
}
div.variablelist dd p {
margin-top: 0;
}
div.itemizedlist li, div.orderedlist li {
margin-left: -0.8em;
margin-top: 0.5em;
}
ul, ol {
list-style-position: outside;
}
div.sidebar ul, div.sidebar ol {
margin-left: 2.8em;
}
div.itemizedlist p.title,
div.orderedlist p.title,
div.variablelist p.title
{
margin-bottom: -0.8em;
}
div.revhistory table {
border-collapse: collapse;
border: none;
}
div.revhistory th {
border: none;
color: #527bbd;
}
div.revhistory td {
border: 1px solid silver;
}
/* Keep TOC and index lines close together. */
div.toc dl, div.toc dt,
div.list-of-figures dl, div.list-of-figures dt,
div.list-of-tables dl, div.list-of-tables dt,
div.indexdiv dl, div.indexdiv dt
{
line-height: normal;
margin-top: 0;
margin-bottom: 0;
}
/*
Table styling does not work because of overriding attributes in
generated HTML.
*/
div.table table,
div.informaltable table
{
margin-left: 0;
margin-right: 5%;
margin-bottom: 0.8em;
}
div.informaltable table
{
margin-top: 0.4em
}
div.table thead,
div.table tfoot,
div.table tbody,
div.informaltable thead,
div.informaltable tfoot,
div.informaltable tbody
{
/* No effect in IE6. */
border-top: 2px solid #527bbd;
border-bottom: 2px solid #527bbd;
}
div.table thead, div.table tfoot,
div.informaltable thead, div.informaltable tfoot
{
font-weight: bold;
}
div.mediaobject img {
border: 1px solid silver;
margin-bottom: 0.8em;
}
div.figure p.title,
div.table p.title
{
margin-top: 1em;
margin-bottom: 0.4em;
}
@media print {
div.navheader, div.navfooter { display: none; }
}
/* my additions */
span.tag, span.hiddentag {
font-weight: bold;
color: rgb(255, 0, 255); /* magenta */
padding-left: 15px;
float: right;
}
/* inside a table cell means this tag is part of a section */
td span.tag {
padding-top: 25px !important;
}
span.key {
color: rgb(255, 0, 255); /* magenta */
min-width: 120px; /* with 20px padding actually 140px */
/*padding-bottom: 5px;*/
padding-right: 20px;
float: left;
}
span.warning {
font-weight: bold;
color: red;
}
span.info {
font-weight: bold;
color: blue;
}
fieldset.paypal {
border: none;
}
.argument {
color: #6A97D4;
}
.command {
font-weight: bold;
color: #632610;
white-space: nowrap;
}
.mapping {
font-weight: bold;
color: #102663;
}
.option {
font-weight: bold;
color: #106326;
}
.option, .mapping, .command {
text-decoration: none;
}
.option:hover, .mapping:hover, .command:hover {
text-decoration: underline;
}
.quoteblock {
margin-left: 140px;
padding-bottom: 10px;
}
/* FIXME: hack to match old table formatting with new table syntax - a possibly vain attempt to stop dpb's whinging. --djk */
p.table {
margin-top: 0;
margin-bottom: 0;
}
/* vim: set fdm=marker sw=4 ts=4 et: */