Whitespace-only fixes.
This commit is contained in:
Warren Block
parent
f2df77b75d
commit
75d1fc89f0
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=38424
1 changed files with 99 additions and 81 deletions
|
|
@ -47,39 +47,42 @@
|
|||
tools is covered in later chapters.</para>
|
||||
|
||||
<tip>
|
||||
<title>Use <filename role="package">textproc/docproj</filename> If Possible</title>
|
||||
<title>Use <filename role="package">textproc/docproj</filename> If
|
||||
Possible</title>
|
||||
|
||||
<para>You can save yourself a lot of time if you install the
|
||||
<filename role="package">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.</para>
|
||||
<filename role="package">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.</para>
|
||||
|
||||
<para>One of the packages that you might need is the <application>JadeTeX</application> macro set.
|
||||
In turn, this macro set requires &tex; to be installed. &tex; is a large
|
||||
package, and you only need it if you want to produce Postscript or PDF
|
||||
output.</para>
|
||||
<para>One of the packages that you might need is the
|
||||
<application>JadeTeX</application> macro set. In turn, this
|
||||
macro set requires &tex; to be 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 <application>JadeTeX</application> (and therefore &tex;) installed when you install this port.
|
||||
Either do:</para>
|
||||
<para>To save yourself time and space you must specify whether or
|
||||
not you want <application>JadeTeX</application> (and therefore
|
||||
&tex;) installed when you install this port. Either do:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
|
||||
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
|
||||
|
||||
<para>or</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
|
||||
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
|
||||
|
||||
<para>as necessary. Alternatively you may install <filename
|
||||
role="package">textproc/docproj-jadetex</filename> or <filename
|
||||
role="package">textproc/docproj-nojadetex</filename>. These slave ports
|
||||
define the <makevar>JADETEX</makevar> variable for you, therefore they
|
||||
will install the same suite of applications on your machine.
|
||||
Note that you can produce only HTML or ASCII
|
||||
text output if you do not install <application>JadeTeX</application>.
|
||||
PostScript or PDF output requires &tex;.</para>
|
||||
<para>as necessary. Alternatively you may install
|
||||
<filename role="package">textproc/docproj-jadetex</filename> or
|
||||
<filename role="package">textproc/docproj-nojadetex</filename>.
|
||||
These slave ports define the <makevar>JADETEX</makevar> variable
|
||||
for you, therefore they will install the same suite of
|
||||
applications on your machine. Note that you can produce only
|
||||
HTML or ASCII text output if you do not install
|
||||
<application>JadeTeX</application>. PostScript or PDF output
|
||||
requires &tex;.</para>
|
||||
</tip>
|
||||
|
||||
<sect1 id="tools-mandatory">
|
||||
|
|
@ -88,10 +91,11 @@
|
|||
<sect2>
|
||||
<title>Software</title>
|
||||
|
||||
<para>These programs are required before you can usefully work with the
|
||||
FreeBSD documentation, and they will allow you to convert the
|
||||
documentation to HTML, plain text, and RTF formats. They are all
|
||||
included in <filename role="package">textproc/docproj</filename>.</para>
|
||||
<para>These programs are required before you can usefully work
|
||||
with the FreeBSD documentation, and they will allow you to
|
||||
convert the documentation to HTML, plain text, and RTF
|
||||
formats. They are all included in <filename
|
||||
role="package">textproc/docproj</filename>.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
|
|
@ -99,8 +103,9 @@
|
|||
(<filename role="package">textproc/jade</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>A DSSSL implementation. Used for converting marked up
|
||||
documents to other formats, including HTML and &tex;.</para>
|
||||
<para>A DSSSL implementation. Used for converting marked
|
||||
up documents to other formats, including HTML and
|
||||
&tex;.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
|
@ -109,9 +114,9 @@
|
|||
(<filename role="package">www/tidy</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>An HTML <quote>pretty printer</quote>, used to reformat some of the
|
||||
automatically generated HTML so that it is easier to
|
||||
follow.</para>
|
||||
<para>An HTML <quote>pretty printer</quote>, used to
|
||||
reformat some of the automatically generated HTML so
|
||||
that it is easier to follow.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
|
@ -130,9 +135,10 @@
|
|||
(<filename role="package">graphics/peps</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>Some of the documentation includes images, some of which are
|
||||
stored as EPS files. These must be converted to PNG before most
|
||||
web browsers will display them.</para>
|
||||
<para>Some of the documentation includes images, some of
|
||||
which are stored as EPS files. These must be converted
|
||||
to PNG before most web browsers will display
|
||||
them.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
|
@ -141,37 +147,44 @@
|
|||
<sect2>
|
||||
<title>DTDs and Entities</title>
|
||||
|
||||
<para>These are the DTDs and entity sets used by the FDP. They need to
|
||||
be installed before you can work with any of the documentation.</para>
|
||||
<para>These are the DTDs and entity sets used by the FDP. They
|
||||
need to be installed before you can work with any of the
|
||||
documentation.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>HTML DTD (<filename role="package">textproc/html</filename>)</term>
|
||||
<term>HTML DTD (<filename
|
||||
role="package">textproc/html</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>HTML is the markup language of choice for the World Wide
|
||||
Web, and is used throughout the FreeBSD web site.</para>
|
||||
<para>HTML is the markup language of choice for the World
|
||||
Wide Web, and is used throughout the FreeBSD web
|
||||
site.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>DocBook DTD (<filename role="package">textproc/docbook</filename>)</term>
|
||||
<term>DocBook DTD (<filename
|
||||
role="package">textproc/docbook</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>DocBook is designed for marking up technical documentation.
|
||||
All the FreeBSD documentation is written in DocBook.</para>
|
||||
<para>DocBook is designed for marking up technical
|
||||
documentation. All the FreeBSD documentation is written
|
||||
in DocBook.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>ISO 8879 entities
|
||||
(<filename role="package">textproc/iso8879</filename>)</term>
|
||||
(<filename
|
||||
role="package">textproc/iso8879</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>19 of the ISO 8879:1986 character entity sets used by many
|
||||
DTDs. Includes named mathematical symbols, additional
|
||||
characters in the Latin character set (accents, diacriticals,
|
||||
and so on), and Greek symbols.</para>
|
||||
<para>19 of the ISO 8879:1986 character entity sets used
|
||||
by many DTDs. Includes named mathematical symbols,
|
||||
additional characters in the Latin character set
|
||||
(accents, diacriticals, and so on), and Greek
|
||||
symbols.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
|
@ -180,18 +193,20 @@
|
|||
<sect2>
|
||||
<title>Stylesheets</title>
|
||||
|
||||
<para>The stylesheets are used when converting and formatting the
|
||||
documentation for display on screen, printing, and so on.</para>
|
||||
<para>The stylesheets are used when converting and formatting
|
||||
the documentation for display on screen, printing, and so
|
||||
on.</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Modular DocBook Stylesheets
|
||||
(<filename role="package">textproc/dsssl-docbook-modular</filename>)</term>
|
||||
(<filename
|
||||
role="package">textproc/dsssl-docbook-modular</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>The Modular DocBook Stylesheets are used when converting
|
||||
documentation marked up in DocBook to other formats, such as
|
||||
HTML or RTF.</para>
|
||||
<para>The Modular DocBook Stylesheets are used when
|
||||
converting documentation marked up in DocBook to other
|
||||
formats, such as HTML or RTF.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
|
@ -201,10 +216,10 @@
|
|||
<sect1 id="tools-optional">
|
||||
<title>Optional Tools</title>
|
||||
|
||||
<para>You do not need to have any of the following installed. However,
|
||||
you may find it easier to work with the documentation if you do, and
|
||||
they may give you more flexibility in the output formats that can be
|
||||
generated.</para>
|
||||
<para>You do not need to have any of the following installed.
|
||||
However, you may find it easier to work with the documentation
|
||||
if you do, and they may give you more flexibility in the output
|
||||
formats that can be generated.</para>
|
||||
|
||||
<sect2>
|
||||
<title>Software</title>
|
||||
|
|
@ -218,18 +233,19 @@
|
|||
|
||||
<listitem>
|
||||
<para><application>Jade</application> and
|
||||
<application>teTeX</application> are used to convert DocBook
|
||||
documents to DVI, Postscript, and PDF formats. The
|
||||
<application>JadeTeX</application> macros are needed in order to
|
||||
do this.</para>
|
||||
<application>teTeX</application> are used to convert
|
||||
DocBook documents to DVI, Postscript, and PDF formats.
|
||||
The <application>JadeTeX</application> macros are needed
|
||||
in order to do this.</para>
|
||||
|
||||
<para>If you do not intend to convert your documentation to one of
|
||||
these formats (i.e., HTML, plain text, and RTF are sufficient)
|
||||
then you do not need to install
|
||||
<para>If you do not intend to convert your documentation
|
||||
to one of these formats (i.e., HTML, plain text, and RTF
|
||||
are sufficient) then you do not need to install
|
||||
<application>JadeTeX</application> and
|
||||
<application>teTeX</application>. This can be a significant
|
||||
space and time saver, as <application>teTeX</application> is
|
||||
over 30MB in size.</para>
|
||||
<application>teTeX</application>. This can be a
|
||||
significant space and time saver, as
|
||||
<application>teTeX</application> is over 30MB in
|
||||
size.</para>
|
||||
|
||||
<important>
|
||||
<para>If you decide to install
|
||||
|
|
@ -237,8 +253,9 @@
|
|||
<application>teTeX</application> then you will need to
|
||||
configure <application>teTeX</application> after
|
||||
<application>JadeTeX</application> has been installed.
|
||||
<filename>print/jadetex/pkg-message</filename> contains
|
||||
detailed instructions explaining what you need to do.</para>
|
||||
<filename>print/jadetex/pkg-message</filename>
|
||||
contains detailed instructions explaining what you
|
||||
need to do.</para>
|
||||
</important>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -250,21 +267,22 @@
|
|||
<filename role="package">editors/xemacs</filename>)</term>
|
||||
|
||||
<listitem>
|
||||
<para>Both these editors include a special mode for editing
|
||||
documents marked up according to an SGML DTD. This mode
|
||||
includes commands to reduce the amount of typing you need, and
|
||||
help reduce the possibility of errors.</para>
|
||||
<para>Both these editors include a special mode for
|
||||
editing documents marked up according to an SGML DTD.
|
||||
This mode includes commands to reduce the amount of
|
||||
typing you need, and help reduce the possibility of
|
||||
errors.</para>
|
||||
|
||||
<para>You do not need to use them; any text editor can be used to
|
||||
edit marked up documents. You may find they make you more
|
||||
efficient.</para>
|
||||
<para>You do not need to use them; any text editor can be
|
||||
used to edit marked up documents. You may find they
|
||||
make you more efficient.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>If anyone has recommendations for other software that is useful
|
||||
when manipulating SGML documents, please let &a.doceng; know, so they
|
||||
can be added to this list.</para>
|
||||
<para>If anyone has recommendations for other software that is
|
||||
useful when manipulating SGML documents, please let &a.doceng;
|
||||
know, so they can be added to this list.</para>
|
||||
</sect2>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
|
|||
Loading…
Reference in a new issue