1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?xml version="1.0" encoding="utf-8"?>
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" type="topic" style="task" id="dev-help-write" xml:lang="oc">
<info>
<link type="next" xref="dev-help-build"/>
<revision version="0.1" date="2013-06-19" status="review"/>
<credit type="author">
<name>Ekaterina Gerasimova</name>
<email its:translate="no">kittykat3756@gmail.com</email>
<years>2013</years>
</credit>
<include xmlns="http://www.w3.org/2001/XInclude" href="cc-by-sa-3-0.xml"/>
</info>
<title>Write some help</title>
<links type="series" style="floatend">
<title>Set up help</title>
</links>
<p>Write some <link href="http://www.projectmallard.org/">Mallard</link>
pages and add them to <file>help/C/</file>.</p>
<p>Most projects should have an <file>index.page</file> and some content
pages, although you may not need an <file>index.page</file> if you are
dropping plugin help into another project.</p>
<example>
<listing>
<title><file>help/C/index.page</file></title>
<code><![CDATA[
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="guide"
id="index">
<info>
<revision pkgversion="3.9" date="2013-06-19" status="stub"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
</info>
<title>
<media type="image" mime="image/png" its:translate="no" src="figures/icon.png" />
Application name
</title>
<section id="features" style="2column">
<title>Features</title>
</section>
</page>
]]></code>
</listing>
<listing>
<title><file>help/C/introduction.page</file></title>
<code><![CDATA[
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic"
id="introduction">
<info>
<link type="guide" xref="index"/>
<!--
<link type="guide" xref="index#features"/>
<link type="seealso" xref="anotherpageid"/>
-->
<revision pkgversion="3.9" date="2013-06-19" status="stub"/>
<credit type="author">
<name>Your Name</name>
<email its:translate="no">mail@example.com</email>
<years>2013</years>
</credit>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<desc>Welcome to _Application name_</desc>
</info>
<title>Introduction</title>
<p>This application is awesome!</p>
</page>
]]></code>
</listing>
</example>
</page>
|
