- Fix title capitalization style
This commit is contained in:
parent
1465320cdf
commit
7c39370311
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=33375
6 changed files with 52 additions and 52 deletions
|
@ -192,7 +192,7 @@ Password:</screen></entry>
|
|||
</sect1>
|
||||
|
||||
<sect1 id="preface-notes">
|
||||
<title>Notes, tips, important information, warnings, and examples</title>
|
||||
<title>Notes, Tips, Important Information, Warnings, and Examples</title>
|
||||
|
||||
<para>Within the text appear notes, warnings, and examples.</para>
|
||||
|
||||
|
@ -220,7 +220,7 @@ Password:</screen></entry>
|
|||
</warning>
|
||||
|
||||
<example>
|
||||
<title>A sample example</title>
|
||||
<title>A Sample Example</title>
|
||||
|
||||
<para>Examples are represented like this, and typically contain
|
||||
examples you should walk through, or show you what the results of a
|
||||
|
|
|
@ -146,7 +146,7 @@
|
|||
</sect1>
|
||||
|
||||
<sect1 id="overview-before">
|
||||
<title>Before you start</title>
|
||||
<title>Before You Start</title>
|
||||
|
||||
<para>This document assumes that you already know:</para>
|
||||
|
||||
|
|
|
@ -172,8 +172,8 @@
|
|||
Leaving gaps in the numbering is to be avoided.</para>
|
||||
|
||||
<example>
|
||||
<title>Bad ordering of
|
||||
<sgmltag>h<replaceable>n</replaceable></sgmltag> elements</title>
|
||||
<title>Bad Ordering of
|
||||
<sgmltag>h<replaceable>n</replaceable></sgmltag> Elements</title>
|
||||
|
||||
<para>Use:</para>
|
||||
|
||||
|
@ -2023,7 +2023,7 @@ This is the file called 'foo2'</screen>
|
|||
</variablelist>
|
||||
|
||||
<example>
|
||||
<title><sgmltag>hostid</sgmltag> and roles</title>
|
||||
<title><sgmltag>hostid</sgmltag> and Roles</title>
|
||||
|
||||
<para>Use:</para>
|
||||
|
||||
|
@ -2190,8 +2190,8 @@ This is the file called 'foo2'</screen>
|
|||
</sect3>
|
||||
|
||||
<sect3>
|
||||
<title>Showing items that the user <emphasis>must</emphasis> fill
|
||||
in</title>
|
||||
<title>Showing Items That the User <emphasis>Must</emphasis> Fill
|
||||
In</title>
|
||||
|
||||
<para>There will often be times when you want to show the user what to
|
||||
do, or refer to a file, or command line, or similar, where the user
|
||||
|
|
|
@ -157,7 +157,7 @@
|
|||
</sect1>
|
||||
|
||||
<sect1 id="sgml-primer-elements">
|
||||
<title>Elements, tags, and attributes</title>
|
||||
<title>Elements, Tags, and Attributes</title>
|
||||
|
||||
<para>All the DTDs written in SGML share certain characteristics. This is
|
||||
hardly surprising, as the philosophy behind SGML will inevitably show
|
||||
|
@ -209,7 +209,7 @@
|
|||
<sgmltag>/<replaceable>element-name</replaceable></sgmltag>.</para>
|
||||
|
||||
<example>
|
||||
<title>Using an element (start and end tags)</title>
|
||||
<title>Using an Element (Start and End Tags)</title>
|
||||
|
||||
<para>HTML has an element for indicating that the content enclosed by
|
||||
the element is a paragraph, called <sgmltag>p</sgmltag>. This
|
||||
|
@ -228,7 +228,7 @@
|
|||
the start tag is required for this element.</para>
|
||||
|
||||
<example>
|
||||
<title>Using an element (start tag only)</title>
|
||||
<title>Using an Element (Start Tag Only)</title>
|
||||
|
||||
<para>HTML has an element for indicating a horizontal rule, called
|
||||
<sgmltag>hr</sgmltag>. This element does not wrap content, so only
|
||||
|
@ -248,7 +248,7 @@
|
|||
on.</para>
|
||||
|
||||
<example>
|
||||
<title>Elements within elements; <sgmltag>em</sgmltag></title>
|
||||
<title>Elements within Elements; <sgmltag>em</sgmltag></title>
|
||||
|
||||
<programlisting><![ CDATA [<p>This is a simple <em>paragraph</em> where some
|
||||
of the <em>words</em> have been <em>emphasized</em>.</p>]]></programlisting>
|
||||
|
@ -298,7 +298,7 @@
|
|||
<literal>left</literal>.</para>
|
||||
|
||||
<example>
|
||||
<title>Using an element with an attribute</title>
|
||||
<title>Using An Element with An Attribute</title>
|
||||
|
||||
<programlisting><![ CDATA [<p align="left">The inclusion of the align attribute
|
||||
on this paragraph was superfluous, since the default is left.</p>
|
||||
|
@ -313,7 +313,7 @@
|
|||
the attribute value.</para>
|
||||
|
||||
<example>
|
||||
<title>Single quotes around attributes</title>
|
||||
<title>Single Quotes Around Attributes</title>
|
||||
|
||||
<programlisting><![ CDATA [<p align='right'>I am on the right!</p>]]></programlisting>
|
||||
</example>
|
||||
|
@ -332,7 +332,7 @@
|
|||
catalog files.</para>
|
||||
|
||||
<sect2>
|
||||
<title>For you to do…</title>
|
||||
<title>For You to Do…</title>
|
||||
|
||||
<para>In order to run the examples in this document you will need to
|
||||
install some software on your system and ensure that an environment
|
||||
|
@ -356,7 +356,7 @@
|
|||
|
||||
<example id="sgml-primer-envars">
|
||||
<title><filename>.profile</filename>, for &man.sh.1; and
|
||||
&man.bash.1; users</title>
|
||||
&man.bash.1; Users</title>
|
||||
|
||||
<programlisting>SGML_ROOT=/usr/local/share/sgml
|
||||
SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog
|
||||
|
@ -370,7 +370,7 @@ export SGML_CATALOG_FILES</programlisting>
|
|||
|
||||
<example>
|
||||
<title><filename>.cshrc</filename>, for &man.csh.1; and
|
||||
&man.tcsh.1; users</title>
|
||||
&man.tcsh.1; Users</title>
|
||||
|
||||
<programlisting>setenv SGML_ROOT /usr/local/share/sgml
|
||||
setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog
|
||||
|
@ -395,7 +395,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<title>An example HTML file</title>
|
||||
<title>An Example HTML File</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
@ -526,7 +526,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect1>
|
||||
|
||||
<sect1 id="sgml-primer-doctype-declaration">
|
||||
<title>The DOCTYPE declaration</title>
|
||||
<title>The DOCTYPE Declaration</title>
|
||||
|
||||
<para>The beginning of each document that you write must specify the name
|
||||
of the DTD that the document conforms to. This is so that SGML parsers
|
||||
|
@ -692,7 +692,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</variablelist>
|
||||
|
||||
<sect3>
|
||||
<title><filename>catalog</filename> files</title>
|
||||
<title><filename>catalog</filename> Files</title>
|
||||
|
||||
<para>If you use the syntax above and process this document
|
||||
using an SGML processor, the processor will need to have some way of
|
||||
|
@ -779,7 +779,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect1>
|
||||
|
||||
<sect1 id="sgml-primer-sgml-escape">
|
||||
<title>Escaping back to SGML</title>
|
||||
<title>Escaping Back to SGML</title>
|
||||
|
||||
<para>As mentioned earlier, SGML is only used when writing a
|
||||
DTD. This is not strictly true. There is certain SGML syntax that you
|
||||
|
@ -814,7 +814,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
opens a comment, and the second closes it.</para>
|
||||
|
||||
<example>
|
||||
<title>SGML generic comment</title>
|
||||
<title>SGML Generic Comment</title>
|
||||
|
||||
<programlisting><!-- test comment --></programlisting>
|
||||
|
||||
|
@ -832,7 +832,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
|
||||
<![ %output.print; [
|
||||
<important>
|
||||
<title>Use 2 dashes</title>
|
||||
<title>Use 2 Dashes</title>
|
||||
|
||||
<para>There is a problem with producing the Postscript and PDF versions
|
||||
of this document. The above example probably shows just one hyphen
|
||||
|
@ -861,7 +861,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
will reject documents that make that error.</para>
|
||||
|
||||
<example>
|
||||
<title>Erroneous SGML comments</title>
|
||||
<title>Erroneous SGML Comments</title>
|
||||
|
||||
<programlisting><![ CDATA [
|
||||
<!-- This is in the comment --
|
||||
|
@ -889,7 +889,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</example>
|
||||
|
||||
<sect2>
|
||||
<title>For you to do…</title>
|
||||
<title>For You to Do…</title>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
|
@ -964,7 +964,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
declaration.</para>
|
||||
|
||||
<example>
|
||||
<title>Defining general entities</title>
|
||||
<title>Defining General Entities</title>
|
||||
|
||||
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
|
||||
<!ENTITY current.version "3.0-RELEASE">
|
||||
|
@ -982,7 +982,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect2>
|
||||
|
||||
<sect2 id="sgml-primer-parameter-entities">
|
||||
<title>Parameter entities</title>
|
||||
<title>Parameter Entities</title>
|
||||
|
||||
<para>Like <link linkend="sgml-primer-general-entities">general
|
||||
entities</link>, parameter entities are used to assign names to
|
||||
|
@ -1003,7 +1003,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
entity.</para>
|
||||
|
||||
<example>
|
||||
<title>Defining parameter entities</title>
|
||||
<title>Defining Parameter Entities</title>
|
||||
|
||||
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
|
||||
<!ENTITY % param.some "some">
|
||||
|
@ -1018,7 +1018,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>For you to do…</title>
|
||||
<title>For You to Do…</title>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
|
@ -1031,7 +1031,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<title>An example HTML file</title>
|
||||
<title>An Example HTML File</title>
|
||||
</head>
|
||||
|
||||
<!-- You might well have some comments in here as well -->
|
||||
|
@ -1098,7 +1098,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect1>
|
||||
|
||||
<sect1 id="sgml-primer-include">
|
||||
<title>Using entities to include files</title>
|
||||
<title>Using Entities to Include Files</title>
|
||||
|
||||
<para>Entities (both <link
|
||||
linkend="sgml-primer-general-entities">general</link> and <link
|
||||
|
@ -1106,7 +1106,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
particularly useful when used to include one file inside another.</para>
|
||||
|
||||
<sect2 id="sgml-primer-include-using-gen-entities">
|
||||
<title>Using general entities to include files</title>
|
||||
<title>Using General Entities to Include Files</title>
|
||||
|
||||
<para>Suppose you have some content for an SGML book organized into
|
||||
files, one file per chapter, called
|
||||
|
@ -1121,7 +1121,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
the value of the entity.</para>
|
||||
|
||||
<example>
|
||||
<title>Using general entities to include files</title>
|
||||
<title>Using General Entities to Include Files</title>
|
||||
|
||||
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
|
||||
<!ENTITY chapter.1 SYSTEM "chapter1.sgml">
|
||||
|
@ -1150,7 +1150,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>Using parameter entities to include files</title>
|
||||
<title>Using Parameter Entities to Include Files</title>
|
||||
|
||||
<para>Recall that parameter entities can only be used inside an SGML
|
||||
context. Why then would you want to include a file within an SGML
|
||||
|
@ -1171,7 +1171,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
document.</para>
|
||||
|
||||
<example>
|
||||
<title>Using parameter entities to include files</title>
|
||||
<title>Using Parameter Entities to Include Files</title>
|
||||
|
||||
<para>First, place your entity definitions in a separate file, called
|
||||
<filename>chapters.ent</filename>. This file contains the
|
||||
|
@ -1203,10 +1203,10 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>For you to do…</title>
|
||||
<title>For You to Do…</title>
|
||||
|
||||
<sect3>
|
||||
<title>Use general entities to include files</title>
|
||||
<title>Use General Entities to Include Files</title>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
|
@ -1232,7 +1232,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<title>An example HTML file</title>
|
||||
<title>An Example HTML File</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
@ -1262,7 +1262,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect3>
|
||||
|
||||
<sect3>
|
||||
<title>Use parameter entities to include files</title>
|
||||
<title>Use Parameter Entities to Include Files</title>
|
||||
|
||||
<note>
|
||||
<para>You must have taken the previous steps first.</para>
|
||||
|
@ -1279,7 +1279,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<title>An example HTML file</title>
|
||||
<title>An Example HTML File</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
@ -1321,14 +1321,14 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect1>
|
||||
|
||||
<sect1 id="sgml-primer-marked-sections">
|
||||
<title>Marked sections</title>
|
||||
<title>Marked Sections</title>
|
||||
|
||||
<para>SGML provides a mechanism to indicate that particular pieces of the
|
||||
document should be processed in a special way. These are termed
|
||||
<quote>marked sections</quote>.</para>
|
||||
|
||||
<example>
|
||||
<title>Structure of a marked section</title>
|
||||
<title>Structure of A Marked Section</title>
|
||||
|
||||
<programlisting><![ <replaceable>KEYWORD</replaceable> [
|
||||
Contents of marked section
|
||||
|
@ -1352,7 +1352,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
<literal>></literal>.</para>
|
||||
|
||||
<sect2>
|
||||
<title>Marked section keywords</title>
|
||||
<title>Marked Section Keywords</title>
|
||||
|
||||
<sect3>
|
||||
<title><literal>CDATA</literal>, <literal>RCDATA</literal></title>
|
||||
|
@ -1409,7 +1409,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
<!-- The nesting of CDATA within the next example is disgusting -->
|
||||
|
||||
<example>
|
||||
<title>Using a CDATA marked section</title>
|
||||
<title>Using a <literal>CDATA</literal> Marked Section</title>
|
||||
|
||||
<programlisting><para>Here is an example of how you would include some text
|
||||
that contained many <literal>&lt;</literal>
|
||||
|
@ -1451,7 +1451,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
|
||||
<example>
|
||||
<title>Using <literal>INCLUDE</literal> and
|
||||
<literal>IGNORE</literal> in marked sections</title>
|
||||
<literal>IGNORE</literal> in Marked Sections</title>
|
||||
|
||||
<programlisting><![ INCLUDE [
|
||||
This text will be processed and included.
|
||||
|
@ -1488,8 +1488,8 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
reprocess the document.</para>
|
||||
|
||||
<example>
|
||||
<title>Using a parameter entity to control a marked
|
||||
section</title>
|
||||
<title>Using A Parameter Entity to Control a Marked
|
||||
Section</title>
|
||||
|
||||
<programlisting><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
|
||||
<!ENTITY % electronic.copy "INCLUDE">
|
||||
|
@ -1515,7 +1515,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
|
|||
</sect2>
|
||||
|
||||
<sect2>
|
||||
<title>For you to do…</title>
|
||||
<title>For You to Do…</title>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
|
|
|
@ -70,7 +70,7 @@
|
|||
HTML document without abusing HTML to do so.</para>
|
||||
|
||||
<sect2>
|
||||
<title>The DocBook documents</title>
|
||||
<title>The DocBook Documents</title>
|
||||
|
||||
<para>The FreeBSD DSSSL stylesheets include a reference to a stylesheet,
|
||||
<filename>docbook.css</filename>, which is expected to appear in the
|
||||
|
|
|
@ -47,7 +47,7 @@
|
|||
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
|
||||
|
@ -83,7 +83,7 @@
|
|||
</tip>
|
||||
|
||||
<sect1 id="tools-mandatory">
|
||||
<title>Mandatory tools</title>
|
||||
<title>Mandatory Tools</title>
|
||||
|
||||
<sect2>
|
||||
<title>Software</title>
|
||||
|
@ -199,7 +199,7 @@
|
|||
</sect1>
|
||||
|
||||
<sect1 id="tools-optional">
|
||||
<title>Optional tools</title>
|
||||
<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
|
||||
|
|
Loading…
Reference in a new issue