mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2025-12-20 22:07:58 +01:00
Add all.html for viewing all help in a single page.
This is all really inside out. It would be much better to store the help in a single file and use asciidoc/docbook's capabilities to split it if desired.
This commit is contained in:
Doug Kearns
@@ -50,13 +50,14 @@ check-asciidoc:
|
||||
@$(ASCIIDOC) --version | $(AWK) '{ exit $$2 !~ /^8\.2\./ }' || \
|
||||
echo >&2 "Warning: asciidoc versions other than 8.2.x are unsupported"
|
||||
|
||||
$(ADC_FILES): %.html: %.txt $(BASE)/Makefile.doc $(ADC_DEPS)
|
||||
@echo "DOC locale/$(LOCALE)/$@"
|
||||
$(ASCIIDOC) --unsafe -a linkcss -a quirks! -a lang=$(DOCLANG) -a doctitle="$(shell basename $@)" -o $@ $<
|
||||
|
||||
version.html: ../../NEWS $(BASE)/Makefile.doc $(ADC_DEPS)
|
||||
@echo "DOC locale/$(LOCALE)/$@"
|
||||
# NOTE: asciidoc doesn't source the conf file implicitly when processing stdin
|
||||
sed -e '1i\
|
||||
HEADER' -e '/^[0-9]/d' -e '/^ \+\* version /s/.*version \+\([0-9.]\+\).*/section:Version{nbsp}\1[version-\1]\
|
||||
heading:Version{nbsp}information[version-information]' -e '/^[0-9]/d' -e '/^ \+\* version /s/.*version \+\([0-9.]\+\).*/section:Version{nbsp}\1[version-\1]\
|
||||
/' ../../NEWS | ${ASCIIDOC} -f asciidoc.conf -a doctitle=version.html -o version.html -
|
||||
|
||||
$(ADC_FILES): %.html: %.txt $(BASE)/Makefile.doc $(ADC_DEPS)
|
||||
@echo "DOC locale/$(LOCALE)/$@"
|
||||
$(ASCIIDOC) --unsafe -a linkcss -a quirks! -a lang=$(DOCLANG) -a doctitle="$(shell basename $@)" -o $@ $<
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
* add @: mapping - repeat the last Ex command
|
||||
* add \ mapping - toggle between rendered and source view
|
||||
* add ;c extended hint mode - open the context menu
|
||||
* :help all now shows all help sections in a single page
|
||||
|
||||
2009-05-21:
|
||||
* version 2.1
|
||||
|
||||
@@ -119,7 +119,7 @@ const config = { //{{{
|
||||
"pattern.html", "tabs.html", "hints.html", "map.html", "eval.html",
|
||||
"marks.html", "repeat.html", "autocommands.html", "print.html",
|
||||
"gui.html", "styling.html", "message.html", "developer.html",
|
||||
"various.html", "index.html", "version.html"
|
||||
"various.html", "version.html", "index.html", "all.html"
|
||||
],
|
||||
|
||||
get ignoreKeys() {
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|autocommands| +
|
||||
heading:Automatic{nbsp}commands[autocommands]
|
||||
|
||||
Autocommands are a way to automatically execute code when certain events
|
||||
happen.
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|surfing| |browsing| +
|
||||
heading:Browsing[surfing,browsing]
|
||||
|
||||
Vimperator overrides nearly all Firefox keys in order to make browsing more
|
||||
pleasant for Vim users. On the rare occasions when you want to pass a keystroke
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|buffer| |document| +
|
||||
heading:Buffer[buffer,document]
|
||||
|
||||
Vimperator holds exactly one buffer object for each tab. It is usually an
|
||||
(X)HTML document with advanced features.
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|Command-line-mode| |Command-line| |mode-cmdline| +
|
||||
heading:Command-line{nbsp}mode[Command-line-mode,Command-line,mode-cmdline]
|
||||
|
||||
Command-line mode is used to enter Ex commands ("[m]:[m]") and text search patterns
|
||||
("[m]/[m]" and "[m]?[m]").
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
HEADER
|
||||
heading:Developer{nbsp}information[developer-information]
|
||||
|
||||
section:Writing{nbsp}documentation[writing-docs,documentation]
|
||||
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|expression| |expr| |eval| +
|
||||
heading:Expression{nbsp}evaluation[expression,expr,eval]
|
||||
|
||||
INTRO TO BE WRITTEN...
|
||||
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|gui| +
|
||||
heading:Vimperator's{nbsp}GUI[gui]
|
||||
|
||||
Although Vimperator offers the most frequently used Firefox functionality via
|
||||
Ex and Normal mode commands there may be times when directly accessing the GUI
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|quick-hints| |hints| +
|
||||
heading:Hints[quick-hints,hints]
|
||||
|
||||
Hints are the way in which Vimperator allows you to follow links on a page. By
|
||||
providing each link with a suitable hint, you can access all links with a
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
HEADER
|
||||
heading:Index[index]
|
||||
|
||||
|index| +
|
||||
|
||||
This file contains a list of all available commands.
|
||||
This file contains a list of all available commands, mappings and options.
|
||||
|
||||
section:Insert{nbsp}mode[insert-index]
|
||||
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|Insert-mode| |Insert| |mode-insert| +
|
||||
heading:Insert{nbsp}mode[Insert-mode,Insert,mode-insert]
|
||||
|
||||
Insert mode is used to enter text in text boxes and text areas. When
|
||||
'insertmode' is set, focusing on a text area immediately switches to
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
Key mappings, abbreviations, and user-defined commands.
|
||||
heading:Key{nbsp}mappings,{nbsp}abbreviations,{nbsp}and{nbsp}user-defined{nbsp}commands.[]
|
||||
|
||||
section:Key{nbsp}mapping[key-mapping,mapping,macro]
|
||||
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|different-marks| |marks| +
|
||||
heading:Marks[different-marks,marks]
|
||||
|
||||
Vimperator supports a number of different marks:
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
HEADER
|
||||
heading:Error{nbsp}and{nbsp}informational{nbsp}messages[messages]
|
||||
|
||||
|message-history| +
|
||||
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|options| +
|
||||
heading:Options[options]
|
||||
|
||||
Vimperator has a number of internal variables and switches which can be set to
|
||||
achieve special effects. These options come in 5 forms:
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|text-search-commands| +
|
||||
heading:Text{nbsp}search{nbsp}commands[text-search-commands]
|
||||
|
||||
Vimperator provides a Vim-like interface to Firefox's standard text search
|
||||
functionality. There is no support for using regular expressions in search
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|printing| +
|
||||
heading:Printing[printing]
|
||||
|
||||
|:ha| |:hardcopy| +
|
||||
||:ha[rdcopy][!]||
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
HEADER
|
||||
|
||||
|repeat| +
|
||||
heading:Repeating{nbsp}commands[repeating]
|
||||
|
||||
Vimperator can repeat a number of commands and record macros.
|
||||
|
||||
section:Single{nbsp}repates[single-repeat]
|
||||
section:Single{nbsp}repeats[single-repeat]
|
||||
|
||||
|.|
|
||||
||[count].||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
HEADER
|
||||
heading:Starting{nbsp}Vimperator[starting]
|
||||
|
||||
Vimperator does not yet read any command-line options. When it does, they will
|
||||
be documented here.
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|styling| +
|
||||
heading:Styling{nbsp}the{nbsp}GUI{nbsp}and{nbsp}web{nbsp}pages[styling]
|
||||
|
||||
Vimperator allows you to style both the browser and any web pages you view. All
|
||||
styling is specified via CSS. Although you may style any user interface element
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
HEADER
|
||||
|
||||
|tabs| +
|
||||
heading:Tabs[tabs]
|
||||
|
||||
Tabs are used to be able to view many web pages at the same time. Each tab
|
||||
contains exactly one buffer -- multiple buffers per tab are not supported. As a
|
||||
|
||||
@@ -1,14 +1,12 @@
|
||||
HEADER
|
||||
|
||||
// Initial revision: Sun Jun 8 10:07:05 UTC 2008 (penryu)
|
||||
|
||||
heading:Quick-start{nbsp}tutorial[tutorial]
|
||||
|
||||
+++<div style="text-align: center;">+++
|
||||
*This is a quickstart tutorial to help get new users up and running in
|
||||
Vimperator. It is not intended as a full reference explaining all features.*
|
||||
+++</div>+++
|
||||
|
||||
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.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
HEADER
|
||||
heading:Other{nbsp}help[]
|
||||
|
||||
section:Various{nbsp}commands[various]
|
||||
|
||||
@@ -64,6 +64,8 @@ ________________________________________________________________________________
|
||||
Open help window. The default page, as specified by 'helpfile' is shown unless
|
||||
[a][subject][a] is specified. If you need help for a specific topic, try
|
||||
[c]:help overview[c].
|
||||
|
||||
All help pages can be viewed in a single page via [c]:help all[c].
|
||||
________________________________________________________________________________
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user