Properly wrap line that were too long.

This commit is contained in:
Benedict Reuschling 2018-08-17 14:09:05 +00:00
parent 926e23e357
commit 2d56e7a3e4
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=52148

View file

@ -29,7 +29,9 @@
POSSIBILITY OF SUCH DAMAGE.
-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="structure">
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="structure">
<title>Documentation Directory Structure</title>
<para>Files and directories in the
@ -86,10 +88,10 @@
Contains subdirectories to further categorize the
information. For example, the files that comprise the
&man.make.1; infrastructure are in
<filename>share/mk</filename>, while
the additional <acronym>XML</acronym> support files
(such as the &os; extended DocBook
<acronym>DTD</acronym>) are in <filename>share/xml</filename>.</entry>
<filename>share/mk</filename>, while the additional
<acronym>XML</acronym> support files (such as the &os;
extended DocBook <acronym>DTD</acronym>) are in
<filename>share/xml</filename>.</entry>
</row>
<row>
@ -158,8 +160,8 @@
<filename>man</filename></entry>
<entry>For translations of the system manual pages. This
directory will contain one or more
<filename role="directory">man<replaceable>N</replaceable></filename>
directory will contain one or more <filename
role="directory">man<replaceable>N</replaceable></filename>
directories, corresponding to the sections that have
been translated.</entry>
</row>
@ -167,10 +169,11 @@
</tgroup>
</informaltable>
<para>Not every <filename role="directory"><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
directory will have all of these subdirectories. It depends
on how much translation has been accomplished by that
translation team.</para>
<para>Not every <filename
role="directory"><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
directory will have all of these subdirectories. It depends on
how much translation has been accomplished by that translation
team.</para>
</sect1>
<sect1 xml:id="structure-document">
@ -204,8 +207,8 @@
<note>
<para>The Handbook's organization may change over time, and
this document may lag in detailing the organizational
changes. Post questions about Handbook organization to the
&a.doc;.</para>
changes. Post questions about Handbook organization to
the &a.doc;.</para>
</note>
<sect4 xml:id="structure-document-handbook-physical-Makefile">
@ -224,21 +227,25 @@
<title><filename>book.xml</filename></title>
<para>This is the top level document in the Handbook. It
contains the Handbook's <link linkend="xml-primer-doctype-declaration">DOCTYPE
contains the Handbook's <link
linkend="xml-primer-doctype-declaration">DOCTYPE
declaration</link>, as well as the elements that
describe the Handbook's structure.</para>
<para><filename>book.xml</filename> uses <link linkend="xml-primer-parameter-entities">parameter
<para><filename>book.xml</filename> uses <link
linkend="xml-primer-parameter-entities">parameter
entities</link> to load in the files with the
<filename>.ent</filename> extension. These files
(described later) then define <link linkend="xml-primer-general-entities">general
(described later) then define <link
linkend="xml-primer-general-entities">general
entities</link> that are used throughout the rest of the
Handbook.</para>
</sect4>
<sect4
xml:id="structure-document-handbook-physical-chapters-xml">
<title><filename role="directory"><replaceable>directory</replaceable>/chapter.xml</filename></title>
<title><filename
role="directory"><replaceable>directory</replaceable>/chapter.xml</filename></title>
<para>Each chapter in the Handbook is stored in a file
called <filename>chapter.xml</filename> in a separate
@ -270,15 +277,16 @@
stored in the same directory as
<filename>book.xml</filename>, and named after the value
of the <literal>id</literal> attribute on the file's
<tag>chapter</tag> element. Now, it is possible
to include images in each chapter. Images for each
Handbook chapter are stored within <filename>share/images/books/handbook</filename>.
The localized version of these images should be
placed in the same directory as the <acronym>XML</acronym>
sources for each chapter. Namespace collisions are
inevitable, and it is easier to work with several
directories with a few files in them than it is to work
with one directory that has many files in it.</para>
<tag>chapter</tag> element. Now, it is possible to
include images in each chapter. Images for each Handbook
chapter are stored within
<filename>share/images/books/handbook</filename>. The
localized version of these images should be placed in the
same directory as the <acronym>XML</acronym> sources for
each chapter. Namespace collisions are inevitable, and it
is easier to work with several directories with a few
files in them than it is to work with one directory that
has many files in it.</para>
<para>A brief look will show that there are many directories
with individual <filename>chapter.xml</filename> files,