diff --git a/locale/en-US/developer.txt b/locale/en-US/developer.txt index 982dd71b..39b88dc4 100644 --- a/locale/en-US/developer.txt +++ b/locale/en-US/developer.txt @@ -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: diff --git a/locale/en-US/tutorial.txt b/locale/en-US/tutorial.txt index 05e58181..30516242 100644 --- a/locale/en-US/tutorial.txt +++ b/locale/en-US/tutorial.txt @@ -64,6 +64,11 @@ and you can find out about the [m]gt[m] and [m]gT[m] mapping with [c]:help gT[c] +Finally, in addition to the help system itself, [c]:exusage[c] and +[c]:viusage[c] are useful quick-reference commands. + + + section:Mouseless[living_mouseless] *-- or how I learned to stop worrying and love the 80+ buttons I already have.* @@ -171,9 +176,6 @@ how to make the best use of them. It's exactly what it sounds like. This command will display a colorized, scrollable and clickable list of the locations in Vimperator's history. -Finally, in addition to the help system itself, [c]:exusage[c] and -[c]:viusage[c] are useful quick-reference commands. - Feel free to explore at this point. If you use the [c]:tabopen[c] command, remember to use the [m]gt[m]/[m]gT[m] mappings to get back to this page. If