gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-03-02 07:55:45 +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

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

@@ -57,39 +57,48 @@
</item> </item>
</html:div> </html:div>
If you don't know in which file/section you should put some <p>
documentation, ask on the mailing list or on #vimperator. If you don't know in which file/section you should put some
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>
You can also autogenerate most of the XML help after you have <p>
written a new command, mapping or option. For this, use: You can also autogenerate most of the XML help after you have
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>
Writing &liberator.appname; plugins is incredibly simple. <p>
Plugins are simply JavaScript files which run with full chrome Writing &liberator.appname; plugins is incredibly simple.
privileges and have full access to the &liberator.appname; and Plugins are simply JavaScript files which run with full chrome
&liberator.host; APIs. Each plugin has its own global object, privileges and have full access to the &liberator.appname; and
which means that the variables and functions that you create &liberator.host; APIs. Each plugin has its own global object,
won't pollute the global <em>window</em> or private which means that the variables and functions that you create
<em>liberator</em> namespaces. This means that there's no need won't pollute the global <em>window</em> or private
to wrap your plugin in a closure, as is often the practice in <em>liberator</em> namespaces. This means that there's no need
JavaScript development. Furthermore, any plugin which is to wrap your plugin in a closure, as is often the practice in
installed in your <o>runtimepath</o><em>/plugin</em> directory JavaScript development. Furthermore, any plugin which is
will find its context stored in installed in your <o>runtimepath</o><em>/plugin</em> directory
<em>plugins.&lt;pluginName></em>, which is often invaluable will find its context stored in
during development and testing. <em>plugins.&lt;pluginName></em>, which is often invaluable
during development and testing.
</p>
<h3 tag="plugin-documentation">Plugin documentation</h3> <h3 tag="plugin-documentation">Plugin documentation</h3>
Plugins may provide inline documentation, which will appear on <p>
the <ex>:help plugins</ex> page. The markup for help entries Plugins may provide inline documentation, which will appear on
is the same as the above, with a few more plugin specific the <ex>:help plugins</ex> page. The markup for help entries
entries. Here is an example from the popular is the same as the above, with a few more plugin specific
<em>flashblock</em> extension: entries. Here is an example from the popular
<em>flashblock</em> extension:
</p>
<code><![CDATA[ <code><![CDATA[
var INFO = var INFO =
@@ -125,18 +134,20 @@ var INFO =
]]> ]]>
</code> </code>
The inline XML is made possible by <p>
<link topic="https://developer.mozilla.org/en/E4X">E4X</link>. The inline XML is made possible by
It's important that the documentation be assigned to the <link topic="https://developer.mozilla.org/en/E4X">E4X</link>.
<em>INFO</em> variable, or &liberator.appname; will not be able It's important that the documentation be assigned to the
to find it. The documentation that you provide behaves exactly <em>INFO</em> variable, or &liberator.appname; will not be able
as other &liberator.appname; documentation, which means that to find it. The documentation that you provide behaves exactly
the tags you provide are available via <ex>:help</ex> with as other &liberator.appname; documentation, which means that
full tag completion and cross-referencing support. Although the tags you provide are available via <ex>:help</ex> with
documentation is not required, we strongly recommend that all full tag completion and cross-referencing support. Although
plugin authors provide at least basic documentation of the documentation is not required, we strongly recommend that all
functionality of their plugins and of each of the options, plugin authors provide at least basic documentation of the
commands, and especially mappings that they provide. functionality of their plugins and of each of the options,
commands, and especially mappings that they provide.
</p>
</document> </document>