1
|
<p>The advanced help configuration file is in simple .ini file format.
|
2
|
It has an optional section for global settings that might be inherited
|
3
|
for each help topic, followed by sections for each topic.</p>
|
4
|
|
5
|
<p>Global settings may be put into a section named <code>[advanced
|
6
|
help settings]</code>. This means that this name is reserved and it
|
7
|
cannot be a topic in any module or theme. The following settings may
|
8
|
be set in this section, with the default value (if any) in
|
9
|
brackets.</p>
|
10
|
|
11
|
<dl>
|
12
|
<dt><code>line break</code> (FALSE)</dt>
|
13
|
<dd>If set, the line break filter will be applied to all help topics
|
14
|
defined by this module or theme, unless that topic specifically is
|
15
|
set otherwise. The line break converts line breaks
|
16
|
into <code>br</code> and <code>p</code> tags automatically.</dd>
|
17
|
|
18
|
<dt><code>navigation</code> (TRUE)</dt>
|
19
|
<dd>If set, this navigation will be displayed at the end of the topic:
|
20
|
<em>previous topic</em>, Up (parent), <em>next topic</em>.</dd>
|
21
|
|
22
|
<dt><code>css</code></dt>
|
23
|
<dd>Specify a css file that will be used for all topics (unless
|
24
|
overridden), including the .css extension. This .css file must reside
|
25
|
in the help directory along with the .html files, and will not be
|
26
|
affected by translation.</dd>
|
27
|
|
28
|
<dt><code>name</code></dt>
|
29
|
<dd>May be set to override the module or theme name as displayed in
|
30
|
both the module/theme index as well as the navigation and breadcrumb
|
31
|
trail. Usually, this is not set, but for some projects you may want to
|
32
|
use a more friendly name than appears in the project's .info file.</dd>
|
33
|
|
34
|
<dt><code>index name</code></dt>
|
35
|
<dd>This may be set to change the name of the module or theme in the
|
36
|
module/theme index. It overrides the <code>name</code> setting above,
|
37
|
as well as the project's name in its .info file.</dd>
|
38
|
|
39
|
<dt><code>show readme</code> (FALSE)</dt>
|
40
|
<dd>For projects that comes with a set of HTML-files, the default is
|
41
|
to hide the project's <code>README</code>-file. Setting this TRUE will
|
42
|
show the README along with the HTML-files.</dd>
|
43
|
|
44
|
<dt><code>hide</code> (FALSE)</dt>
|
45
|
<dd>This may be used to hide a module or theme in the module/theme
|
46
|
index. This is particularly useful for modules who insert their topics
|
47
|
into the hierarchy of another module or theme. By setting this to TRUE
|
48
|
the project will not appear as its own entry.</dd>
|
49
|
|
50
|
</dl>
|
51
|
|
52
|
<p>Each section after that will correspond to a single help file for a
|
53
|
single topic. It starts with the topic machine name in square
|
54
|
brackets (e.g. <code>[introduction]</code>). The file containing the
|
55
|
documentation for that topic will have the same machine name with the
|
56
|
extension <code>html</code> (e.g. <code>introduction.html</code>) The
|
57
|
following settings may be set for each file/topic, with the default
|
58
|
value (if any) in brackets.</p>
|
59
|
|
60
|
<dl>
|
61
|
<dt><code>title</code></dt>
|
62
|
<dd>The title of the topic, presented to the user and used in
|
63
|
links. If you have special characters in your title, be sure to
|
64
|
enclose it in quotes. (This setting is currently not optional.)</dd>
|
65
|
|
66
|
<dt><code>file</code> (topic name)</dt>
|
67
|
<dd>The filename, without the .html extension, used for the file with
|
68
|
the help text for the topic. This is optional; if not specified, the
|
69
|
topic name will be the file name.</dd>
|
70
|
|
71
|
<dt><code>weight</code> (0)</dt>
|
72
|
<dd>The weight, used for sorting topics on the administration
|
73
|
page. The default is 0 (zero) if unspecified. Items with the same weight
|
74
|
are sorted alphabetically.</dd>
|
75
|
|
76
|
<dt><code>parent</code></dt>
|
77
|
<dd>The topic ID to use in a hierarchy; children will be listed
|
78
|
beneath parents in the topic list, and will have the parent in their
|
79
|
breadcrumb trail. You may parent this topic to a topic
|
80
|
in <em>another</em> module or theme by using <code>module%topic</code>
|
81
|
or <code>theme%topic</code> as the identifier,
|
82
|
where <code>module</code> or <code>theme</code> is the project's short
|
83
|
name. For example if parent is set to, '<code>views%display</code>',
|
84
|
the topic will be regarded as a child of the
|
85
|
<code>display</code> topic in the <strong>Views</strong> module.</dd>
|
86
|
|
87
|
<dt><code>format</code></dt>
|
88
|
<dd>Run topic through this text format (use the format's machine
|
89
|
name). For example: To convert line breaks into <code>br</code>
|
90
|
and <code>p</code> tags automatically, use the <code>full_html</code>
|
91
|
format.</dd>
|
92
|
|
93
|
<dt><code>line break</code></dt>
|
94
|
<dd>Set the line break filter for this topic. Set to FALSE to disable
|
95
|
the line break filter if this has been turned on in the global
|
96
|
settings.</dd>
|
97
|
|
98
|
<dt><code>css</code></dt>
|
99
|
<dd>Specify a css file that will be used for this file. This .css file
|
100
|
must reside in the help directory along with the .html files. This
|
101
|
will override any .css file added by the global settings.</dd>
|
102
|
|
103
|
<dt><code>popup width</code> (500)</dt>
|
104
|
<dd>The width in pixels of the popup window.</dd>
|
105
|
|
106
|
<dt><code>popup height</code> (500)</dt>
|
107
|
<dd>The height in pixels of the popup window.</dd>
|
108
|
</dl>
|
109
|
|
110
|
<p>Take a look at the .ini-file for this project to see an ini-file
|
111
|
example.</p>
|