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

Add machinery to splice in app-specific help entries.

Browse Source 
--HG--
branch : xslt
rename : vimperator/locale/en-US/all.xml => common/locale/en-US/all.xml
rename : vimperator/locale/en-US/autocommands.xml => common/locale/en-US/autocommands.xml
rename : vimperator/locale/en-US/browsing.xml => common/locale/en-US/browsing.xml
rename : vimperator/locale/en-US/buffer.xml => common/locale/en-US/buffer.xml
rename : vimperator/locale/en-US/cmdline.xml => common/locale/en-US/cmdline.xml
rename : vimperator/locale/en-US/developer.xml => common/locale/en-US/developer.xml
rename : vimperator/locale/en-US/eval.xml => common/locale/en-US/eval.xml
rename : vimperator/locale/en-US/gui.xml => common/locale/en-US/gui.xml
rename : vimperator/locale/en-US/hints.xml => common/locale/en-US/hints.xml
rename : vimperator/locale/en-US/index.xml => common/locale/en-US/index.xml
rename : vimperator/locale/en-US/insert.xml => common/locale/en-US/insert.xml
rename : vimperator/locale/en-US/intro.xml => common/locale/en-US/intro.xml
rename : vimperator/locale/en-US/map.xml => common/locale/en-US/map.xml
rename : vimperator/locale/en-US/marks.xml => common/locale/en-US/marks.xml
rename : vimperator/locale/en-US/message.xml => common/locale/en-US/message.xml
rename : vimperator/locale/en-US/options.xml => common/locale/en-US/options.xml
rename : vimperator/locale/en-US/pattern.xml => common/locale/en-US/pattern.xml
rename : vimperator/locale/en-US/print.xml => common/locale/en-US/print.xml
rename : vimperator/locale/en-US/repeat.xml => common/locale/en-US/repeat.xml
rename : vimperator/locale/en-US/starting.xml => common/locale/en-US/starting.xml
rename : vimperator/locale/en-US/styling.xml => common/locale/en-US/styling.xml
rename : vimperator/locale/en-US/tabs.xml => common/locale/en-US/tabs.xml
rename : vimperator/locale/en-US/tutorial.xml => common/locale/en-US/tutorial.xml
rename : vimperator/locale/en-US/various.xml => common/locale/en-US/various.xml
This commit is contained in:
Kris Maglione
2009-10-24 16:17:33 -04:00
parent 4c13eb0798
commit 8b222085ec
28 changed files with 211 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
common/locale/en-US/developer.xml Normal file
View File

@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?>
<!DOCTYPE document SYSTEM "chrome://liberator/content/liberator.dtd">
<document
name="developer"
title="&liberator.appname; Developer information"
xmlns="http://vimperator.org/namespaces/liberator"
xmlns:html="http://www.w3.org/1999/xhtml">
<h2 tag="developer-information">Developer information</h2>
<h2 tag="writing-docs documentation">Writing documentation</h2>
<p>
For every new feature, writing documentation is <em>mandatory</em> for the
patch to be accepted. The docs are written in an XML dialect similar to
XHTML, with a few tags specific to our documentation. For example:
</p>
<code><![CDATA[
<item>
<tags><![CDATA[<F1> :help :h help]]]]><![CDATA[></tags>
<spec>:h<oa>elp</oa> <a>subject</a></spec>
<spec><![CDATA[<F1>]]]]><![CDATA[></spec>
<description>
<p>
Open help window.
The default section is shown unless <a>subject</a> is specified.
If you need help for a specific topic, try <ex>:help overview</ex>.
</p>
</description>
</item>
]]></code>
<p>
creates a new help section for the command <ex>:help</ex> and for
the related key binding, <k name="F1"/>. It also creates help tags
for the command, its shortcuts, the key binding, and the general
topic, 'help'. These tags enable linking to this section when from
other mentions of the topic and from the <ex>:help</ex> command.
The above code displays as:
</p>
<html:div style="margin: 2em;">
<item>
<tags><![CDATA[<F1> :help :h help]]></tags>
<spec>:h<oa>elp</oa> <a>subject</a></spec>
<spec><![CDATA[<F1>]]></spec>
<description>
<p>
Open help window.
The default section is shown unless <a>subject</a> is specified.
If you need help for a specific topic, try <ex>:help overview</ex>.
</p>
</description>
</item>
</html:div>
If you don't know in which file/section you should put some
documentation, ask on the mailing list or on #vimperator.
<h2 tag="generating-docs">Generating documentation</h2>
You can also autogenerate most of the XML help after you have
written a new command, mapping or option. For this, use:
:echo util.generateHelp(commands.get("addons"), "Extra text")
</document>
<!-- vim:se sts=4 sw=4 et: -->