mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-01-06 14:04:12 +01:00
Add a :helpall command.
This effectively divides the help into chunked and unchunked subsystems for clarity.
This commit is contained in:
@@ -77,7 +77,7 @@ LOGO=<div style="text-align: center;"><span class="vimperator-logo"></span></div
|
||||
</table>
|
||||
|
||||
[help-inlinemacro]
|
||||
<a href="chrome://liberator/locale/{1}">{target}</a>
|
||||
<a href="chrome://liberator/locale/{outfile@.*all.html:all.html:{1}}#{2={1}}">{target}</a>
|
||||
|
||||
[quotes]
|
||||
|=tag
|
||||
|
||||
@@ -10,7 +10,7 @@ _make doc_. Please refer to the
|
||||
http://www.methods.co.nz/asciidoc/userguide.html[asciidoc documentation] above
|
||||
for details. Usually you can just write text as is, and mostly it will be
|
||||
interpreted correctly. The only difficult part is to write special sections
|
||||
like for help::help[various.html#online-help].
|
||||
like for help::help[various.html,online-help].
|
||||
|
||||
----------------------------------------------------------------------------------
|
||||
|<F1>| |:help| |:h| |help|
|
||||
@@ -64,7 +64,7 @@ Vimperator documentation:
|
||||
|
||||
- *$$section:Writing{nbsp}documentation[writing-docs,documentation]$$* Creates
|
||||
a new section like _Writing Documentation_ in this help file with 2 tags.
|
||||
- *$$help:developer{nbsp}information[developer.html#documentation]$$* creates
|
||||
- *$$help:developer{nbsp}information[developer.html,documentation]$$* creates
|
||||
a link with text _developer information_ to the tag _documentation_ in
|
||||
the file _developer.html_.
|
||||
|
||||
@@ -72,7 +72,7 @@ Vimperator documentation:
|
||||
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].
|
||||
help:opening{nbsp}web{nbsp}pages[browsing.html,opening].
|
||||
|
||||
section:Generating{nbsp}documentation[generating-docs]
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
heading:Expression{nbsp}evaluation[expression,expr,eval]
|
||||
|
||||
INTRO TO BE WRITTEN...
|
||||
//INTRO TO BE WRITTEN...
|
||||
|
||||
|:ec| |:echo| +
|
||||
||:ec[ho] {expr}||
|
||||
|
||||
@@ -193,7 +193,8 @@ section:Ex{nbsp}commands[ex-cmd-index,:index]
|
||||
||[c]:forward[c]|| Go forward in the browser history +
|
||||
||[c]:frameonly[c]|| Show only the current frame's page +
|
||||
||[c]:hardcopy[c]|| Print current document +
|
||||
||[c]:help[c]|| Display help +
|
||||
||[c]:help[c]|| Open the help page +
|
||||
||[c]:helpall[c]|| Open the single unchunked help page +
|
||||
||[c]:highlight[c]|| Style Vimperator +
|
||||
||[c]:history[c]|| Show recently visited URLs +
|
||||
||[c]:iabbrev[c]|| Abbreviate a key sequence in Insert mode +
|
||||
|
||||
@@ -451,7 +451,7 @@ ____
|
||||
|\'noprivate'| |\'private'|
|
||||
||'private'|| boolean (default: off)
|
||||
____
|
||||
Set the 'private browsing' option. In private browsing mode history, cache
|
||||
Set the "private browsing" option. In private browsing mode history, cache
|
||||
files, cookies, form data, passwords, and download list entries are available
|
||||
only for the duration of the private browsing session and deleted when
|
||||
returning to normal browsing mode.
|
||||
|
||||
@@ -27,9 +27,8 @@ ________________________________________________________________________________
|
||||
________________________________________________________________________________
|
||||
The file {rcfile} is used for user initialization commands. If {rcfile} is
|
||||
"NORC" then no startup initialization is performed except for the loading of
|
||||
plugins, i.e. steps 1. and 2. in
|
||||
help:initialization[starting.html#Initialization] are skipped. If {rcfile} is
|
||||
"NONE" then plugin loading is also skipped.
|
||||
plugins, i.e. steps 1. and 2. in [j]initialization[j] are skipped. If {rcfile}
|
||||
is "NONE" then plugin loading is also skipped.
|
||||
________________________________________________________________________________
|
||||
|
||||
|
||||
|
||||
@@ -61,11 +61,18 @@ section:Online{nbsp}help[online-help]
|
||||
||:h[elp] [a][subject][a]|| +
|
||||
||<F1>||
|
||||
________________________________________________________________________________
|
||||
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
|
||||
Open the help page. 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].
|
||||
|
||||
|:helpall| |:helpa| |help-all|
|
||||
||:helpa[ll] [a][subject][a]|| +
|
||||
________________________________________________________________________________
|
||||
Open the single unchunked help page.
|
||||
|
||||
See [c]:help[c].
|
||||
________________________________________________________________________________
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user