mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-02-22 06:35:44 +01:00
small help updates
This commit is contained in:
@@ -67,9 +67,22 @@ Vimperator documentation:
|
||||
a link with text _developer information_ to the tag _documentation_ in
|
||||
the file _developer.html_.
|
||||
|
||||
|
||||
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].
|
||||
|
||||
|
||||
section:Generating{nbsp}Documentation[generating-docs]
|
||||
|
||||
You can also autogenerate most of the asciidoc help after you have written a
|
||||
new command, mapping or option. For this, use:
|
||||
|
||||
:echo util.generateHelp(commands.get("addons"), "Extra text")
|
||||
|
||||
Now you can copy the asciidoc text but always make sure it looks OK after
|
||||
you compile the help file with "make doc", as the auto-generation might
|
||||
not work correctly for all special cases.
|
||||
|
||||
// vim: set syntax=asciidoc:
|
||||
|
||||
Reference in New Issue
Block a user