- Fix style of ordered list
- s/kernelconfiguration/kernelconfig - Fix capitalization of a sentence - Fix title capitalization style
This commit is contained in:
parent
aa8c37005c
commit
e9ad945766
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=33366
1 changed files with 13 additions and 13 deletions
|
@ -31,7 +31,7 @@
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<chapter id="structure">
|
<chapter id="structure">
|
||||||
<title>Structuring documents under <filename>doc/</filename></title>
|
<title>Structuring Documents Under <filename>doc/</filename></title>
|
||||||
|
|
||||||
<para>The <filename>doc/</filename> tree is organized in a particular
|
<para>The <filename>doc/</filename> tree is organized in a particular
|
||||||
fashion, and the documents that are part of the FDP are in turn organized
|
fashion, and the documents that are part of the FDP are in turn organized
|
||||||
|
@ -40,17 +40,17 @@
|
||||||
|
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>make it easy to automate converting the document to other formats;</para>
|
<para>Make it easy to automate converting the document to other formats.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>promote consistency between the different documentation
|
<para>Promote consistency between the different documentation
|
||||||
organizations, to make it easier to switch between working on
|
organizations, to make it easier to switch between working on
|
||||||
different documents;</para>
|
different documents.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>make it easy to decide where in the tree new documentation should
|
<para>Make it easy to decide where in the tree new documentation should
|
||||||
be placed.</para>
|
be placed.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
|
@ -61,7 +61,7 @@
|
||||||
does not enforce any particular defaults or cultural preferences.</para>
|
does not enforce any particular defaults or cultural preferences.</para>
|
||||||
|
|
||||||
<sect1 id="structure-top">
|
<sect1 id="structure-top">
|
||||||
<title>The top level, <filename>doc/</filename></title>
|
<title>The Top Level, <filename>doc/</filename></title>
|
||||||
|
|
||||||
<para>There are two types of directory under <filename>doc/</filename>,
|
<para>There are two types of directory under <filename>doc/</filename>,
|
||||||
each with very specific directory names and meanings.</para>
|
each with very specific directory names and meanings.</para>
|
||||||
|
@ -101,7 +101,7 @@
|
||||||
|
|
||||||
<sect1 id="structure-locale">
|
<sect1 id="structure-locale">
|
||||||
<title>The
|
<title>The
|
||||||
<filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> directories</title>
|
<filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> Directories</title>
|
||||||
|
|
||||||
<para>These directories contain the documents themselves. The
|
<para>These directories contain the documents themselves. The
|
||||||
documentation is split into up to three more categories at this
|
documentation is split into up to three more categories at this
|
||||||
|
@ -147,7 +147,7 @@
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
||||||
<sect1 id="structure-document">
|
<sect1 id="structure-document">
|
||||||
<title>Document specific information</title>
|
<title>Document Specific Information</title>
|
||||||
|
|
||||||
<para>This section contains specific notes about particular documents
|
<para>This section contains specific notes about particular documents
|
||||||
managed by the FDP.</para>
|
managed by the FDP.</para>
|
||||||
|
@ -168,7 +168,7 @@
|
||||||
<sgmltag>sect3</sgmltag>) and so on.</para>
|
<sgmltag>sect3</sgmltag>) and so on.</para>
|
||||||
|
|
||||||
<sect3>
|
<sect3>
|
||||||
<title>Physical organization</title>
|
<title>Physical Organization</title>
|
||||||
|
|
||||||
<para>There are a number of files and directories within the
|
<para>There are a number of files and directories within the
|
||||||
<filename>handbook</filename> directory.</para>
|
<filename>handbook</filename> directory.</para>
|
||||||
|
@ -221,17 +221,17 @@
|
||||||
<para>For example, if one of the chapter files contains:</para>
|
<para>For example, if one of the chapter files contains:</para>
|
||||||
|
|
||||||
<programlisting><![ CDATA [
|
<programlisting><![ CDATA [
|
||||||
<chapter id="kernelconfiguration">
|
<chapter id="kernelconfig">
|
||||||
...
|
...
|
||||||
</chapter>]]></programlisting>
|
</chapter>]]></programlisting>
|
||||||
|
|
||||||
<para>then it will be called <filename>chapter.sgml</filename> in
|
<para>Then it will be called <filename>chapter.sgml</filename> in
|
||||||
the <filename>kernelconfiguration</filename> directory. In
|
the <filename>kernelconfig</filename> directory. In
|
||||||
general, the entire contents of the chapter will be held in this
|
general, the entire contents of the chapter will be held in this
|
||||||
file.</para>
|
file.</para>
|
||||||
|
|
||||||
<para>When the HTML version of the Handbook is produced, this will
|
<para>When the HTML version of the Handbook is produced, this will
|
||||||
yield <filename>kernelconfiguration.html</filename>. This is
|
yield <filename>kernelconfig.html</filename>. This is
|
||||||
because of the <literal>id</literal> value, and is not related to
|
because of the <literal>id</literal> value, and is not related to
|
||||||
the name of the directory.</para>
|
the name of the directory.</para>
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue