gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-24 08:52:27 +01:00
Code Issues Projects Releases Wiki Activity

added tutorial. some cleaning of docs.

Browse Source
This commit is contained in:
Tim Hammerquist
2008-06-08 10:23:04 +00:00
parent 9d38f46dd3
commit 65ad2530d0
4 changed files with 378 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
locale/en-US/autocommands.txt
View File

@@ -2,8 +2,32 @@ HEADER
|autocommands| +
Autocommands are a way to execute code when certain events happen.
Autocommands are a way to automatically execute code when certain events
happen.
TO BE WRITTEN.
|:au| |:autocmd| +
||:au[tocmd]|| Execute commands automatically on events.
________________________________________________________________________________
[c]:au[tocmd][c] {event} {pat} {cmd}.
Add {cmd} to the list of commands Vimperator will execute on {event}:
* [c]:autocmd[!][c] {events} {pat}: list/remove autocommands filtered be {events} and {pat}
* [c]:autocmd[!][c] {events}: list/remove autocommands matching {events}
* [c]:autocmd[!][c] * {pat}: list/remove autocommands matching {pat}
* [c]:autocmd[!][c]: list/remove all autocommands
________________________________________________________________________________
____
Available events:
* BrowserExit
* BrowserRestart
* PageLoad
____
// vim: set syntax=asciidoc:

1
locale/en-US/intro.txt
View File

@@ -45,6 +45,7 @@ it, recommend it and like it :)
section:Help{nbsp}topics[overview]
- help:Tutorial[tutorial.html]: A quick-start tutorial for new users.
- help:Initialization[starting.html]: How Vimperator starts up, where it reads the config file...
- help:Browsing[browsing.html]: Basic mappings and commands needed for
a browsing session (how to open a web page or go back in history).

226
locale/en-US/options.txt
View File

@@ -128,6 +128,21 @@ Define when tabs are automatically activated. Available items:
____
|\'albc'| |\'activelinkbgcolor'|
||'activelinkbgcolor' 'albc'|| string (default: ##88FF00)
____
Background color of the current active link during hint mode.
____
|\'alfc'| |\'activelinkfgcolor'|
||'activelinkfgcolor' 'alfc'|| string (default: black)
____
Foreground color of the current active link during hint mode.
____
|\'cpt'| |\'complete'|
||'complete' 'cpt'|| charlist (default: sfbh)
____
@@ -181,74 +196,15 @@ or @oncommand or @class='lk' or @class='s'] |
The XPath string of hintable elements activated by [m];[m].
____
|\'hs'| |\'hintstyle'|
||'hintstyle' 'hs'|| string
____
(default: z-index:5000; font-family:monospace; font-size:12px; color:white; background-color:red; border-color:ButtonShadow; border-width:0px; border-style:solid; padding:0px 1px 0px 1px; position:absolute;)
CSS specification of hints
____
|\'lfc'| |\'linkfgcolor'|
||'linkfgcolor' 'lfc'|| string (default: black)
____
Foreground color of a link during hint mode.
____
|\'lbc'| |\'linkbgcolor'|
||'linkbgcolor' 'lbc'|| string (default: yellow)
____
Background color of a link during hint mode.
____
|\'alfc'| |\'activelinkfgcolor'|
||'activelinkfgcolor' 'alfc'|| string (default: black)
____
Foreground color of the current active link during hint mode.
____
|\'albc'| |\'activelinkbgcolor'|
||'activelinkbgcolor' 'albc'|| string (default: ##88FF00)
____
Background color of the current active link during hint mode.
____
|\'hm'| |\'hintmatching'|
||'hintmatching' 'hm'|| string (default: contains)
____
Change the hint matching algorithm during hint mode. Possible values:
`--------------------`-------------------------------------------------------------------------------------------------------------------------------
*contains* The typed characters are splitted by spaces, and these character groups have to be anywhere inside the text of the link.
*wordstartswith* The typed characters are matched with the beginning of the first word (see 'wordseparators') in the link as long as possible. If no more or no character matches in the current word, than the matching is continued at the beginning of the next word. The words are worked through in the order they appear in the link. If the typed characters contain spaces, than the characters are splitted by spaces. These character groups are than matched with the beginning of the words, beginning at the first one and continuing with the following words in the order they appear in the link.
*firstletters* Behaves almost as wordstartswith, but non matching words aren't overleaped.
-----------------------------------------------------------------------------------------------------------------------------------------------------
____
|\'wsp'| |\'wordseparators'|
||'wordseparators' 'wsp'|| string (default: [\.,!\?:;/\\"\^\$%&§\(\)\[\]\\{\\}<>#\\*\+\\|=~ _\\-])
____
A regex which defines the word separators which are used for the 'hintmatching' types
'wordstartswith' and 'firstletters' to split the words in the text of a link. +
____
|\'nofs'| |\'nofullscreen'| |\'fs'| |\'fullscreen'|
||'fullscreen' 'fs'|| boolean (default off)
||'fullscreen' 'fs'|| boolean (default: off)
____
Show the current window fullscreen. Also hide certain GUI elements like the
statusline.
____
|\'go'| |\'guioptions'|
||'guioptions' 'go'|| charlist (default: "")
____
@@ -264,13 +220,27 @@ You can also hide the tab bar with [c]:set showtabline=0[c].
____
|\'hto'| |\'hinttimeout'|
||'hinttimeout' 'hto'|| number (default 0)
|\'hm'| |\'hintmatching'|
||'hintmatching' 'hm'|| string (default: contains)
____
Automatically follow non unique numerical hint after 'hinttimeout'
milliseconds. +
Set to 0 (the default) to only follow numeric hints after pressing
[m]<Return>[m] or when the hint is unique.
Change the hint matching algorithm during hint mode. Possible values:
`--------------------`-------------------------------------------------------------------------------------------------------------------------------
*contains* The typed characters are splitted by spaces, and these character groups have to be anywhere inside the text of the link.
*wordstartswith* The typed characters are matched with the beginning of the first word (see 'wordseparators') in the link as long as possible. If no more or no character matches in the current word, than the matching is continued at the beginning of the next word. The words are worked through in the order they appear in the link. If the typed characters contain spaces, than the characters are splitted by spaces. These character groups are than matched with the beginning of the words, beginning at the first one and continuing with the following words in the order they appear in the link.
*firstletters* Behaves almost as wordstartswith, but non matching words aren't overleaped.
-----------------------------------------------------------------------------------------------------------------------------------------------------
____
|\'hs'| |\'hintstyle'|
||'hintstyle' 'hs'|| string
____
(default: z-index:5000; font-family:monospace; font-size:12px; color:white; background-color:red; border-color:ButtonShadow; border-width:0px; border-style:solid; padding:0px 1px 0px 1px; position:absolute;)
CSS specification of hints
____
@@ -287,6 +257,17 @@ ____
XPath string of hintable elements activated by 'f' and 'F'
____
|\'hto'| |\'hinttimeout'|
||'hinttimeout' 'hto'|| number (default: 0)
____
Automatically follow non unique numerical hint after 'hinttimeout'
milliseconds. +
Set to 0 (the default) to only follow numeric hints after pressing
[m]<Return>[m] or when the hint is unique.
____
|\'hi'| |\'history'|
||'history' 'hi'|| number (default: 500)
____
@@ -295,7 +276,7 @@ ____
|\'nohls'| |\'nohlsearch'| |\'hls'| |\'hlsearch'|
||'hlsearch' 'hls'|| boolean (default off)
||'hlsearch' 'hls'|| boolean (default: off)
____
Highlight previous search pattern matches
____
@@ -312,29 +293,31 @@ ____
|\'noic'| |\'noignorecase'| |\'ic'| |\'ignorecase'|
||'ignorecase' 'ic'|| boolean (default on)
||'ignorecase' 'ic'|| boolean (default: on)
____
Ignore case in search patterns.
____
|\'nois'| |\'noincsearch'| |\'is'| |\'incsearch'|
||'incsearch' 'is'|| boolean (default on)
||'incsearch' 'is'|| boolean (default: on)
____
Show where the search pattern matches as it is typed. +
NOTE: Incremental searching currently only works in the forward direction.
____
|\'noim'| |\'noinsertmode'| |\'im'| |\'insertmode'|
||'insertmode' 'im'|| boolean (default on)
||'insertmode' 'im'|| boolean (default: on)
____
Use Insert mode as the default for text areas.
Makes Vimperator work in a way that Insert mode is the default mode for text areas.
Useful if you want to use Vimperator as a modeless editor, keeping the known Firefox interface for editing text areas.
____
|\'ls'| |\'laststatus'|
||'laststatus' 'ls'|| number (default 2)
||'laststatus' 'ls'|| number (default: 2)
____
Determines when the last window will have a status line. Possible values:
@@ -347,19 +330,45 @@ Determines when the last window will have a status line. Possible values:
NOTE: laststatus=1 not implemented yet.
____
|\'lbc'| |\'linkbgcolor'|
||'linkbgcolor' 'lbc'|| string (default: yellow)
____
Background color of a link during hint mode.
____
|\'lfc'| |\'linkfgcolor'|
||'linkfgcolor' 'lfc'|| string (default: black)
____
Foreground color of a link during hint mode.
____
|\'nolks'| |\'nolinksearch'| |\'lks'| |\'linksearch'|
||'linksearch' 'lks'|| boolean (default off)
||'linksearch' 'lks'|| boolean (default: off)
____
Limit the search to hyperlink text.
This includes (X)HTML elements with an "href" atrribute and XLink "simple" links.
____
|\'nomore'| |\'more'|
||'more'|| boolean (default on)
||'more'|| boolean (default: on)
____
Pause the message list window when more than one screen of listings is displayed
____
|\'nextpattern'|
||'nextpattern'|| stringlist (default: \bnext,^>$,^(>>|»)$,^(>|»),(>|»)$,\bmore\b)
____
Patterns to use when guessing the 'next' page in a document sequence.
Each pattern, in order, is matched against all links in the page with the first match being used.
The patterns are case insensitive regular expressions.
____
|\'newtab'|
||'newtab'|| stringlist (default: "")
____
@@ -378,13 +387,6 @@ The possible values:
____
|\'nextpattern'|
||'nextpattern'|| stringlist (default: \bnext,^>$,^(>>|»)$,^(>|»),(>|»)$,\bmore\b)
____
Patterns to use when guessing the 'next' page in a document sequence.
Each pattern, in order, is matched against all links in the page with the first match being used.
The patterns are case insensitive regular expressions.
____
|\'noonline'| |\'online'|
||'online'|| boolean (default on)
@@ -409,8 +411,9 @@ contains behavior
The order matters.
____
|\'pps'| |\'popups'|
||'popups' 'pps'|| number (default 1)
||'popups' 'pps'|| number (default: 1)
____
Define where to show requested popup windows.
Does not apply to windows which are opened by middle clicking a link,
@@ -427,8 +430,9 @@ they always open in a new tab. Possible values:
NOTE: This option does not change the popup blocker of Firefox in any way.
____
|\'preload'|
||'preload'|| boolean (default on)
|\'nopreload'| |\'preload'|
||'preload' 'nopreload'|| boolean (default: on)
____
Speed up first time history/bookmark completion
@@ -437,15 +441,15 @@ Vimperator maintains a cache to speed it up significantly on subsequent access.
In order to also speed up first time access, it is cached at startup, if this option is set (recommended).
____
// 'previewheight'
// 'pvh'
// Default height for preview window
// number (default: 10)
//|\'pvh'| |\'previewheight'|
//||'previewheight' 'pvh'|| number (default: 10)
//____
//Default height for preview window
//
// Value must be between 1 and 50. If the value is too high, completions may cover the command-line. Close the preview window with :pclose.
// NOTE: Option currently disabled
// 'previewheight'
// 'pvh'
//Value must be between 1 and 50. If the value is too high, completions may cover the command-line. Close the preview window with :pclose.
//NOTE: Option currently disabled
//____
|\'previouspattern'|
||'previouspattern'|| stringlist (default: \bprev|previous\b,^<$,^(<<|«)$,^(<|«),(<|«)$)
@@ -455,23 +459,25 @@ Each pattern, in order, is matched against all links in the page with the first
The patterns are case insensitive regular expressions.
____
|\'scr'| |\'scroll'|
||'scroll' 'scr'|| number (default 0)
||'scroll' 'scr'|| number (default: 0)
____
Number of lines to scroll with C-u and C-d commands.
The number of lines scrolled defaults to half the window size.
When a {count} is specified to the <C-u> or <C-d> commands this is used to set the value of 'scroll' and also used for the current command. The value can be reset to half the window height with :set scroll=0.
____
|\'nosmd'| |\'noshowmode'| |\'smd'| |\'showmode'|
||'showmode' 'smd'|| boolean (default on)
||'showmode' 'smd'|| boolean (default: on)
____
Show the current mode in the command line.
____
|\'ssli'| |\'showstatuslinks'|
||'showstatuslinks' 'ssli'|| number (default 1)
||'showstatuslinks' 'ssli'|| number (default: 1)
____
Show the destination of the link under the cursor in the status bar
Also links which are focused by keyboard commands like <Tab> are shown. Possible values:
@@ -486,7 +492,7 @@ ____
|\'stal'| |\'showtabline'|
||'showtabline' 'stal'|| number (default 2)
||'showtabline' 'stal'|| number (default: 2)
____
Control when to show the tab bar of opened web pages. Possible values:
@@ -498,8 +504,9 @@ Control when to show the tab bar of opened web pages. Possible values:
____
|\'noscs'| |\'nosmartcase'| |\'scs'| |\'smartcase'|
||'smartcase' 'scs'|| boolean (default on)
||'smartcase' 'scs'|| boolean (default: on)
____
Override the 'ignorecase' option if the pattern contains uppercase characters.
This is only used if the 'ignorecase' option is set.
@@ -527,15 +534,17 @@ If you don't like that, you can restore it with: [c]:set titlestring=Mozilla
Firefox[c].
____
|\'noum'| |\'nousermode'| |\'um'| |\'usermode'|
||'usermode' 'um'|| boolean (default off)
||'usermode' 'um'|| boolean (default: off)
____
Show current website with a minimal style sheet to make it easily accessible.
Note that this is a local option for now, later it may be split into a global and :setlocal part
____
|\'verbose', \'vbs'|
||'verbose' 'vbs'|| number (default 0)
||'verbose' 'vbs'|| number (default: 0)
____
Define which type of messages are logged.
When bigger than zero, Vimperator will give messages about what it is doing.
@@ -545,13 +554,15 @@ The highest value is 9, being the most verbose mode.
NOTE: non-functional for now.
____
|\'novb'| |\'novisualbell'| |\'vb'| |\'visualbell'|
||'visualbell' 'vb'|| boolean (default off)
||'visualbell' 'vb'|| boolean (default: off)
____
Use visual bell instead of beeping on errors. For now you can't turn off both,
this will hopefully change.
____
|\'visualbellstyle'| |\'t_vb'|
||'visualbellstyle' 't_vb'|| string (default: "border: none; background-color: black;")
____
@@ -559,9 +570,9 @@ The CSS style to use for the visual bell. Set this to the empty string if you
want no bell at all.
____
|\'wim'| |\'wildmode'|
||'wildmode' 'wim'||
stringlist (default: "list:full")
||'wildmode' 'wim'|| stringlist (default: "list:full")
____
Define how command line completion works.
It is a comma-separated list of parts, where each part specifies
@@ -578,14 +589,16 @@ These are the possible values for each part:
'list:full' When more than one match, list all matches and complete first match.
'list:longest' When more than one match, list all matches and complete till the longest common string. \
When there is only a single match, it is fully completed regardless of the case.
-------------------------------------------
-----------------------------------------
____
|\'wop'| |\'wildoptions'|
||'wildoptions' 'wop'|| stringlist (default: "")
____
A list of words that change how command line completion is done.
Currently only one word is allowed:
`------`---------------------------------
sort Always sorts completion list, overriding the 'complete' option.
@@ -593,4 +606,13 @@ sort Always sorts completion list, overriding the 'complete' option.
____
|\'wsp'| |\'wordseparators'|
||'wordseparators' 'wsp'|| string (default: [\.,!\?:;/\\"\^\$%&§\(\)\[\]\\{\\}<>#\\*\+\\|=~ _\\-])
____
A regex which defines the word separators which are used for the 'hintmatching' types
'wordstartswith' and 'firstletters' to split the words in the text of a link.
____
// vim: set syntax=asciidoc:

227
locale/en-US/tutorial.txt Normal file
View File

@@ -0,0 +1,227 @@
LOGO
// Initial revision: Sun Jun 8 10:07:05 UTC 2008 (penryu)
+++<center>+++
*This is a quickstart tutorial to help get new users up and running in
Vimperator.*
+++</center>+++
section:Quick-Start{nbsp}Tutorial[tutorial]
If you've started using Vimperator 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 help:Introduction[intro.html],
you can regain these by issuing the command
[c]:set go+=mTb<cr>[c]
where [m]cr[m] represents pressing the <Enter> or <Return> key.
If you're a veteran Vim user, this may look familiar. It should.
However, in this author's opinion, the best way to get familiar with
Vimperator is to leave these disabled for now. (The above action can be
reversed with [c]:set go=<cr>[c]) You can look at the entry for
[o]guioptions[o] in help:options[options.html] for more information on this.
section:Vimperator's{nbsp}Modal{nbsp}Interface[modal]
Vimperator's power, like Vim's, comes from it's modal interface. Keys have
different meanings depending on which mode the browser is in. Vimperator has
several modes, but the 2 most important are ``normal'' mode and
``command-line'' mode.
When Vimperator starts, it is in normal mode by default. This is probably
where you will spend the majority of your time.
The other core mode of Vimperator, command-line mode, can be entered from
normal mode by typing a ':' (colon). You will frequently see Vimperator
commands start with a ':', indicating that what follows is a command.
To return to normal mode command-line mode, type [m]<Esc>[m]. Pressing
[m]<Esc>[m] will also return you to normal mode from most other modes in
Vimperator.
section:Getting{nbsp}Help[getting_help]
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 Vimperator documentation sooner or
later. Most of the documentation for Vimperator's features are easily found
using the [c]:help[c] command. For example, you can find help on the
[c]:help[c] command by typing
[c]:help :help<cr>[c]
Similarly, help on configurable options is available with [c]:help
'{option_name}'[c]. (Note the single quotes around the option name as in Vim.)
Information on all available options is, predictably, [c]:help options[c].
and you can find out about the [m]gt[m] and [m]gT[m] mapping with
[c]:help gt<cr>[c]
[c]:help gT<cr>[c]
section:Mouseless[living_mouseless]
*-- or how I learned to stop worrying and love the 80+ buttons I already have.*
The efficiency of Vimperator, 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, Vimperator acts on the
assumption that the web browser doesn't have to be one of those.
Here are some areas where the mouse is typically considered indisposable, and
how Vimperator challenges this preconception.
section:Scrolling[keyboard_scrolling]
____
Scrolling the browser window is done with simple keystrokes:
* [m]j[m]/[m]k[m] --
scroll window down/up by one line, respectively
* [m]h[m]/[m]l[m] --
scroll window left/right
* [m]<Space>[m]/[m]<C-b>[m] --
scroll down/up by one page
* [m]<C-d>[m]/[m]<C-u>[m] --
scroll down/up by 1/2 page
Your standard buttons ([m]<Up>[m]/[m]<Down>[m]/[m]<PgUp>[m]/[m]<PgDn>[m]) will
also work as expected.
____
section:History{nbsp}and{nbsp}Tabs[history_navigation,tab_navigation]
____
History navigation (e.g., ``Back'', ``Forward'') are done similarly to
scrolling.
* [m]<C-o>[m]/[m]<C-i>[m] --
move Back/Forward in the current window/tab's history, respectively
Move between tabs using these keystrokes which may also be familiar to tabbing
Vimmers.
* [m]gt[m]/[m]<C-n>[m] --
go to the next tab
* [m]gT[m]/[m]<C-p>[m] --
go to the previous tab
* [m]g0[m]/[m]g$[m] --
go to the first/last tab
To open a webpage in a new tab, use the [c]:tabopen {url}[c]. To open a URL
in the current tab, use [c]:open[c]. The normal mode
mappings [m]t[m] and [m]o[m], respectively, map to these commands, so the
following pairs sequences are equivalent:
:open my.webmail.com<cr>
omy.webmail.com<cr>
:tabopen vimperator.mozdev.org<cr>
tvimperator.mozdev.org<cr>
____
section:Common{nbsp}Issues[common_issues]
____
Say you get half-way down 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:
:open my.partial.url/fooba
You can exit the command-line and access the already loaded page with the
following:
<Esc>gT
____
section:Find{nbsp}the{nbsp}Exit{nbsp}Nearest{nbsp}You[quitting_without_menus]
____
Vimperator supports all of Vim's classing methods of exitting.
* [c]:xall[c] -- command to quit and save the current browsing
session for next time; the default.
* [c]:qall[c] -- command to quit _without_ saving the session
* [m]ZZ[m] -- normal mode mapping equivalent to [c]:xall[c]
* [m]ZQ[m] -- normal mode mapping equivalent to [c]:qall[c]
____
section:Where{nbsp}did{nbsp}Firefox{nbsp}go?[whither_firefox]
____
You might feel pretty disoriented now. Don't worry. This is still Firefox
underneath. Here are some ways Vimperator allows Firefox to shine through.
See the [c]:help[c] for these commands and mappings for more information on
how to make the best use of them.
* [c]:dialog[c] --
To access some of Firefox's many dialog windows, you can use the
[c]:dialog[c] command. See [c]:help :dialog[c].
* [c]:bmarks[c] --
Vimperator provides a new interface to bookmarks, but they're still your
standard Firefox bookmarks under the hood. [c]:bmark[c] will add a new
bookmark, while [c]:bmarks[c] will list the bookmarks currently defined.
* [c]:history[c] --
It's exactly what it sounds like. This command will display a colorized,
scrollable and clickable list of the locations in Vimperator's history.
Finally, in addition to the help system itself, [c]:exusage[c] and
[c]:viusage[c] are useful quick-reference commands.
____
Feel free to explore at this point. If you use the [c]:tabopen[c] command,
remember to use the [m]gt[m]/[m]gT[m] mappings to get back to this page. If
using the [c]:open[c] command, use the history keys (e.g., [m]H[m]) to return.
If you get hopelessly lost, just type [c]:help<cr>[c] and click the
``Tutorial'' link to return.
// TODO: other sections?
section:Get{nbsp}me{nbsp}out{nbsp}of{nbsp}here![removal]
If you've given it a fair shot and determined
The Vimperator way to do this is with the command [c]:addons[c]. Issuing this
command brings up the Firefox Add-ons dialog window; you can then remove it as
normal, selecting Vimperator from the list and clicking (yes, clicking)
*Uninstall*.
Alternatively, you can do this the old-fashioned way: re-enable the menubar,
as above, with [c]:set go+=m[c], and select *Add-ons* from the *Tools* menu.
section:I'm{nbsp}Interested...but{nbsp}Lost![support]
Vimperator has an energetic and growing user base. If you've run into a
problem that you can seem to solve with Vimperator, or if you think you might
have found a bug, please let us know! There is support available on the
http://vimperator.cutup.org/index.php?title=Main_Page[wiki], or in the
#vimperator IRC channel on http://freenode.net/[freenode].
If you have any feature requests or (even better) offers to help, we'd love to
hear from you as well. Developers work on Vimperator 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 help:Developer[developer.html] page for more information.
// vim: set syntax=asciidoc: