A few more simplifications and corrections to the structure chapter.

This commit is contained in:
Warren Block 2013-07-18 00:49:59 +00:00
parent 27144d9f43
commit 6384cc8971
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=42311

View file

@ -56,7 +56,7 @@
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>In addition, the documentation tree has to accommodate <para>In addition, the documentation tree must accommodate
documents in many different languages and encodings. It is documents in many different languages and encodings. It is
important that the documentation tree structure does not enforce important that the documentation tree structure does not enforce
any particular defaults or cultural preferences.</para> any particular defaults or cultural preferences.</para>
@ -172,7 +172,7 @@
<para>Not every <filename <para>Not every <filename
class="directory"><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename> class="directory"><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
directory will contain all of these subdirectories. It depends directory will have all of these subdirectories. It depends
on how much translation has been accomplished by that on how much translation has been accomplished by that
translation team.</para> translation team.</para>
</sect1> </sect1>
@ -189,7 +189,7 @@
<subtitle><filename>books/handbook/</filename></subtitle> <subtitle><filename>books/handbook/</filename></subtitle>
<para>The Handbook is written in DocBook <acronym>XML</acronym> <para>The Handbook is written in DocBook <acronym>XML</acronym>
using the &os; DocBook extended DTD.</para> using the &os; DocBook extended <acronym>DTD</acronym>.</para>
<para>The Handbook is organized as a DocBook <para>The Handbook is organized as a DocBook
<sgmltag>book</sgmltag>. The book is divided into <sgmltag>book</sgmltag>. The book is divided into
@ -264,7 +264,7 @@
<para>Then it will be called <para>Then it will be called
<filename>chapter.xml</filename> in the <filename>chapter.xml</filename> in the
<filename>kernelconfig</filename> directory. In general, <filename>kernelconfig</filename> directory. In general,
the entire contents of the chapter will be held in this the entire contents of the chapter are in this one
file.</para> file.</para>
<para>When the <acronym>XHTML</acronym> version of the <para>When the <acronym>XHTML</acronym> version of the
@ -281,9 +281,9 @@
to include images in each chapter. Images for each to include images in each chapter. Images for each
Handbook chapter are stored within <filename Handbook chapter are stored within <filename
class="directory">share/images/books/handbook</filename>. class="directory">share/images/books/handbook</filename>.
Note that the localized version of these images should be The localized version of these images should be
placed in the same directory as the <acronym>XML</acronym> placed in the same directory as the <acronym>XML</acronym>
sources for each chapter. Namespace collisions would be sources for each chapter. Namespace collisions are
inevitable, and it is easier to work with several inevitable, and it is easier to work with several
directories with a few files in them than it is to work directories with a few files in them than it is to work
with one directory that has many files in it.</para> with one directory that has many files in it.</para>