From 2d048fba019cac7df74c8e794bc0cfb6559230a1 Mon Sep 17 00:00:00 2001 From: Martin Stubenschrott Date: Wed, 23 Jan 2008 15:28:19 +0000 Subject: [PATCH] added many more ascii doc template files. Now they just need to be filled with useful text. --- locale/en-US/autocommands.txt | 9 ++++ locale/en-US/browsing.txt | 2 + locale/en-US/developer.txt | 2 + locale/en-US/intro.txt | 12 ++++++ locale/en-US/motion.txt | 81 +---------------------------------- locale/en-US/repeat.txt | 16 +++++++ locale/en-US/starting.txt | 2 + locale/en-US/tabs.txt | 10 +++++ locale/en-US/various.txt | 2 + 9 files changed, 57 insertions(+), 79 deletions(-) create mode 100644 locale/en-US/autocommands.txt create mode 100644 locale/en-US/repeat.txt create mode 100644 locale/en-US/tabs.txt diff --git a/locale/en-US/autocommands.txt b/locale/en-US/autocommands.txt new file mode 100644 index 00000000..9e1e7c97 --- /dev/null +++ b/locale/en-US/autocommands.txt @@ -0,0 +1,9 @@ +HEADER + +|autocommands| + + +Autocommands are a way to execute code when certain events happen. + +TO BE WRITTEN. + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/browsing.txt b/locale/en-US/browsing.txt index a7a9ad83..c1db4f1e 100644 --- a/locale/en-US/browsing.txt +++ b/locale/en-US/browsing.txt @@ -118,3 +118,5 @@ Go to the root of the website. + _http://www.example.com/_. When browsing a local directory, it goes to the root directory. ________________________________________________________________________________ + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/developer.txt b/locale/en-US/developer.txt index f697f32e..6c16c715 100644 --- a/locale/en-US/developer.txt +++ b/locale/en-US/developer.txt @@ -68,3 +68,5 @@ If you don't know in which file/section you should put some documentation, ask on the mailing list or on #vimperator. Usually help should be grouped together in logically connected subject areas like help:opening{nbsp}web{nbsp}pages[browsing.html#opening]. + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/intro.txt b/locale/en-US/intro.txt index d021113c..0f724699 100644 --- a/locale/en-US/intro.txt +++ b/locale/en-US/intro.txt @@ -48,12 +48,22 @@ section:Help{nbsp}topics[overview] - 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). +- help:Motion{nbsp}commands[motion.html]: How to efficiently scroll in + Vimperator. +- help:Tabs[tabs.html]: Manage your tabbed browsing session. - help:Marks[marks.html]: Usage of bookmarks, QuickMarks, and history. +- help:Repeating{nbsp}commands[repeat.html]: Usage of macros to repeat + recurring workflows. +- help:Autocommands[autocommands.html]: Automatically execute code on ceratain + events. - help:Options[options.html]: A description of all options. - help:Developer{nbsp}Information[developer.html]: How to write docs or plugins. - help:Various[various.html]: Other help which didn't fit into any other category. +You can also jump directly to the help of a specific command with [c]:help +o[c] or [c]:help :set[c]. + section:Features[features] * Vim-like keybindings ([m]h[m], [m]j[m], [m]k[m], [m]l[m], @@ -85,3 +95,5 @@ properly answer any questions. You can also join the #vimperator IRC channel on irc.freenode.net or check the Wiki for frequently asked questions. Make sure, you have read the TODO file first, as I am aware of many things which can be improved when I find time for it or get patches. + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/motion.txt b/locale/en-US/motion.txt index 9100b06e..9e61aa82 100644 --- a/locale/en-US/motion.txt +++ b/locale/en-US/motion.txt @@ -1,84 +1,7 @@ HEADER -This is the playground for testing asciidoc to make it finally -usable for our help system. - -[[abstract]] |abstract| - -Abstract --------- -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 -annotated element placeholders plus a couple of example index entries -and footnotes. The preface, appendix, bibliography, glossary and index -section titles are significant ('specialsections'). - --------------------------------------- -foo bar#include - -int main() { - printf("Hello World!\n"); - exit(0); -} --------------------------------------- - -|scrollbind-relative| + - -Each 'scrollbind' window keeps track of its "relative offset," which can be -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. - -|| -|||| -|||| -2 ist ein sehr langer text den ich einfach mal weiterschreibe, bis er fertig ist - - -[[section]] |test| |foo| - -The First Section ------------------ -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 -tigers (Bengal and Siberian) using the alternative syntax index -entries. -(((Big cats,Lions))) -(((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[] -example inline image followed by an example block image: - -.Tiger block image -image::images/tiger.png[Tiger image] - -Followed by an example table: - -.An example table -`-----------------`-------------------------- -Option Description ---------------------------------------------- --a 'USER GROUP' Add 'USER' to 'GROUP'. --R 'GROUP' Disables access to 'GROUP'. ---------------------------------------------- - -[[X1]] -Sub-section with Anchor -~~~~~~~~~~~~~~~~~~~~~~~ -Sub-section at level 2. - +|motion| +List mappings how to scroll the window. // vim: set syntax=asciidoc: diff --git a/locale/en-US/repeat.txt b/locale/en-US/repeat.txt new file mode 100644 index 00000000..dc479f78 --- /dev/null +++ b/locale/en-US/repeat.txt @@ -0,0 +1,16 @@ +HEADER + +|repeat| + + +Vimperator can repeat a number of commands or record macros... + +section:Macros[macros] + +TO BE WRITTEN... + + +More commands: + +:time + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/starting.txt b/locale/en-US/starting.txt index a631d646..f6f3425b 100644 --- a/locale/en-US/starting.txt +++ b/locale/en-US/starting.txt @@ -24,3 +24,5 @@ The user's '$HOME'(~) directory is determined as follows: _$HOMEDRIVE$HOMEPATH_. _$VIMPERATOR_HOME_ can be used to override the calculated _$HOME_ directory. + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/tabs.txt b/locale/en-US/tabs.txt new file mode 100644 index 00000000..fed55e3c --- /dev/null +++ b/locale/en-US/tabs.txt @@ -0,0 +1,10 @@ +HEADER + +|tabs| + + +Tabs are used to be able to view many web pages at the same time... + +TO BE WRITTEN... + + +// vim: set syntax=asciidoc: diff --git a/locale/en-US/various.txt b/locale/en-US/various.txt index bcc045f7..82e9c5a6 100644 --- a/locale/en-US/various.txt +++ b/locale/en-US/various.txt @@ -45,3 +45,5 @@ ________________________________________________________________________________ Show help on Normal mode commands. Added to simulate the Nvi command. ________________________________________________________________________________ + +// vim: set syntax=asciidoc: