options.txt is near final now, so START writing docs now :)

Donators

@@ -2,6 +2,7 @@
 <b>Note:</b> If you don't wish to appear on this list when making a donation, please tell me.
 
 2008:
+* Ivo-Jose Jimenez-Ramos
 * Andrew Pantyukhin
 * Kurtis Rader
 

TODO

@@ -19,6 +19,7 @@ FEATURES:
 8 y and Y should be changed to: yy and yl=yank location, ys=yank selection,
   yd=yank domain name, yt=yank title, yw=yank current word,
   yS=yank selection, if no selection then yank current word (other things to yank?)
+8 all search commands should start searching from the top of the visible viewport 
 7 use ctrl-n/p in insert mode for word completion
 7 implement LocationList window, and get rid off/change PreviewWindow to be a real preview window being able to display html pages
 7 [ctrl-o/i] to Go back to a Previous Position (done partly, however currenty does not use a per tab jumplist)

locale/en-US/asciidoc.conf

@@ -44,23 +44,29 @@ HEADER=<span style="float: right; padding-top: 10px;"><form action="https://www.
 |=tag
 ||=key
 [o]=option
+'=option2
 [c]=command
 [m]=mapping
 [a]=argument
+{|}=argument2
+[[|]]=argument3
 # disable monospaced text as all our text is monospaced and it causes problems for some things
 +=
-'=
+^=
 
 [tags]
 tag=<span class="tag">|</span>
 key=<div class="key">|</div>
-option=<span class="option">'|'</span>
+option=<span class="option">|</span>
+option2=<span class="option">'|'</span>
 command=<span class="command">|</span>
 mapping=<span class="mapping">|</span>
 argument=<span class="argument">|</span>
+argument2=<span class="argument">&#123;|&#125;</span>
+argument3=<span class="argument">[|]</span>
 
 [specialwords]
-warningwords=Warning:
+warningwords=Warning: NOTE: Note:
 
 [warningwords]
 <span class="warning">{words}</span>

locale/en-US/intro.txt

@@ -50,23 +50,27 @@ section:Help{nbsp}topics[overview]
 
 section:Features[features]
 
-* Vim-like keybindings (h,j,k,l,gg,G,0,$,ZZ,<C-f>,etc.)
+* Vim-like keybindings ([m]h[m], [m]j[m], [m]k[m], [m]l[m],
-* Ex-commands (:quit, :open www.foo.com, ...)
+  [m]gg[m], [m]G[m], [m]0[m], [m]$[m], [m]ZZ[m], [m]<C-f>[m], etc.)
-* Tab completion available for all commands with support for 'longest' matching when set in [o]wildmode[o]
+* Ex-commands ([c]:quit[c], [c]:open www.foo.com[c], ...)
+* Tab completion available for all commands with support for 'longest' matching when set in 'wildmode'
 * Hit-a-hint like navigation of links (start with [m]f[m] to follow a link)
 * Advanced completion of bookmark and history URLs (searching also in title, not only URL)
 * Vim-like statusline with a wget-like progress bar
-* Minimal GUI (easily hide useless menubar and toolbar with :set guioptions=)
+* Minimal GUI (easily hide useless menubar and toolbar with [c]:set guioptions=[c])
-* Ability to :source javascript files, and to use a ~/.vimperatorrc file with syntax highlighting if you install scripts/vimperator.vim
+* Ability to [c]:source[c] javascript files, and to use a [a]~/.vimperatorrc[a] file
-* Easy quick searches (:open foo will search foo in google, :open ebay terminator will search for terminator on ebay) with support for Firefox keyword bookmarks and search engines
+  with syntax highlighting if you install scripts/vimperator.vim
-* Count supported for many commands (3<C-o> will go back 3 pages)
+* Easy quick searches ([c]:open foo[c] will search foo in google,
+  [c]:open ebay terminator[c] will search for terminator on ebay)
+  with support for Firefox keyword bookmarks and search engines
+* Count supported for many commands ([m]3<C-o>[m] will go back 3 pages)
 * Beep on errors
-* Marks support (ma to set mark 'a' on a webpage, 'a to go there)
+* Marks support ([m]ma[m] to set mark a on a webpage, [m]'a[m] to go there)
-* QuickMarks support (quickly go to previously marked web pages with go\{a-zA-Z0-9\})
+* QuickMarks support (quickly go to previously marked web pages with [m]go[m][a]\\{a-zA-Z0-9\\}[a])
-* :map support (and feedkeys() for script writers)
+* [c]:map[c] support (and feedkeys() for script writers)
-* :time support for profiling
+* [c]:time[c] support for profiling
-* Move the text cursor and select text with vim keys and a visual mode. (for now only for the browser, no text fields)
+* Move the text cursor and select text with vim keys and a visual mode
-* A comprehensive help file, explaining all commands, mappings and settings.
+* A comprehensive help file, explaining all commands, mappings and options.
 
 section:Contact[contact]
 

locale/en-US/options.txt

@@ -1,84 +1,457 @@
 HEADER
 
-This is the playground for testing asciidoc to make it finally
+|options| +
-usable for our help system.
 
-[[abstract]] |abstract|
+Vimperator has a number of internal variables and switches which can be set to
+achieve special effects.  These options come in 5 forms:
+`----------`-------------------------------------------
+boolean    can only be on or off
+number     has a numeric value
+string     has a string value
+charlist   like a string but with unique characters
+stringlist a comma-seperated list of strings
+-------------------------------------------------------
 
-Abstract
+section:Setting{nbsp}options[set-option,E764]
---------
-The optional abstract (one or more paragraphs) goes here.
-You can also jump to xref:section[section].
 
-This document is an AsciiDoc article skeleton containing briefly
+|:set| |:se|
-annotated element placeholders plus a couple of example index entries
+||:se[t]|| Show all options that differ from their default value.
-and footnotes. The preface, appendix, bibliography, glossary and index
-section titles are significant ('specialsections').
 
---------------------------------------
+||:se[t] all|| Show all options.
-foo bar#include <stdio.h>
 
-int main() {
+||:se[t] {option}?|| Show value of {option}.
-        printf("Hello World!\n");
-        exit(0);
-}
---------------------------------------
 
-|scrollbind-relative| + 
+||:se[t] {option}|| 	Toggle option: set, switch it on.
+____
+Number option: show value. +
+String option: show value.
+____
 
-Each 'scrollbind' window keeps track of its "relative offset," which can be
+||:se[t] no{option}|| Toggle option: Reset, switch it off.
-thought of as the difference between the current window's vertical scroll
-position and the other window's vertical scroll position.  When one of the
-'scrollbind' windows is asked to vertically scroll past the beginning or end
-limit of its text, the window no longer scrolls, but remembers how far past
-the limit it wishes to be.  The window keeps this information so that it can
-maintain the same relative offset, regardless of its being asked to scroll
-past its buffer's limits.
 
-|<Ctrl-f>|
+// :se[t] {option}!   or
-||<Ctrl-f>||
+||:se[t] inv{option}|| Toggle option: Invert value.
-||<PageDown>||
+
-2 ist ein sehr langer text den ich einfach mal weiterschreibe, bis er fertig ist
+|:set-default|
+||:se[t] {option}&|| Reset option to its default value.
+
+||:se[t] all&|| Set all options to their default value.
+
+|:set-args| |E487| |E521|
+||:se[t] {option}={value}|| +
+____
+Set string or number option to {value}. +
+For numeric options the value must be given in decimal.
+The old value can be inserted by typing <Tab>.
+____
+
+|:set+=|
+||:se[t] {option}+={value}|| +
+____
+Add the {value} to a number option, or append the
+{value} to a string option.  When the option is a
+comma separated list, a comma is added, unless the
+value was empty.
+If the option is a list of flags, superfluous flags
+are removed.  When adding a flag that was already
+present the option value doesn't change.
+____
+
+|:set^=|
+||:se[t] {option}^={value}|| +
+____
+Multiply the {value} to a number option, or prepend
+the {value} to a string option.  When the option is a
+comma separated list, a comma is added, unless the
+value was empty.
+____
+
+|:set-=|
+||:se[t] {option}-={value}|| +
+
+____
+Subtract the {value} from a number option, or remove
+the {value} from a string option, if it is there.
+If the {value} is not found in a string option, there
+is no error or warning.  When the option is a comma
+separated list, a comma is deleted, unless the option
+becomes empty.
+When the option is a list of flags, {value} must be
+exactly as they appear in the option.  Remove flags
+one by one to avoid problems.
+____
 
 
-[[section]] |test| |foo|
 
-The First Section
+section:List{nbsp}of{nbsp}options[list-options]
------------------
-Article sections start at level 1 and can be nested up to four levels
-deep.
-footnote:[An example footnote.]
-indexterm:[Example index entry]
 
-And now for something completely different: ((monkeys)), lions and
+|\'act'| |\'activate'|
-tigers (Bengal and Siberian) using the alternative syntax index
+||'activate' 'act'|| stringlist (default: homepage,quickmark,tabopen,paste)
-entries.
+____
-(((Big cats,Lions)))
+Define when tabs are automatically activated. Available items:
-(((Big cats,Tigers,Bengal Tiger)))
-(((Big cats,Tigers,Siberian Tiger)))
-Note that multi-entry terms generate separate index entries.
 
-Here are a couple of image examples: an image:images/smallnew.png[]
+* *homepage*: [m]gH[m] mapping
-example inline image followed by an example block image:
+* *quickmark*: [m]go[m] and [m]gn[m] mappings
+* *tabopen*: [c]:tabopen[!][c] command
+* *paste*: [m]P[m] and [m]gP[m] mappings
+____
 
-.Tiger block image
+|\'cpt'| |\'complete'|
-image::images/tiger.png[Tiger image]
+||'complete' 'cpt'|| charlist (default: sfbh)
+____
+Items which are completed at the [c]:[tab]open[c] prompt. Available items:
 
-Followed by an example table:
+    * *s*: Search engines and keyword URLs
+    * *f*: Local files
+    * *b*: Bookmarks
+    * *h*: History
 
-.An example table
+The order is important, so [c]:set complete=bs[c] would list bookmarks first,
-`-----------------`--------------------------
+and then any available quick searches.  Add "sort" to the 'wildoptions' option
-Option            Description
+if you want all entries sorted.
----------------------------------------------
+____
--a 'USER GROUP'   Add 'USER' to 'GROUP'.
--R 'GROUP'        Disables access to 'GROUP'.
----------------------------------------------
-
-[[X1]]
-Sub-section with Anchor
-~~~~~~~~~~~~~~~~~~~~~~~
-Sub-section at level 2.
 
 
+|\'ds'| |\'defsearch'|
+||'defsearch' 'ds'|| string (default: "google")
+____
+Sets the default search engine.
+The default search engine is used in the [c]:[tab]open [arg][c] command if
+[[arg]] neither looks like a URL or like a specified search engine/keyword.
+____
+
+
+|\'editor'|
+||'editor'|| string (default: "gvim -f")
+____
+Set the external text editor
+Sets the editor to run when [m]<C-i>[m] is pressed in INSERT and TEXTAREA
+modes. +
+Warning: Vimperator will not behave correctly if the editor forks its own process,
+such as with gvim without the -f argument.
+____
+
+
+|\'eht'| |\'extendedhinttags'|
+||'extendedhinttags' 'eht'|| string
+____
+(default: +++//*[@onclick or @onmouseover
+or @onmousedown or @onmouseup or @oncommand or @class='lk' or @class='s'] |
+//input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button
+| //select | //xhtml:*[@onclick or @onmouseover or @onmousedown or @onmouseup
+or @oncommand or @class='lk' or @class='s'] |
+//xhtml:input[not(@type='hidden')] | //xhtml:a | //xhtml:area | //xhtml:iframe
+| //xhtml:textarea | //xhtml:button | //xhtml:select+++)
+
+The XPath string of hintable elements activated by [m];[m].
+____
+
+|\'fhs'| |\'focusedhintstyle'|
+||'focusedhintstyle' 'fhs'|| string
+____
+(default: z-index:5000; font-family:monospace; font-size:12px; color:ButtonText; background-color:ButtonShadow; border-color:ButtonShadow; border-width:1px; border-style:solid; padding:0px 1px 0px 1px; position:absolute;)
+
+CSS specification of focused hints
+____
+
+|\'nofs'| |\'nofullscreen'| |\'fs'| |\'fullscreen'|
+||'fullscreen' 'fs'|| boolean (default off)
+____
+Show the current window fullscreen. Also hide certain GUI elements like the
+statusline.
+____
+
+
+
+|\'go'| |\'guioptions'|
+||'guioptions' 'go'|| charlist (default: "")
+____
+Show or hide the menu, toolbar and scrollbars. Supported characters:
+
+* *m*: menubar
+* *T*: toolbar
+* *b*: bookmark bar
+
+You can also hide the tab bar with [c]:set showtabline=0[c].
+____
+
+
+|\'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.
+____
+
+
+|\'ht'| |\'hinttags'|
+||'hinttags' 'ht'|| string
+____
+(default: +++//*[@onclick or @onmouseover or @onmousedown or @onmouseup or
+@oncommand or @class='lk' or @class='s'] | //input[not(@type='hidden')] | //a
+| //area | //iframe | //textarea | //button | //select | //xhtml:*[@onclick or
+@onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or
+@class='s'] | //xhtml:input[not(@type='hidden')] | //xhtml:a | //xhtml:area |
+//xhtml:iframe | //xhtml:textarea | //xhtml:button | //xhtml:select+++)
+
+XPath string of hintable elements activated by 'f' and 'F'
+____
+
+|\'hi'| |\'history'|
+||'history' 'hi'|| number (default: 500)
+____
+Number of Ex commands and search patterns to store in the commandline history.
+____
+
+
+|\'nohls'| |\'nohlsearch'| |\'hls'| |\'hlsearch'|
+||'hlsearch' 'hls'|| boolean (default: off)
+____
+Highlight previous search pattern matches
+____
+
+
+|\'hlss'| |\'hlsearchstyle'|
+||'hlsearchstyle' 'hlss'|| string (default: color: black; background-color: yellow; padding: 0; display: inline;)
+____
+CSS specification of highlighted search items
+____
+
+
+|\'noic'| |\'noignorecase'| |\'ic'| |\'ignorecase'|
+||'ignorecase' 'ic'|| boolean (default on)
+____
+Ignore case in search patterns.
+____
+
+
+|\'nois'| |\'noincsearch'| |\'is'| |\'incsearch'|
+||'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)
+____
+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)
+____
+Determines when the last window will have a status line. Possible values:
+
+* 0: never
+* 1: only if there are multiple windows
+* 2: always
+
+NOTE: laststatus=1 not implemented yet.
+____
+
+|\'nolks'| |\'nolinksearch'| |\'lks'| |\'linksearch'|
+||'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)
+____
+Pause the message list window when more than one screen of listings is displayed
+____
+
+|\'nextpattern'|
+||'nextpattern'|| stringlist (default: \bnext,^>$,^(>>|»)$,^(>|»),(>|»)$)
+____
+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.
+____
+
+|\'pageinfo' \'pa'|
+||'pageinfo' 'pa'||
+charlist (default: gfm)
+____
+Desired info on [c]:pa[geinfo][c].  Available items:
+
+.--------`----------------
+contains behavior
+--------------------------
+*g*      general info
+*f*      feeds
+*m*      meta tags
+--------------------------
+
+The order matters.
+____
+
+|\'pps'| |\'popups'|
+||'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,
+they always open in a new tab. Possible values:
+
+.---`------------------------------------------------------------------------------------------------
+*0*  Force to open in the current tab (Warning: this can stop some web sites from working correctly!)
+*1*  Always open in a new tab
+*2*  Open in a new window if it has a specific requested size (default in Firefox)
+*3*  Always open in a new window
+-----------------------------------------------------------------------------------------------------
+
+NOTE: This option does not change the popup blocker of Firefox in any way.
+____
+
+|\'preload'|
+||'preload'|| boolean (default on)
+____
+Speed up first time history/bookmark completion
+
+History access can be quite slow for a large history.
+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)
+// 
+// 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'
+
+|\'previouspattern'|
+||'previouspattern'|| stringlist (default: \bprev|previous\b,^<$,^(<<|«)$,^(<|«),(<|«)$)
+____
+Patterns to use when guessing the 'previous' 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.
+____
+
+|\'scr'| |\'scroll'|
+||'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)
+____
+Show the current mode in the command line.
+____
+
+
+|\'ssli'| |\'showstatuslinks'|
+||'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:
+
+.---`--------------------------------------
+*0* Don't show link destination
+*1* Show the link in the status line
+*2* Show the link in the command line
+-------------------------------------------
+
+____
+
+
+|\'stal'| |\'showtabline'|
+||'showtabline' 'stal'|| number (default 2)
+____
+Control when to show the tab bar of opened web pages. Possible values:
+
+.---`--------------------------------------
+*0* Never show tab bar
+*1* Show tab bar only if more than one tab is open
+*2* Always show tab bar
+-------------------------------------------
+
+____
+
+|\'noscs'| |\'nosmartcase'| |\'scs'| |\'smartcase'|
+||'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.
+____
+
+|\'titlestring'|
+||'titlestring'|| string (default: "Vimperator")
+____
+Change the title of the browser window.
+Vimperator changes the browser title from "Title of web page - Mozilla Firefox" to
+"Title of web page - Vimperator". +
+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)
+____
+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)
+____
+Define which type of messages are logged.
+When bigger than zero, Vimperator will give messages about what it is doing.
+They are printed to the error console which can be shown with [c]:javascript![c].
+The highest value is 9, being the most verbose mode.
+
+NOTE: non-functional for now.
+____
+
+|\'novb'| |\'novisualbell'| |\'vb'| |\'visualbell'|
+||'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.
+____
+
+|\'wim'| |\'wildmode'|
+||'wildmode' 'wim'||
+stringlist (default: "list:full")
+____
+Define how command line completion works.
+It is a comma-separated list of parts, where each part specifies
+what to do for each consecutive use of the completion key.
+The first part specifies the behavior for the first use of the completion key,
+the second part for the second use, etc.
+
+These are the possible values for each part:
+`---------------`------------------------
+''              Complete only the first match
+'full'          Complete the next full match. After the last, the original string is used.
+'longest'       Complete till the longest common string.
+'list'          When more than one match, list all matches.
+'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.
+-----------------------------------------
 
 // vim: set syntax=asciidoc:

locale/en-US/xhtml11.css

@@ -47,13 +47,13 @@ div.example p.title
 body h1 {
   margin: .0em 0 0 -4%;
   line-height: 1.3;
-  border-bottom: 2px solid silver;
+  border-bottom: 1px solid silver;
 }
 
 body h2 {
   margin-top: 30px;
   line-height: 1.3;
-  border-bottom: 2px solid silver;
+  border-bottom: 1px solid silver;
 }
 
 body h3 {
@@ -291,7 +291,9 @@ span.section {
 
 div.key {
     color: rgb(255, 0, 255); /* magenta */
-    min-width: 140px;
+    min-width: 120px; /* with 20px padding actually 140px */
+	padding-bottom: 1em;
+	padding-right: 20px;
     float: left;
 }
 span.warning {
@@ -305,18 +307,19 @@ fieldset.paypal {
 .argument {
     color: #6A97D4;
 }
-
 .command {
     font-weight: bold;
     color: #632610;
 }
-
 .mapping {
     font-weight: bold;
     color: #102663;
 }
-
 .option {
     font-weight: bold;
     color: #106326;
 }
+.quoteblock {
+	margin-left: 140px;
+	margin-bottom: 30px;
+}