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
|
<!-- $Id: -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- *************** Bring in Fedora entities *************** -->
<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "fdp-entities.ent">
%FEDORA-ENTITIES-EN;
]>
<chapter id="ch-getting-files">
<title>Prerequisites</title>
<para>
To work on official &FED; documentation you need to install the required
tools. Follow the directions below to configure your system.
</para>
<section id="ch-getting-files-system-packages">
<title>System Packages</title>
<para>
Install the "Authoring and Publishing" package group, which contains
required DocBook XML files, stylesheets and scripts:
</para>
<screen>
<userinput>su -c 'yum groupinstall "Authoring and Publishing"'</userinput>
</screen>
<para>
Next, install the <filename>cvs</filename> package, which is used to
handle revision control on files in the official repository:
</para>
<screen>
<userinput>su -c 'yum install cvs'</userinput>
</screen>
<para>If you plan to use <application>Emacs</application> to edit
DocBook XML documentation, install <package>psgml</package>, which
adds helpful and time-saving functionality to maximize editing
efficiency:</para>
<screen><userinput>su -c 'yum install psgml'</userinput></screen>
</section>
<section id="ch-getting-files-fdp">
<title>Fedora Documentation Tools</title>
<para>
The &FDP;'s custom scripts and stylesheets are stored in CVS on the
<systemitem class="fqdomainname">cvs.fedoraproject.org</systemitem> CVS
server. When you check out a document module from CVS, the tools
are included in the module inside the <filename
class="directory">docs-common/</filename> directory.
To work on existing documents in CVS, refer to <xref
linkend="ch-cvs"/>.
</para>
</section>
<section id="ch-getting-files-filenames">
<title>Filename Conventions</title>
<para>
The &FDP; provides the tools, scripts, and stylesheets to transform your
<abbrev>XML</abbrev> documents into other output formats such as
<abbrev>HTML</abbrev>. In addition, these tools can build your document
into a <abbrev>RPM</abbrev> package. To take advantage of these
services, you must follow conventions for naming your files.
</para>
<section id="ch-getting-files-filenames-doc">
<title>Document Filenames</title>
<para>
Each document lives in a peer directory to the
<filename>docs-common</filename> directory you extracted from the &FED;
archive earlier. On the CVS server, these directories are called
<firstterm>modules</firstterm>. Use
the <command>cvs co -c</command> command to view existing module names.
</para>
<example>
<title>Partial List of CVS Modules</title>
<screen><userinput>cd ~/localrepo/fedora-docs/</userinput>
<computeroutput>developer-guide developer-guide
docs .
docs-common docs-common
documentation-guide documentation-guide
example-tutorial example-tutorial</computeroutput></screen>
</example>
<para>Choose a module name that accurately reflects your
document's subject, but avoid any name already taken.</para>
<important>
<title>Avoid Redundancy</title>
<para>
Do not use the word <wordasword>&FED;</wordasword> to name
modules in the &FDP; CVS repository.
</para>
</important>
</section>
</section>
</chapter>
<!--
Local variables:
mode: xml
fill-column: 72
End:
-->
|
