gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-03-23 05:13:32 +01:00
Code Issues Projects Releases Wiki Activity

Fix some help markup issues.

Browse Source
This commit is contained in:
Kris Maglione
2009-11-01 00:20:48 -04:00
parent acf329bfc3
commit 80101a0f59
1 changed files with 46 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
common/locale/en-US/developer.xml
View File

@@ -57,18 +57,24 @@
</item> </item>
</html:div> </html:div>
<p>
If you don't know in which file/section you should put some 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> <h2 tag="generating-docs">Generating documentation</h2>
<p>
You can also autogenerate most of the XML help after you have 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> <h2 tag="writing-plugins">Writing plugins</h2>
<p>
Writing &liberator.appname; plugins is incredibly simple. Writing &liberator.appname; plugins is incredibly simple.
Plugins are simply JavaScript files which run with full chrome Plugins are simply JavaScript files which run with full chrome
privileges and have full access to the &liberator.appname; and 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 will find its context stored in
<em>plugins.&lt;pluginName></em>, which is often invaluable <em>plugins.&lt;pluginName></em>, which is often invaluable
during development and testing. during development and testing.
</p>
<h3 tag="plugin-documentation">Plugin documentation</h3> <h3 tag="plugin-documentation">Plugin documentation</h3>
<p>
Plugins may provide inline documentation, which will appear on Plugins may provide inline documentation, which will appear on
the <ex>:help plugins</ex> page. The markup for help entries the <ex>:help plugins</ex> page. The markup for help entries
is the same as the above, with a few more plugin specific is the same as the above, with a few more plugin specific
entries. Here is an example from the popular entries. Here is an example from the popular
<em>flashblock</em> extension: <em>flashblock</em> extension:
</p>
<code><![CDATA[ <code><![CDATA[
var INFO = var INFO =
@@ -125,6 +134,7 @@ var INFO =
]]> ]]>
</code> </code>
<p>
The inline XML is made possible by The inline XML is made possible by
<link topic="https://developer.mozilla.org/en/E4X">E4X</link>. <link topic="https://developer.mozilla.org/en/E4X">E4X</link>.
It's important that the documentation be assigned to the 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 plugin authors provide at least basic documentation of the
functionality of their plugins and of each of the options, functionality of their plugins and of each of the options,
commands, and especially mappings that they provide. commands, and especially mappings that they provide.
</p>
</document> </document>