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
|
<chapter id="tools">
<title>* Tools</title>
<para>The Documentation Project uses a number of tools to assist in the
production of documentation. You will need to install some or all of these
tools before you will be able to make changes.</para>
<important>
<title>Use <filename>textproc/docproj</filename> if possible</title>
<para>You can save yourself a lot of time if you install the
<filename>textproc/docproj</filename> port. This is a
<emphasis>meta-port</emphasis> which does not contain any software
itself. Instead, it depends on various other ports being installed
correctly. Installing this port <emphasis>should</emphasis>
automatically download and install all of the packages listed in this
chapter that you need that are missing from your system.</para>
<para>One of the packages that you might need is the JadeTeX macro set.
In turn, this macro set requires that TeX is installed. TeX is a large
package, and you only need it if you want to produce Postscript or PDF
output.</para>
<para>To save yourself time and space you must specify whether or not you
want JadeTeX (and therefore TeX) installed when you install this port.
Either do;
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
or
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
as necessary.</para>
</important>
<sect1>
<title>Software</title>
<para>The project uses the following applications;</para>
<variablelist>
<varlistentry>
<term><application>Jade</application> and
<application>SP</application></term>
<listitem>
<para>These are two application suites by James Clark, who has
produced many useful SGML-processing applications.
<application>Jade</application> is “James' DSSSL
Engine”, a system that takes SGML documentation and a DSSSL
stylesheet and produces converted output.
<application>SP</application> contains a number of useful
applications to manipulate, normalise, and interrogate SGML
documents.</para>
<para>Don't be concerned if these terms are unfamliar to you.</para>
<para>They can be found in the ports system as
<filename>textproc/jade</filename> and
<filename>textproc/sp</filename> respectively.</para>
<note>
<para>Installed as part of
<filename>textproc/docproj</filename>.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><application>teTeX</application></term>
<listitem>
<para><application>teTeX</application> is a distrubution of the TeX
typesetting system, and is used (in conjunction with Jade) to
produce the Postscript and PDF output formats.</para>
<para>v0.9 of <application>teTeX</application> is required, which is
currently in the ports collection as
<filename>print/teTeX-beta</filename>.</para>
<note>
<para>Might be installed as part of
<filename>textproc/docproj</filename>, depending on the
<makevar>JADETEX</makevar> setting.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Emacs</application> or
<application>Xemacs</application></term>
<listitem>
<para>Neither of these programs is required. However, both of them
feature PSGML-MODE, a useful extension when dealing with SGML
documents that can reduce the amount of typing you need to do, and
remove some of the more obvious errors.</para>
<para>They can be found in <filename>editor/emacs20</filename> and
<filename>editor/xemacs20</filename>.</para>
<note>
<para>Not installed as part of
<filename>textproc/docproj</filename>.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>Document Type Definitions (DTDs)</title>
<para>The project uses the following DTDs;</para>
<variablelist>
<varlistentry>
<term>HTML</term>
<listitem>
<para>HTML, the HyperText Markup Language, is the markup language of
choice on the World Wide Web. More information can be found at
<URL:<ulink
url="http://www.w3.org/">http://www.w3.org/</ulink>>.</para>
<para>HTML has gone through a number of versions, 1, 2, 3.0, 3.2,
and the latest, 4.0 (available in both <emphasis>strict</emphasis>
and <emphasis>loose</emphasis> variants).</para>
<para>The HTML DTDs are available from the ports collection in the
<filename>textproc/html</filename> category.</para>
<note>
<para>Installed as part of
<filename>textproc/docproj</filename>.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>LinuxDoc</term>
<listitem>
<para>LinuxDoc is an adaptation of the QWERTZ DTD, first adopted by
the <ulink url="http://sunsite.unc.edu/LDP/">Linux Documentation
Project</ulink>, and subsequently adopted by the FreeBSD
Documentation Project.</para>
<para>The LinuxDoc DTD contains primarily appearance related markup
rather than content related markup (i.e., it describes what
something looks like rather than what it is).</para>
<para>Both the FreeBSD Documentation Project and the Linux
Documentation Project are migrating from the LinuxDoc DTD to the
DocBook DTD.</para>
<para>The LinuxDoc DTD is available from the ports collection in the
<filename>textproc/linuxdoc</filename> category.</para>
<note>
<para>Installed as part of
<filename>textproc/docproj</filename>.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>DocBook</term>
<listitem>
<para>DocBook was designed by the <ulink
url="http://www.oreilly.com/davenport/">Davenport Group</ulink>
to be a DTD for writing technical documentation. As such, it
contains XXX</para>
<note>
<para>Installed as part of
<filename>textproc/docproj</filename>.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>DSSSL Stylesheets</title>
<para>The Documentation Project uses a slightly customised version of
Norm Walsh's modular DocBook stylesheets.</para>
<para>These can be found in
<filename>textproc/dsssl-docbook-modular</filename>.</para>
<note>
<para>Installed as part of <filename>textproc/docproj</filename>.</para>
</note>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->
|
