mirror of
https://github.com/gryf/pentadactyl-pm.git
synced 2026-04-21 01:21:25 +02:00
Fix some help markup issues.
This commit is contained in:
@@ -57,18 +57,24 @@
|
||||
</item>
|
||||
</html:div>
|
||||
|
||||
<p>
|
||||
If you don't know in which file/section you should put some
|
||||
documentation, ask on the mailing list or on #vimperator.
|
||||
documentation, ask on the mailing list or on
|
||||
<link topic="irc://irc.freenode.net/vimperator">#vimperator</link>.
|
||||
</p>
|
||||
|
||||
<h2 tag="generating-docs">Generating documentation</h2>
|
||||
|
||||
<p>
|
||||
You can also autogenerate most of the XML help after you have
|
||||
written a new command, mapping or option. For this, use:
|
||||
written a new command, mapping or option.
|
||||
</p>
|
||||
|
||||
:echo util.generateHelp(commands.get("addons"), "Extra text")
|
||||
<example><ex>:echo util.generateHelp(commands.get(<str>addons</str>), <![CDATA[<p>Extra text</p>]]>)</ex></example>
|
||||
|
||||
<h2 tag="writing-plugins">Writing plugins</h2>
|
||||
|
||||
<p>
|
||||
Writing &liberator.appname; plugins is incredibly simple.
|
||||
Plugins are simply JavaScript files which run with full chrome
|
||||
privileges and have full access to the &liberator.appname; and
|
||||
@@ -82,14 +88,17 @@ installed in your <o>runtimepath</o><em>/plugin</em> directory
|
||||
will find its context stored in
|
||||
<em>plugins.<pluginName></em>, which is often invaluable
|
||||
during development and testing.
|
||||
</p>
|
||||
|
||||
<h3 tag="plugin-documentation">Plugin documentation</h3>
|
||||
|
||||
<p>
|
||||
Plugins may provide inline documentation, which will appear on
|
||||
the <ex>:help plugins</ex> page. The markup for help entries
|
||||
is the same as the above, with a few more plugin specific
|
||||
entries. Here is an example from the popular
|
||||
<em>flashblock</em> extension:
|
||||
</p>
|
||||
|
||||
<code><![CDATA[
|
||||
var INFO =
|
||||
@@ -125,6 +134,7 @@ var INFO =
|
||||
]]>
|
||||
</code>
|
||||
|
||||
<p>
|
||||
The inline XML is made possible by
|
||||
<link topic="https://developer.mozilla.org/en/E4X">E4X</link>.
|
||||
It's important that the documentation be assigned to the
|
||||
@@ -137,6 +147,7 @@ documentation is not required, we strongly recommend that all
|
||||
plugin authors provide at least basic documentation of the
|
||||
functionality of their plugins and of each of the options,
|
||||
commands, and especially mappings that they provide.
|
||||
</p>
|
||||
|
||||
</document>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user