mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-01-04 18:04:12 +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:
@@ -10,100 +10,49 @@
|
||||
xmlns:html="http://www.w3.org/1999/xhtml">
|
||||
<tags>all</tags>
|
||||
|
||||
<!-- TODO: this should be generated by the Makefile in the same order as
|
||||
config.helpFiles -->
|
||||
<include href="intro" tag="intro.html"/>
|
||||
|
||||
<tags>intro.html</tags>
|
||||
<include href="starting" tag="starting.html"/>
|
||||
|
||||
<include href="intro"/>
|
||||
<include href="browsing" tag="browsing.html"/>
|
||||
|
||||
<tags>tutorial.html</tags>
|
||||
<include href="buffer" tag="buffer.html"/>
|
||||
|
||||
<include href="tutorial"/>
|
||||
<include href="cmdline" tag="cmdline.html"/>
|
||||
|
||||
<tags>starting.html</tags>
|
||||
<include href="insert" tag="insert.html"/>
|
||||
|
||||
<include href="starting"/>
|
||||
<include href="options" tag="options.html"/>
|
||||
|
||||
<tags>browsing.html</tags>
|
||||
<include href="pattern" tag="pattern.html"/>
|
||||
|
||||
<include href="browsing"/>
|
||||
<include href="tabs" tag="tabs.html"/>
|
||||
|
||||
<tags>buffer.html</tags>
|
||||
<include href="hints" tag="hints.html"/>
|
||||
|
||||
<include href="buffer"/>
|
||||
<include href="map" tag="map.html"/>
|
||||
|
||||
<tags>cmdline.html</tags>
|
||||
<include href="eval" tag="eval.html"/>
|
||||
|
||||
<include href="cmdline"/>
|
||||
<include href="marks" tag="marks.html"/>
|
||||
|
||||
<tags>insert.html</tags>
|
||||
<include href="repeat" tag="repeat.html"/>
|
||||
|
||||
<include href="insert"/>
|
||||
<include href="autocommands" tag="autocommands.html"/>
|
||||
|
||||
<tags>options.html</tags>
|
||||
<include href="print" tag="print.html"/>
|
||||
|
||||
<include href="options"/>
|
||||
<include href="gui" tag="gui.html"/>
|
||||
|
||||
<tags>pattern.html</tags>
|
||||
<include href="styling" tag="styling.html"/>
|
||||
|
||||
<include href="pattern"/>
|
||||
<include href="message" tag="message.html"/>
|
||||
|
||||
<tags>tabs.html</tags>
|
||||
<include href="developer" tag="developer.html"/>
|
||||
|
||||
<include href="tabs"/>
|
||||
<include href="various" tag="various.html"/>
|
||||
|
||||
<tags>hints.html</tags>
|
||||
|
||||
<include href="hints"/>
|
||||
|
||||
<tags>map.html</tags>
|
||||
|
||||
<include href="map"/>
|
||||
|
||||
<tags>eval.html</tags>
|
||||
|
||||
<include href="eval"/>
|
||||
|
||||
<tags>marks.html</tags>
|
||||
|
||||
<include href="marks"/>
|
||||
|
||||
<tags>repeat.html</tags>
|
||||
|
||||
<include href="repeat"/>
|
||||
|
||||
<tags>autocommands.html</tags>
|
||||
|
||||
<include href="autocommands"/>
|
||||
|
||||
<tags>print.html</tags>
|
||||
|
||||
<include href="print"/>
|
||||
|
||||
<tags>gui.html</tags>
|
||||
|
||||
<include href="gui"/>
|
||||
|
||||
<tags>styling.html</tags>
|
||||
|
||||
<include href="styling"/>
|
||||
|
||||
<tags>message.html</tags>
|
||||
|
||||
<include href="message"/>
|
||||
|
||||
<tags>developer.html</tags>
|
||||
|
||||
<include href="developer"/>
|
||||
|
||||
<tags>various.html</tags>
|
||||
|
||||
<include href="various"/>
|
||||
|
||||
<tags>index.html</tags>
|
||||
|
||||
<include href="index"/>
|
||||
<include href="index" tag="index.html"/>
|
||||
|
||||
</document>
|
||||
<!-- vim:se sts=4 sw=4 et: -->
|
||||
|
||||
@@ -41,22 +41,7 @@
|
||||
|
||||
<p>Available <a>events</a>:</p>
|
||||
|
||||
<dl>
|
||||
<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-list"/>
|
||||
|
||||
<p><a>pat</a> is a regular expression, use .* if you want to match all URLs.</p>
|
||||
|
||||
@@ -64,19 +49,7 @@
|
||||
|
||||
<p>The following keywords are available where relevant:</p>
|
||||
|
||||
<dl>
|
||||
<dt><url></dt> <dd>The URL against which the event was selected.</dd>
|
||||
<dt><title></dt> <dd>The page, bookmark or download title.</dd>
|
||||
<dt><doc></dt> <dd>The document for which the event occurred. Only for <em>DOMLoad</em>, <em>PageLoad</em> and <em>PageLoadPre</em>.</dd>
|
||||
<dt><tab></dt> <dd>The tab in which the event occurred. Only for <em>DOMLoad</em>, <em>PageLoad</em> and <em>PageLoadPre</em>.</dd>
|
||||
<dt><tags></dt> <dd>The tags applied to <url>. Only for <em>BookmarkAdd</em>.</dd>
|
||||
<dt><keyword></dt> <dd>The keywords applied to the bookmark. Only for <em>BookmarkAdd</em>.</dd>
|
||||
<dt><icon></dt> <dd>The icon associated with <url>. Only for <em>BookmarkAdd</em>.</dd>
|
||||
<dt><size></dt> <dd>The size of a downloaded file. Only for <em>DownloadPost</em>.</dd>
|
||||
<dt><file></dt> <dd>The target destination of a download. Only for <em>DownloadPost</em>.</dd>
|
||||
<dt><state></dt> <dd>The new state. Only for "Fullscreen" and <em>PrivateMode</em>.</dd>
|
||||
<dt><name></dt> <dd>The name of the item. Only for <em>ColorScheme</em> and <em>Sanitize</em>.</dd>
|
||||
</dl>
|
||||
<dl tag="autocommand-args"/>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ have 2 possibilities:
|
||||
opened in new tabs.
|
||||
Each token is analyzed and in this order:
|
||||
</p>
|
||||
|
||||
|
||||
<ol>
|
||||
<li>
|
||||
Opened as a local file if it is an existing relative or absolute filename.
|
||||
@@ -92,7 +92,7 @@ have 2 possibilities:
|
||||
background tab).
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
|
||||
<p>
|
||||
You can use <ex>:open -tags linux torvalds<k name="Tab"/></ex> to complete bookmarks with
|
||||
tag "linux" and which contain "torvalds". Note that -tags support is only
|
||||
@@ -100,14 +100,6 @@ have 2 possibilities:
|
||||
The items which are completed on <k name="Tab"/> are specified in the <o>complete</o>
|
||||
option.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Sometimes, you might not be aware if you already have a certain page loaded in
|
||||
some background tab or not. Therefore you can just type <ex>:open facebook<k name="Tab"/></ex>
|
||||
and switch to it if Facebook is already open, or otherwise open it (if you
|
||||
have Facebook in your bookmarks or history cache). This behavior can be turned
|
||||
off by removing "t" from your <o>complete</o> option.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
@@ -296,7 +288,7 @@ have 2 possibilities:
|
||||
<spec>:ju<oa>mps</oa></spec>
|
||||
<description>
|
||||
<p>List all jumps aka current tab's history aka session history.</p>
|
||||
|
||||
|
||||
<p>
|
||||
Current history position is marked with >, jump numbers are counters to be used
|
||||
with <ex>:back</ex> (above zero record) or <ex>:forward</ex> (below zero record).
|
||||
@@ -331,7 +323,7 @@ have 2 possibilities:
|
||||
<spec><oa>count</oa>gu</spec>
|
||||
<description>
|
||||
<p>Go to <oa>count</oa>th parent directory.</p>
|
||||
|
||||
|
||||
<p>
|
||||
<k>2gu</k> on
|
||||
<tt>http://www.example.com/dir1/dir2/file.htm</tt> opens
|
||||
@@ -346,7 +338,7 @@ have 2 possibilities:
|
||||
<spec>gU</spec>
|
||||
<description>
|
||||
<p>Go to the root of the web site.</p>
|
||||
|
||||
|
||||
<p>
|
||||
<k>gU</k> on <tt>http://www.example.com/dir1/dir2/file.htm</tt> opens
|
||||
<tt>http://www.example.com/</tt>.
|
||||
|
||||
@@ -473,7 +473,7 @@ preference.
|
||||
between 30% and 300% or a relative value if prefixed with "-" or "+". If
|
||||
<oa>value</oa> is omitted, zoom is reset to 100%.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Normally this command operates on the text zoom; if used with <oa>!</oa>, it
|
||||
operates on full zoom.
|
||||
@@ -533,7 +533,7 @@ then switch between these various style sheets, selecting their favorite.
|
||||
Select the author style sheet to apply. If <oa>stylesheet</oa> is not specified
|
||||
the page's default style sheet is used.
|
||||
</p>
|
||||
|
||||
|
||||
<p>All author styling can be removed by setting the <o>usermode</o> option.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
@@ -59,7 +59,7 @@
|
||||
Example: <ex>:execute "source " + io.getRCFile().path</ex> sources the appropriate
|
||||
RC file.
|
||||
</p>
|
||||
|
||||
|
||||
<p>Note: Unlike Vim this currently only supports a single argument.</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -80,12 +80,12 @@
|
||||
until a line starting with "EOF"
|
||||
is found, and interpret them with the JavaScript <em>eval()</em> function.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
The special version <ex>:javascript!</ex> opens the JavaScript console of
|
||||
Firefox.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
<k name="Tab"/> completion is available for <ex>:javascript <a>cmd</a><k name="Tab"/></ex> (but not
|
||||
yet for the <ex>:js <<EOF</ex> multiline widget). Be aware that Vimperator needs
|
||||
|
||||
@@ -56,7 +56,7 @@
|
||||
<p>Open a &liberator.host; dialog.</p>
|
||||
|
||||
<p>Available dialogs:</p>
|
||||
<dl>
|
||||
<dl tag="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>
|
||||
|
||||
@@ -66,9 +66,9 @@ tedious unless you always visit the first link on a page.
|
||||
location of hint <em>24</em>, press <k>;y</k> to start this hint
|
||||
mode. Then press <em>24</em> to copy the hint location.
|
||||
</p>
|
||||
|
||||
|
||||
<p><a>mode</a> can be one of:</p>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><tag>;;</tag> <em>;</em> to focus a link and hover it with the mouse</li>
|
||||
<li><tag>;?</tag> <em>?</em> to show information about the element (incomplete)</li>
|
||||
@@ -91,13 +91,13 @@ tedious unless you always visit the first link on a page.
|
||||
<li><tag>;i</tag> <em>i</em> to open an image</li>
|
||||
<li><tag>;I</tag> <em>I</em> to open an image in a new tab.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<p>
|
||||
Depending on the value of <o>complete</o>, you can get a list of
|
||||
extended hint modes by pressing <k name="Tab"/> from the <k>;</k>
|
||||
prompt.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Hintable elements for all extended hint modes can be set in the
|
||||
<o>extendedhinttags</o> XPath string.
|
||||
|
||||
@@ -300,7 +300,7 @@ This file contains a list of all available commands, mappings and options.
|
||||
<dt><ex>:marks</ex></dt> <dd>Show all location marks of current web page</dd>
|
||||
<dt><ex>:messages</ex></dt> <dd>Display previously given messages</dd>
|
||||
<dt><ex>:messclear</ex></dt> <dd>Clear the message history</dd>
|
||||
<dt><ex>:mkvimperatorrc</ex></dt> <dd>Write current key mappings and changed options to the config file</dd>
|
||||
<dt><ex>:mk&liberator.name;rc</ex></dt> <dd>Write current key mappings and changed options to the config file</dd>
|
||||
<dt><ex>:nmap</ex></dt> <dd>Map a key sequence in Normal mode</dd>
|
||||
<dt><ex>:nmapclear</ex></dt> <dd>Remove all mappings in Normal mode</dd>
|
||||
<dt><ex>:nnoremap</ex></dt> <dd>Map a key sequence without remapping keys in Normal mode</dd>
|
||||
|
||||
@@ -1,211 +0,0 @@
|
||||
<?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: -->
|
||||
@@ -37,7 +37,7 @@
|
||||
|
||||
<warning>
|
||||
Mappings are NOT saved between sessions, make sure you put them in your
|
||||
vimperatorrc file!
|
||||
&liberator.name;rc file!
|
||||
</warning>
|
||||
|
||||
<h3 tag=":map-commands">Map commands</h3>
|
||||
@@ -433,23 +433,23 @@
|
||||
command is redefined. Unlike Vim, the command may start with a lowercase
|
||||
letter.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
The command's behavior can be specified by providing attributes when the
|
||||
command is defined.
|
||||
</p>
|
||||
|
||||
|
||||
<p tag="E175 E176 :command-nargs">
|
||||
Argument handling
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
By default user commands accept no arguments. This can be changed by specifying
|
||||
the -nargs attribute.
|
||||
</p>
|
||||
|
||||
|
||||
<p>The valid values are:</p>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>-nargs=0</dt><dd>No arguments are allowed (default)</dd>
|
||||
<dt>-nargs=1</dt><dd>One argument is allowed</dd>
|
||||
@@ -457,17 +457,17 @@
|
||||
<dt>-nargs=?</dt><dd>Zero or one argument is allowed</dd>
|
||||
<dt>-nargs=+</dt><dd>One or more arguments are allowed</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<p tag="E180 E181 :command-complete">
|
||||
Argument completion
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Completion for arguments to user defined commands is not available by default.
|
||||
Completion can be enabled by specifying one of the following arguments to the
|
||||
-complete option when defining the command.
|
||||
</p>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>altstyle</dt> <dd>alternate author style sheets</dd>
|
||||
<dt>bookmark</dt> <dd>bookmarks</dd>
|
||||
@@ -494,11 +494,11 @@
|
||||
<dt>usercommand</dt> <dd>user commands</dd>
|
||||
<dt>custom,<a>func</a></dt><dd>custom completion, provided by <a>func</a></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<p tag="E467 E468 :command-completion-custom">
|
||||
Custom completion
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Custom completion can be provided by specifying the <str>custom,<a>func</a></str> argument to
|
||||
-complete. The <a>func</a> is called with two arguments, a completion context, and
|
||||
@@ -506,56 +506,56 @@
|
||||
<str>completions</str> property, or return an object, with <str>items</str> and <str>start</str>
|
||||
properties, describing the completions and where the replacement is to start.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
<em>start</em> is the index into the word being completed at which the returned values
|
||||
should be applied and <em>completions</em> is a two dimensional array of the form:
|
||||
[[arg1, description1], [arg2, description2], …]
|
||||
</p>
|
||||
|
||||
|
||||
<!-- TODO: add examples -->
|
||||
|
||||
|
||||
<p tag="E177 E178 :command-count">
|
||||
Count handling
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
By default user commands do not accept a count. Use the -count attribute if
|
||||
you'd like to have a count passed to your user command. This will then be
|
||||
available for expansion as <count> in the argument.
|
||||
</p>
|
||||
|
||||
|
||||
<p tag=":command-bang">
|
||||
Special cases
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
By default a user command does not have a special version, i.e. a version
|
||||
executed with the ! modifier. Providing the -bang attribute will enable this
|
||||
and <bang> will be available in the argument.
|
||||
</p>
|
||||
|
||||
|
||||
<p tag=":command-description">
|
||||
Command description
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
The command's description text can be set with -description. Otherwise it will
|
||||
default to "User-defined command".
|
||||
</p>
|
||||
|
||||
|
||||
<p tag=":command-replacement-text">
|
||||
Replacement text
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
The replacement text <a>rep</a> is scanned for escape sequences and these are
|
||||
replaced with values from the user-entered command line. The resulting string
|
||||
is then executed as an Ex command.
|
||||
</p>
|
||||
|
||||
|
||||
<p>The valid escape sequences are:</p>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt><args></dt> <dd>The command arguments exactly as supplied</dd>
|
||||
<dt><count></dt><dd>Any supplied count, e.g. 5</dd>
|
||||
@@ -567,7 +567,7 @@
|
||||
literal <args>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<p>
|
||||
"q-" can be prefixed to the escape sequence so that the value is quoted, making
|
||||
it suitable for expression evaluation. Example: <q-args>
|
||||
|
||||
@@ -765,9 +765,9 @@
|
||||
<description>
|
||||
<p>
|
||||
Load plugin scripts when starting up. When on, yet unloaded plugins
|
||||
are automatically loaded after the vimperatorrc file has been
|
||||
are automatically loaded after the &liberator.name;rc file has been
|
||||
sourced. To load plugins earlier, use the <ex>:loadplugins</ex>
|
||||
command within the vimperatorrc.
|
||||
command within the &liberator.name;rc.
|
||||
</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -936,13 +936,13 @@
|
||||
|
||||
|
||||
<item>
|
||||
<tags>$VIMPERATOR_RUNTIME</tags>
|
||||
<tags>$&liberator.idname;_RUNTIME</tags>
|
||||
<tags>'rtp' 'runtimepath'</tags>
|
||||
<spec>'runtimepath' 'rtp'</spec>
|
||||
<type>stringlist</type>
|
||||
<default type="plain"><str>$VIMPERATOR_RUNTIME</str> or
|
||||
Unix, Mac: <str>~/.vimperator</str>,
|
||||
Windows: <str>~/vimperator</str></default>
|
||||
<default type="plain"><str>$&liberator.idname;_RUNTIME</str> or
|
||||
Unix, Mac: <str>~/.&liberator.name;</str>,
|
||||
Windows: <str>~/&liberator.name;</str></default>
|
||||
<description>
|
||||
<p>List of directories searched for runtime files:</p>
|
||||
|
||||
@@ -954,16 +954,16 @@
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<code><ex>:set runtimepath=$$~/myvimperator,~/.vimperator$$</ex></code>
|
||||
<code><ex>:set runtimepath=<str>~/my&liberator.name;,~/.&liberator.name;<str></ex></code>
|
||||
|
||||
<p>
|
||||
This will search for plugins in both
|
||||
<str>~/myvimperator/plugin</str> and
|
||||
<str>~/.vimperator/plugin</str>
|
||||
<str>~/my&liberator.name;/plugin</str> and
|
||||
<str>~/.&liberator.name;/plugin</str>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
On startup, if the environment variable <em>$VIMPERATOR_RUNTIME</em> does not
|
||||
On startup, if the environment variable <em>$&liberator.idname;_RUNTIME</em> does not
|
||||
exist, &liberator.appname; will set it to match this value.
|
||||
</p>
|
||||
</description>
|
||||
@@ -1169,7 +1169,7 @@
|
||||
Change the title of the browser window. &liberator.appname; changes the
|
||||
browser title from <str>Title of web page - Mozilla &liberator.host;</str>
|
||||
to <str>Title of web page - &liberator.appname;</str>. If you don't like
|
||||
that, you can restore it with:
|
||||
that, you can restore it with:
|
||||
</p>
|
||||
<code><ex>:set titlestring=<str>Mozilla &liberator.host;</str></ex></code>
|
||||
</description>
|
||||
@@ -1271,7 +1271,7 @@
|
||||
<description>
|
||||
<p>
|
||||
List of file patterns to ignore when completing files. E.g., to ignore object
|
||||
files and Vim swap files
|
||||
files and Vim swap files
|
||||
<ex>:set wildignore=<str>.<em>\\.o,\\..</em>\\.s[a-z]\\<a>2</a></str></ex>
|
||||
</p>
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
<spec>:ha<oa>rdcopy</oa><oa>!</oa> ><a>filename</a></spec>
|
||||
<description>
|
||||
<p>As above, but write the output to <a>filename</a>.</p>
|
||||
|
||||
|
||||
<note>Not available on Windows.</note>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
@@ -111,7 +111,7 @@
|
||||
which mostly contain Ex commands like <ex>map < gt</ex> and put JavaScript code
|
||||
within a:
|
||||
</p>
|
||||
|
||||
|
||||
<code><![CDATA[
|
||||
js <<EOF
|
||||
hello = function () {
|
||||
@@ -124,7 +124,7 @@ EOF
|
||||
Or you can alternatively source a file which ends in <tt>.js</tt>. These files are
|
||||
automatically sourced as pure JavaScript files.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Note: In both cases you must add functions to the global window object like
|
||||
shown above, functions written as:
|
||||
@@ -136,10 +136,10 @@ function hello2() {
|
||||
}
|
||||
]]></code>
|
||||
<p>are only available within the scope of the script.</p>
|
||||
|
||||
|
||||
<p>
|
||||
The <tt>.vimperatorrc</tt> file in your home directory and any
|
||||
files in <tt>~/.vimperator/plugin/</tt> are always
|
||||
The <tt>.&liberator.name;rc</tt> file in your home directory and any
|
||||
files in <tt>~/.&liberator.name;/plugin/</tt> are always
|
||||
sourced at startup. <tt>~</tt> is supported as a
|
||||
shortcut for the <tt>$HOME</tt> directory. If <oa>!</oa> is
|
||||
specified, errors are not printed.
|
||||
@@ -154,8 +154,8 @@ function hello2() {
|
||||
<description>
|
||||
<p>
|
||||
Load all unloaded plugins immediately. Because plugins are automatically
|
||||
loaded after vimperatorrc is sourced, this command must be placed early
|
||||
in the vimperatorrc file if vimperatorrc also includes commands that are
|
||||
loaded after &liberator.name;rc is sourced, this command must be placed early
|
||||
in the &liberator.name;rc file if &liberator.name;rc also includes commands that are
|
||||
implemented by plugins. Additionally, this command allows for sourcing
|
||||
new plugins without restarting &liberator.appname;.
|
||||
</p>
|
||||
@@ -211,9 +211,9 @@ function hello2() {
|
||||
and returns the elapsed time. <a>code</a> is always passed to JavaScript's eval(),
|
||||
which might be slow, so take the results with a grain of salt.
|
||||
</p>
|
||||
|
||||
|
||||
<p>If <a>code</a> starts with a <ex>:</ex>, it is executed as a &liberator.appname; command.</p>
|
||||
|
||||
|
||||
<p>
|
||||
Use the special version with <oa>!</oa> if you just want to run any command multiple
|
||||
times without showing profiling statistics.
|
||||
|
||||
@@ -13,9 +13,9 @@
|
||||
<tags>startup-options</tags>
|
||||
|
||||
<p>
|
||||
Command-line options can be passed to &liberator.appname; via the -vimperator &liberator.host;
|
||||
Command-line options can be passed to &liberator.appname; via the -&liberator.name; &liberator.host;
|
||||
option. These are passed as single string argument.
|
||||
E.g., firefox -vimperator <str>++cmd 'set exrc' +u 'tempRcFile' ++noplugin</str>
|
||||
E.g., firefox -&liberator.name; <str>++cmd 'set exrc' +u 'tempRcFile' ++noplugin</str>
|
||||
</p>
|
||||
|
||||
<item>
|
||||
@@ -26,7 +26,7 @@
|
||||
Execute a single Ex command after all initialization has been performed. See
|
||||
<t>initialization</t>.
|
||||
</p>
|
||||
|
||||
|
||||
<p>This option can be specified multiple times.</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -40,7 +40,7 @@
|
||||
Execute a single Ex command before any initialization has been performed. See
|
||||
<t>initialization</t>.
|
||||
</p>
|
||||
|
||||
|
||||
<p>This option can be specified multiple times.</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -79,16 +79,16 @@
|
||||
and no further locations are tried.
|
||||
|
||||
<ol>
|
||||
<li tag="$VIMPERATOR_INIT">
|
||||
<em>$VIMPERATOR_INIT</em> — May contain a single Ex command (e.g.,
|
||||
<li tag="$&liberator.idname;_INIT">
|
||||
<em>$&liberator.idname;_INIT</em> — May contain a single Ex command (e.g.,
|
||||
"<ex>:source <a>file</a></ex>").
|
||||
</li>
|
||||
<li tag="$MY_VIMPERATORRC">
|
||||
<em>~/vimperatorrc</em> — Windows only. If this file exists, its contents
|
||||
are executed and <em>$MY_VIMPERATORRC</em> set to its path.
|
||||
<li tag="$MY_&liberator.idname;RC">
|
||||
<em>~/&liberator.name;rc</em> — Windows only. If this file exists, its contents
|
||||
are executed and <em>$MY_&liberator.idname;RC</em> set to its path.
|
||||
</li>
|
||||
<li>
|
||||
<em>~/.vimperatorrc</em> — If this file exists, its contents are executed.
|
||||
<em>~/.&liberator.name;rc</em> — If this file exists, its contents are executed.
|
||||
</li>
|
||||
</ol>
|
||||
</li>
|
||||
@@ -125,16 +125,16 @@ it finds.
|
||||
<h2 tag="save-settings">Saving settings</h2>
|
||||
|
||||
<item>
|
||||
<tags>:mkv :mkvimperatorrc</tags>
|
||||
<tags>:mkv :mk&liberator.name;rc</tags>
|
||||
<spec>:mkv<oa>imperatorrc</oa><oa>!</oa> <oa>file</oa></spec>
|
||||
<description>
|
||||
<p>
|
||||
Write current key mappings and changed options to <oa>file</oa>. If no
|
||||
<oa>file</oa> is specified then <em>~/.vimperatorrc</em> is written unless this file
|
||||
already exists. The special version <ex>:mkvimperatorrc!</ex> will overwrite
|
||||
<oa>file</oa> is specified then <em>~/.&liberator.name;rc</em> is written unless this file
|
||||
already exists. The special version <ex>:mk&liberator.name;rc!</ex> will overwrite
|
||||
<oa>file</oa> if it exists.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Warning: this differs from Vim's behavior which defaults to writing the file
|
||||
in the current directory.
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
Load a color scheme. <a>name</a> is found by searching the <o>runtimepath</o> for the
|
||||
first file matching colors/<a>name</a>.vimp.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
The ColorScheme autocommand is triggered after the color scheme has been
|
||||
sourced.
|
||||
@@ -46,9 +46,9 @@
|
||||
can be any valid CSS selector, such as <ex>:hover</ex>, and, if provided, will
|
||||
restrict the match to matching elements.
|
||||
</p>
|
||||
|
||||
|
||||
<p>Valid groups are:</p>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>Bell</dt> <dd>&liberator.appname;'s visual bell</dd>
|
||||
<dt>Boolean</dt> <dd>A JavaScript Boolean object</dd>
|
||||
@@ -107,7 +107,7 @@
|
||||
<dt>URL</dt> <dd>A URL</dd>
|
||||
<dt>WarningMsg</dt> <dd>A warning message</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<p>
|
||||
Every invocation completely replaces the styling of any previous invocation,
|
||||
unless <em>-append</em> (short option: <em>-a</em>) is provided, in which case <a>css</a> is
|
||||
@@ -140,14 +140,14 @@
|
||||
containing any <em>:</em> or <em>/</em> characters are matched as domains. <a>css</a> is a full
|
||||
CSS rule set (e.g., <tt>body { color: blue; }</tt>).
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
If <a>name</a> (short option: *-n*) is provided, any existing style with the same
|
||||
name is overridden, and the style may later be deleted using <a>name</a>. If
|
||||
*-append* (short option: *-a*) is provided along with *-name*, <a>css</a> and
|
||||
<a>filter</a> are appended to its current value.
|
||||
</p>
|
||||
|
||||
|
||||
<p>If <a>css</a> isn't provided, matching styles are listed.</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -163,7 +163,7 @@
|
||||
style for <str>www.google.com,mozilla.org</str>, will result in a style for
|
||||
<str>www.google.com</str>. The available options are:
|
||||
</p>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><em>-name</em>: The name provided to <ex>:style</ex> (short option: *-n*)</li>
|
||||
<li><em>-index</em>: For unnamed styles, the index listed by <ex>:style</ex>
|
||||
|
||||
@@ -27,9 +27,9 @@
|
||||
Show a list of buffers (=tabs) matching <oa>filter</oa>. Without <oa>filter</oa>
|
||||
list all tabs.
|
||||
</p>
|
||||
|
||||
|
||||
<p>A buffer may be marked with one of the following indicators:</p>
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>%</dt><dd>The current buffer</dd>
|
||||
<dt>#</dt><dd>The alternate buffer for <ex>:e #</ex> and <k name="C-^"/></dd>
|
||||
@@ -57,7 +57,7 @@
|
||||
Execute <a>cmd</a> and tell it to output in a new tab. Works only for commands that
|
||||
support it, currently:
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
* <ex>:tab addons</ex>
|
||||
* <ex>:tab downloads</ex>
|
||||
@@ -211,16 +211,16 @@ See <t>opening</t> for other ways to open new tabs.
|
||||
Go to the specified buffer from the buffer list. Argument can be either the
|
||||
buffer index or the full URL. If <oa>count</oa> is given, go to the <oa>count</oa>th buffer.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
If argument is neither a full URL nor an index but uniquely identifies a
|
||||
buffer, it is selected. With <oa>!</oa> the next buffer matching the argument is
|
||||
selected, even if it cannot be identified uniquely. Use <k>b</k> as a
|
||||
shortcut to open this prompt.
|
||||
</p>
|
||||
|
||||
|
||||
<p>If argument is <em>#</em>, the alternate buffer will be selected (see <k name="C-^"/>).</p>
|
||||
|
||||
|
||||
<p>If no argument is given the current buffer remains current.</p>
|
||||
</description>
|
||||
</item>
|
||||
@@ -308,7 +308,7 @@ See <t>opening</t> for other ways to open new tabs.
|
||||
Delete current buffer (=tab). If <oa>count</oa> is specified then <oa>count</oa> tabs are
|
||||
removed. Afterwards, the tab to the right of the deleted tab(s) is selected.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
When used with <oa>arg</oa>, remove all tabs which contain <oa>arg</oa> in the
|
||||
hostname. <oa>!</oa> forces this command to also search for <oa>arg</oa> in the full
|
||||
@@ -372,7 +372,7 @@ See <t>opening</t> for other ways to open new tabs.
|
||||
Execute <a>cmd</a> in each tab. <a>cmd</a> is executed in each tab starting with the
|
||||
first and ending with the last which becomes the current tab.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
<a>cmd</a> should not alter the tab list state by adding, removing or reordering
|
||||
tabs.
|
||||
|
||||
@@ -1,369 +0,0 @@
|
||||
<?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: -->
|
||||
@@ -54,7 +54,7 @@
|
||||
<a>cmd</a> is replaced with the previous external command, but not when there is a
|
||||
backslash before the '!', then the backslash is removed.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
Warning: Input redirection (< foo) not done, also do not run commands which
|
||||
require stdin or it will hang &liberator.host;! It is possible to launch background
|
||||
@@ -82,12 +82,12 @@
|
||||
Clear private data items. Where <a>item</a> … is a list of private items to
|
||||
delete. These may be any of the items valid for <o>sanitizeitems</o>.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
If <oa>!</oa> is specified then <o>sanitizeitems</o> is used for the list of items to
|
||||
delete.
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
If <a>timespan</a> is specified then only items within that timespan are deleted,
|
||||
otherwise the value of <o>sanitizetimespan</o> is used.
|
||||
@@ -154,7 +154,7 @@
|
||||
<spec>:helpa<oa>ll</oa> <oa>subject</oa></spec>
|
||||
<description>
|
||||
<p>Open the single unchunked help page.</p>
|
||||
|
||||
|
||||
<p>See <ex>:help</ex>.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
Reference in New Issue
Block a user