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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Users_Guide.ent">
%BOOK_ENTITIES;
]>
<appendix id="dump_file">
<title>Contents of the website dump file</title>
<para>
The dump file for a <application>Publican</application>-generated website contains some basic site configuration details, together with details of every document published on the site. The site configuration details are:
</para>
<variablelist>
<varlistentry>
<term><sgmltag><host></sgmltag></term>
<listitem>
<para>
The URL to the root of the documentation site, as set by the <parameter>host</parameter> parameter in the site configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><def_lang></sgmltag></term>
<listitem>
<para>
The default language of the documentation on the website, as set by the <parameter>def_lang</parameter> parameter in the site configuration file.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Each document, in each language, in each format has a separate record. These records contain the following data:
</para>
<variablelist>
<varlistentry>
<term><sgmltag><name></sgmltag></term>
<listitem>
<para>
The title of the document, generated from the <sgmltag><title></sgmltag> tag in the <literal>Book_Info.xml</literal>, <literal>Article_Info.xml</literal>, or <literal>Set_Info.xml</literal> file unless overridden by the <parameter>docname</parameter> parameter in the <filename>publican.cfg</filename> file. Any spaces in the title are replaced by underscores.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><ID></sgmltag></term>
<listitem>
<para>
A unique ID number for this document, in this format, in this language.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><abstract></sgmltag></term>
<listitem>
<para>
A brief summary of the content of the document, generated from the <sgmltag><abstract></sgmltag> tag in the <literal>Book_Info.xml</literal>, <literal>Article_Info.xml</literal>, or <literal>Set_Info.xml</literal> file. <application>Publican</application> uses this same content to generate the <literal>%description</literal> section of the spec file when it packages a document. If the <sgmltag><abstract></sgmltag> is translated, this field contains the translated text.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><format></sgmltag></term>
<listitem>
<para>
The format in which the document is produced — <literal>html</literal> for multi-page html, <literal>html-single</literal> for single-page html, <literal>pdf</literal> for PDF, and <literal>epub</literal> for EPUB.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><language></sgmltag></term>
<listitem>
<para>
The language code for the document. Refer to <xref linkend="appe-Users_Guide-Language_codes"/> for more information about language codes in XML.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><name_label></sgmltag></term>
<listitem>
<para>
The name of the document as it appears in the site table of contents. This label can be set with the <parameter>web_name_label</parameter> parameter in the document's <filename>publican.cfg</filename> file. Otherwise, the field is empty for a document in its original language, or uses the translated title of the document in a translated language. Any spaces in the name label are replaced by underscores.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><product></sgmltag></term>
<listitem>
<para>
The product that the document describes, generated from the <sgmltag><productname></sgmltag> tag in the <literal>Book_Info.xml</literal>, <literal>Article_Info.xml</literal>, or <literal>Set_Info.xml</literal> file unless overridden by the <parameter>product</parameter> parameter in the <filename>publican.cfg</filename> file. Any spaces in the product name are replaced by underscores.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><product_label></sgmltag></term>
<listitem>
<para>
The name of the product as it appears in the site table of contents. This label can be set with the <parameter>web_product_label</parameter> parameter in the document's <filename>publican.cfg</filename> file. Otherwise, the field is empty for a document in its original language, or uses the translated title of the document in a translated language. Any spaces in the name label are replaced by underscores.
</para>
<para>
If the product label is set to <literal>UNUSED</literal>, no heading for this product appears in the website tables of contents.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><subtitle></sgmltag></term>
<listitem>
<para>
A one-line description of the content of the document, generated from the <sgmltag><subtitle></sgmltag> tag in the <literal>Book_Info.xml</literal>, <literal>Article_Info.xml</literal>, or <literal>Set_Info.xml</literal> file. <application>Publican</application> uses this same content to generate the <literal>Summary</literal> section of the spec file when it packages a document. If the <sgmltag><subtitle></sgmltag> is translated, this field contains the translated text.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><update_date></sgmltag></term>
<listitem>
<para>
The date that the document was most recently installed on the site, in the format YYYY-MM-DD.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><version></sgmltag></term>
<listitem>
<para>
The version of the product that the document describes (<emphasis>not</emphasis> the version of the document itself), generated from the <sgmltag><productnumber></sgmltag> tag in the <literal>Book_Info.xml</literal>, <literal>Article_Info.xml</literal>, or <literal>Set_Info.xml</literal> file unless overridden by the <parameter>version</parameter> parameter in the <filename>publican.cfg</filename> file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><sgmltag><version_label></sgmltag></term>
<listitem>
<para>
The version of the product as it appears in the site table of contents. This label can be set with the <parameter>web_version_label</parameter> parameter in the document's <filename>publican.cfg</filename> file.
</para>
<para>
If the version label is set to <literal>UNUSED</literal>, no heading for this version of the product appears in the website tables of contents.
</para>
</listitem>
</varlistentry>
</variablelist>
<example>
<title>Sample records from a <filename>DUMP.xml</filename> file</title>
<para>
These two records from a <filename>DUMP.xml</filename> file show the same book, the <citetitle>Red Hat Enterprise Linux 5 Installation Guide</citetitle>, in two different formats and two different languages — an English PDF version and a French multi-page HTML version.
</para>
<programlisting language="XML"><xi:include href="extras/DUMP.xmlt" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
</example>
<section>
<title>Computing URLs from the dump file</title>
<para>
Using the following fields, you can compute the URL of any document on the site:
</para>
<itemizedlist>
<listitem>
<para>
<sgmltag><host></sgmltag>
</para>
</listitem>
<listitem>
<para>
<sgmltag><name></sgmltag>
</para>
</listitem>
<listitem>
<para>
<sgmltag><format></sgmltag>
</para>
</listitem>
<listitem>
<para>
<sgmltag><language></sgmltag>
</para>
</listitem>
<listitem>
<para>
<sgmltag><product></sgmltag>
</para>
</listitem>
<listitem>
<para>
<sgmltag><version></sgmltag>
</para>
</listitem>
</itemizedlist>
<variablelist>
<varlistentry>
<term>muti-page HTML</term>
<listitem>
<para>
<sgmltag><host></sgmltag>/<sgmltag><language></sgmltag>/<sgmltag><product></sgmltag>/<sgmltag><version></sgmltag>/<sgmltag><format></sgmltag>/<sgmltag><name></sgmltag>/<filename>index.html</filename>
</para>
<para>
For example, <filename>http://docs.fedoraproject.org/en-US/Fedora/14/html/Accessibility_Guide/index.html</filename>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>single-page HTML</term>
<listitem>
<para>
<sgmltag><host></sgmltag>/<sgmltag><language></sgmltag>/<sgmltag><product></sgmltag>/<sgmltag><version></sgmltag>/<sgmltag><format></sgmltag>/<sgmltag><name></sgmltag>/<filename>index.html</filename>
</para>
<para>
For example, <filename>http://docs.fedoraproject.org/en-US/Fedora/14/html-single/Accessibility_Guide/index.html</filename>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PDF</term>
<listitem>
<para>
<sgmltag><host></sgmltag>/<sgmltag><language></sgmltag>/<sgmltag><product></sgmltag>/<sgmltag><version></sgmltag>/<sgmltag><format></sgmltag>/<sgmltag><name></sgmltag>/<sgmltag><product></sgmltag>-<sgmltag><version></sgmltag>-<sgmltag><name></sgmltag>-<sgmltag><language></sgmltag>.<filename>pdf</filename>
</para>
<para>
For example, <filename>http://docs.fedoraproject.org/en-US/Fedora/14/pdf/Accessibility_Guide/Fedora-14-Accessibility_Guide-en-US.pdf</filename>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EPUB</term>
<listitem>
<para>
<sgmltag><host></sgmltag>/<sgmltag><language></sgmltag>/<sgmltag><product></sgmltag>/<sgmltag><version></sgmltag>/<sgmltag><format></sgmltag>/<sgmltag><name></sgmltag>/<sgmltag><product></sgmltag>-<sgmltag><version></sgmltag>-<sgmltag><name></sgmltag>-<sgmltag><language></sgmltag>.<filename>epub</filename>
</para>
<para>
For example, <filename>http://docs.fedoraproject.org/en-US/Fedora/14/pdf/Accessibility_Guide/Fedora-14-Accessibility_Guide-en-US.epub</filename>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Note that the <sgmltag><product_label></sgmltag>, <sgmltag><version_label></sgmltag>, and <sgmltag><name_label></sgmltag> fields have no significance for URLs, even when these fields are suppressed in tables of contents by the <literal>UNUSED</literal> setting.
</para>
</section>
</appendix>
|
