os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

- Fix capitalization according to the "headline style" of Chicago Manual

Browse source 
of Style (15th Edition), paragraph 8.167

Reviewed by:	gabor, manolis, rene
This commit is contained in:
Gabor Pali 2008-12-06 21:54:40 +00:00
parent c4921bfc91
commit 4bd036779d
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=33363
1 changed files with 75 additions and 75 deletions

150
en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
View file

@ -50,7 +50,7 @@
content, please post it to the &a.doc;.</para>
<note>
<title>Inline vs. block</title>
<title>Inline vs. Block</title>
<para>In the remainder of this document, when describing elements,
<emphasis>inline</emphasis> means that the element can occur within a
@ -96,7 +96,7 @@
</sect2>
<sect2>
<title>Sectional elements</title>
<title>Sectional Elements</title>
<para>An HTML document is normally split into two sections. The first
section, called the <emphasis>head</emphasis>, contains
@ -110,11 +110,11 @@
contained within the top-level <sgmltag>html</sgmltag> element.</para>
<example>
<title>Normal HTML document structure</title>
<title>Normal HTML Document Structure</title>
<programlisting>&lt;html>
&lt;head>
&lt;title><replaceable>The document's title</replaceable>&lt;/title>
&lt;title><replaceable>The Document's Title</replaceable>&lt;/title>
&lt;/head>
&lt;body>
@ -127,7 +127,7 @@
</sect2>
<sect2>
<title>Block elements</title>
<title>Block Elements</title>
<sect3>
<title>Headings</title>
@ -204,7 +204,7 @@
</sect3>
<sect3>
<title>Block quotations</title>
<title>Block Quotations</title>
<para>A block quotation is an extended quotation from another document
that should not appear within the current paragraph.</para>
@ -285,7 +285,7 @@
</example>
<example>
<title>Definition lists with <sgmltag>dl</sgmltag></title>
<title>Definition Lists with <sgmltag>dl</sgmltag></title>
<para>Use:</para>
@ -308,7 +308,7 @@
</sect3>
<sect3>
<title>Pre-formatted text</title>
<title>Pre-formatted Text</title>
<para>You can indicate that text should be shown to the user exactly
as it is in the file. Typically, this means that the text is shown
@ -370,7 +370,7 @@
<sgmltag>p</sgmltag> element.</para>
<example>
<title>Simple use of <sgmltag>table</sgmltag></title>
<title>Simple Use of <sgmltag>table</sgmltag></title>
<para>Use:</para>
@ -473,10 +473,10 @@
</sect2>
<sect2>
<title>In-line elements</title>
<title>In-line Elements</title>
<sect3>
<title>Emphasizing information</title>
<title>Emphasizing Information</title>
<para>You have two levels of emphasis available in HTML,
<sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag>.
@ -498,7 +498,7 @@
</sect3>
<sect3>
<title>Bold and italics</title>
<title>Bold and Italics</title>
<para>Because HTML includes presentational markup, you can also
indicate that particular content should be rendered in bold or
@ -514,7 +514,7 @@
</sect3>
<sect3>
<title>Indicating fixed pitch text</title>
<title>Indicating Fixed-Pitch Text</title>
<para>If you have content that should be rendered in a fixed pitch
(typewriter) typeface, use <sgmltag>tt</sgmltag> (for
@ -532,7 +532,7 @@
</sect3>
<sect3>
<title>Content size</title>
<title>Content Size</title>
<para>You can indicate that content should be shown in a larger or
smaller font. There are three ways of doing this.</para>
@ -586,7 +586,7 @@
</note>
<sect3>
<title>Linking to other documents on the WWW</title>
<title>Linking to Other Documents on the WWW</title>
<para>In order to include a link to another document on the WWW you
must know the URL of the document you want to link to.</para>
@ -612,7 +612,7 @@
</sect3>
<sect3>
<title>Linking to other parts of documents</title>
<title>Linking to Other Parts of Documents</title>
<para>Linking to a point within another document (or within the same
document) requires that the document author include anchors that you
@ -636,7 +636,7 @@
<literal>#</literal> symbol.</para>
<example>
<title>Linking to a named part of another document</title>
<title>Linking to A Named Part of Another Document</title>
<para>Assume that the <literal>para1</literal> example resides in a
document called <filename>foo.html</filename>.</para>
@ -651,7 +651,7 @@
the anchor (with the preceding <literal>#</literal>).</para>
<example>
<title>Linking to a named part of the same document</title>
<title>Linking to A Named Part of the Same Document</title>
<para>Assume that the <literal>para1</literal> example resides in
this document:</para>
@ -680,7 +680,7 @@
<emphasis>how</emphasis> it should be presented.</para>
<note>
<title><literal>formal</literal> vs. <literal>informal</literal></title>
<title>Formal vs. Informal</title>
<para>Some elements may exist in two forms, <emphasis>formal</emphasis>
and <emphasis>informal</emphasis>. Typically, the formal version of
@ -695,7 +695,7 @@
port.</para>
<sect2>
<title>FreeBSD extensions</title>
<title>&os; Extensions</title>
<para>The FreeBSD Documentation Project has extended the DocBook DTD by
adding some new elements. These elements serve to make some of the
@ -733,7 +733,7 @@
</sect2>
<sect2>
<title>Document structure</title>
<title>Document Structure</title>
<para>DocBook allows you to structure your documentation in several
ways. In the FreeBSD Documentation Project we are using two primary
@ -773,7 +773,7 @@
all marked up as books.</para>
<sect3>
<title>Starting a book</title>
<title>Starting a Book</title>
<para>The content of the book is contained within the
<sgmltag>book</sgmltag> element. As well as containing structural
@ -793,7 +793,7 @@
replaceable elements -->
<programlisting>&lt;book>
&lt;bookinfo>
&lt;title><replaceable>Your title here</replaceable>&lt;/title>
&lt;title><replaceable>Your Title Here</replaceable>&lt;/title>
&lt;author>
&lt;firstname><replaceable>Your first name</replaceable>&lt;/firstname>
@ -822,7 +822,7 @@
</sect3>
<sect3>
<title>Starting an article</title>
<title>Starting an Article</title>
<para>The content of the article is contained within the
<sgmltag>article</sgmltag> element. As well as containing
@ -870,17 +870,17 @@
</example>
</sect3>
<sect3>
<title>Indicating chapters</title>
<title>Indicating Chapters</title>
<para>Use <sgmltag>chapter</sgmltag> to mark up your chapters. Each
chapter has a mandatory <sgmltag>title</sgmltag>. Articles do not
contain chapters, they are reserved for books.</para>
<example>
<title>A simple chapter</title>
<title>A Simple Chapter</title>
<programlisting><![ CDATA [<chapter>
<title>The chapter's title</title>
<title>The Chapter's Title</title>
...
</chapter>]]></programlisting>
@ -891,10 +891,10 @@
chapter then just use an empty paragraph.</para>
<example>
<title>Empty chapters</title>
<title>Empty Ehapters</title>
<programlisting><![ CDATA [<chapter>
<title>This is an empty chapter</title>
<title>This is An Empty Chapter</title>
<para></para>
</chapter>]]></programlisting>
@ -902,7 +902,7 @@
</sect3>
<sect3>
<title>Sections below chapters</title>
<title>Sections Below Chapters</title>
<para>In books, chapters may (but do not need to) be broken up into
sections, subsections, and so on. In articles, sections are the
@ -918,34 +918,34 @@
elements, and so on, down to <sgmltag>sect5</sgmltag>.</para>
<example>
<title>Sections in chapters</title>
<title>Sections in Chapters</title>
<programlisting><![ RCDATA [<chapter>
<title>A sample chapter</title>
<title>A Sample Chapter</title>
<para>Some text in the chapter.</para>
<sect1>
<title>First section (1.1)</title>
<title>First Section (1.1)</title>
&hellip;
</sect1>
<sect1>
<title>Second section (1.2)</title>
<title>Second Section (1.2)</title>
<sect2>
<title>First sub-section (1.2.1)</title>
<title>First Sub-Section (1.2.1)</title>
<sect3>
<title>First sub-sub-section (1.2.1.1)</title>
<title>First Sub-Sub-Section (1.2.1.1)</title>
&hellip;
</sect3>
</sect2>
<sect2>
<title>Second sub-section (1.2.2)</title>
<title>Second Sub-Section (1.2.2)</title>
&hellip;
</sect2>
@ -962,7 +962,7 @@
</sect3>
<sect3>
<title>Subdividing using <sgmltag>part</sgmltag>s</title>
<title>Subdividing Using <sgmltag>part</sgmltag> Elements</title>
<para>You can introduce another layer of organization between
<sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with one or
@ -994,7 +994,7 @@
</sect2>
<sect2>
<title>Block elements</title>
<title>Block Elements</title>
<sect3>
<title>Paragraphs</title>
@ -1025,7 +1025,7 @@
</sect3>
<sect3>
<title>Block quotations</title>
<title>Block Quotations</title>
<para>A block quotation is an extended quotation from another document
that should not appear within the current paragraph. You will
@ -1071,8 +1071,8 @@
</sect3>
<sect3>
<title>Tips, notes, warnings, cautions, important information and
sidebars.</title>
<title>Tips, Notes, Warnings, Cautions, Important Information and
Sidebars</title>
<para>You may need to include extra information separate from the
main body of the text. Typically this is <quote>meta</quote>
@ -1128,7 +1128,7 @@
</sect3>
<sect3>
<title>Lists and procedures</title>
<title>Lists and Procedures</title>
<para>You will often need to list pieces of information to the user,
or present them with a number of steps that must be carried out in
@ -1238,7 +1238,7 @@
</sect3>
<sect3>
<title>Showing file samples</title>
<title>Showing File Samples</title>
<para>If you want to show a fragment of a file (or perhaps a complete
file) to the user, wrap it in the <sgmltag>programlisting</sgmltag>
@ -1394,8 +1394,8 @@ main(void)
<tgroup cols="2">
<thead>
<row>
<entry>This is column head 1</entry>
<entry>This is column head 2</entry>
<entry>This is Column Head 1</entry>
<entry>This is Column Head 2</entry>
</row>
</thead>
@ -1419,8 +1419,8 @@ main(void)
<tgroup cols="2">
<thead>
<row>
<entry>This is column head 1</entry>
<entry>This is column head 2</entry>
<entry>This is Column Head 1</entry>
<entry>This is Column Head 2</entry>
</row>
</thead>
@ -1452,7 +1452,7 @@ main(void)
frame="none"&gt;</literal>).</para>
<example>
<title>Tables where <literal>frame="none"</literal></title>
<title>Tables Where <literal>frame="none"</literal></title>
<para>Appearance:</para>
@ -1460,8 +1460,8 @@ main(void)
<tgroup cols="2">
<thead>
<row>
<entry>This is column head 1</entry>
<entry>This is column head 2</entry>
<entry>This is Column Head 1</entry>
<entry>This is Column Head 2</entry>
</row>
</thead>
@ -1482,7 +1482,7 @@ main(void)
</sect3>
<sect3>
<title>Examples for the user to follow</title>
<title>Examples for the User to Follow</title>
<para>A lot of the time you need to show examples for the user to
follow. Typically, these will consist of dialogs with the computer;
@ -1586,10 +1586,10 @@ This is the file called 'foo2'</screen>
</sect2>
<sect2>
<title>In-line elements</title>
<title>In-line Elements</title>
<sect3>
<title>Emphasizing information</title>
<title>Emphasizing Information</title>
<para>When you want to emphasize a particular word or phrase, use
<sgmltag>emphasis</sgmltag>. This may be presented as italic, or
@ -1644,7 +1644,7 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>Keys, mouse buttons, and combinations</title>
<title>Keys, Mouse Buttons, and Combinations</title>
<para>To refer to a specific key on the keyboard, use
<sgmltag>keycap</sgmltag>. To refer to a mouse button, use
@ -1665,7 +1665,7 @@ This is the file called 'foo2'</screen>
<sgmltag>keycombo</sgmltag>.</para>
<example>
<title>Keys, mouse buttons, and combinations</title>
<title>Keys, Mouse Buttons, and Combinations</title>
<para>Use:</para>
@ -1700,7 +1700,7 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>Applications, commands, options, and cites</title>
<title>Applications, Commands, Options, and Cites</title>
<para>You will frequently want to refer to both applications and
commands when writing for the Handbook. The distinction between
@ -1769,7 +1769,7 @@ This is the file called 'foo2'</screen>
clear. Hopefully this example makes it clearer.</para>
<example>
<title>Applications, commands, and options.</title>
<title>Applications, Commands, and Options</title>
<para>Use:</para>
@ -1822,7 +1822,7 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>Files, directories, extensions</title>
<title>Files, Directories, Extensions</title>
<para>Whenever you wish to refer to the name of a file, a directory,
or a file extension, use <sgmltag>filename</sgmltag>.</para>
@ -1850,10 +1850,10 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>The name of ports</title>
<title>The Name of Ports</title>
<note>
<title>FreeBSD extension</title>
<title>&os; Extension</title>
<para>These elements are part of the FreeBSD extension to DocBook,
and do not exist in the original DocBook DTD.</para>
@ -1887,7 +1887,7 @@ This is the file called 'foo2'</screen>
<title>Devices</title>
<note>
<title>FreeBSD extension</title>
<title>&os; Extension</title>
<para>These elements are part of the FreeBSD extension to DocBook,
and do not exist in the original DocBook DTD.</para>
@ -1938,10 +1938,10 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>Hosts, domains, IP addresses, and so forth</title>
<title>Hosts, Domains, IP Addresses, and So Forth</title>
<note>
<title>FreeBSD extension</title>
<title>&os; Extension</title>
<para>These elements are part of the FreeBSD extension to DocBook,
and do not exist in the original DocBook DTD.</para>
@ -2076,7 +2076,7 @@ This is the file called 'foo2'</screen>
<title>Usernames</title>
<note>
<title>FreeBSD extension</title>
<title>&os; Extension</title>
<para>These elements are part of the FreeBSD extension to DocBook,
and do not exist in the original DocBook DTD.</para>
@ -2105,7 +2105,7 @@ This is the file called 'foo2'</screen>
<title>Describing <filename>Makefile</filename>s</title>
<note>
<title>FreeBSD extension</title>
<title>&os; Extension</title>
<para>These elements are part of the FreeBSD extension to DocBook,
and do not exist in the original DocBook DTD.</para>
@ -2158,7 +2158,7 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>Literal text</title>
<title>Literal Text</title>
<para>You will often need to include <quote>literal</quote> text in the
Handbook. This is text that is excerpted from another file, or
@ -2249,7 +2249,7 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title>Quoting system errors</title>
<title>Quoting System Errors</title>
<para>You might want to show errors generated by FreeBSD.
Mark these with <sgmltag>errorname</sgmltag>. This
@ -2301,7 +2301,7 @@ This is the file called 'foo2'</screen>
</important>
<sect3>
<title>Image formats</title>
<title>Image Formats</title>
<para>We currently support two formats for images. The format you
should use will depend on the nature of your image.</para>
@ -2423,7 +2423,7 @@ This is the file called 'foo2'</screen>
</sect3>
<sect3>
<title><filename>Makefile</filename> entries</title>
<title><filename>Makefile</filename> Entries</title>
<para>Your images must be listed in the
<filename>Makefile</filename> in the <makevar>IMAGES</makevar>
@ -2453,7 +2453,7 @@ IMAGES+= fig3.png
</sect3>
<sect3>
<title>Images and chapters in subdirectories</title>
<title>Images and Chapters in Subdirectories</title>
<para>You must be careful when you separate your documentation into
smaller files (see <xref linkend="sgml-primer-include-using-gen-entities">) in
@ -2513,7 +2513,7 @@ IMAGES= chapter1/fig1.png
</note>
<sect3>
<title>Linking to other parts of the same document</title>
<title>Linking to Other Parts of the Same Document</title>
<para>Linking within the same document requires you to specify
where you are linking from (i.e., the text the user will click, or
@ -2532,7 +2532,7 @@ IMAGES= chapter1/fig1.png
elements.</para>
<example>
<title><literal>id on chapters and sections</literal></title>
<title>Attribute <literal>id</literal> on Chapters and Sections</title>
<programlisting><![ CDATA [<chapter id="chapter1">
<title>Introduction</title>
@ -2603,7 +2603,7 @@ IMAGES= chapter1/fig1.png
One</emphasis>.</para>
<para>More specific information can be found in <emphasis>the
section called Sub-sect 1</emphasis>.</para>
section called Sub-Sect 1</emphasis>.</para>
</blockquote>
</example>
@ -2665,7 +2665,7 @@ IMAGES= chapter1/fig1.png
</sect3>
<sect3>
<title>Linking to documents on the WWW</title>
<title>Linking to Documents on the WWW</title>
<para>Linking to external documents is much simpler, as long as you
know the URL of the document you want to link to. Use