aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml')
-rw-r--r--en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml40
1 files changed, 20 insertions, 20 deletions
diff --git a/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml
index 0ac3f02504..ef88ad5fd1 100644
--- a/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml
+++ b/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml
@@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.10 2000/01/16 22:05:58 asmodai Exp $
+ $FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.11 2000/02/08 19:39:12 peter Exp $
-->
<chapter id="sgml-markup">
@@ -215,7 +215,7 @@
<para>Use:</para>
- <programlisting><![ CDATA [<p>A small excerpt from the US Constitution;</p>
+ <programlisting><![ CDATA [<p>A small excerpt from the US Constitution:</p>
<blockquote>We the People of the United States, in Order to form
a more perfect Union, establish Justice, insure domestic
@@ -233,7 +233,7 @@
unordered, and definition.</para>
<para>Typically, each entry in an ordered list will be numbered, while
- each entry in an unordered list will be proceeded by a bullet point.
+ each entry in an unordered list will be preceded by a bullet point.
Definition lists are composed of two sections for each entry. The
first section is the term being defined, and the second section is
the definition of the term.</para>
@@ -476,7 +476,7 @@
<para>Typically, <sgmltag>em</sgmltag> is rendered in italic and
<sgmltag>strong</sgmltag> is rendered in bold. This is not always
- the case however, and you should not rely on it.</para>
+ the case, however, and you should not rely on it.</para>
<example>
<title><sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag></title>
@@ -661,7 +661,7 @@
<para>DocBook was designed by the <ulink
url="http://www.oreilly.com/davenport/">Davenport Group</ulink> to be
a DTD for writing technical documentation. As such, and unlike LinuxDoc
- and HTML, DocBook is very heavily orientated towards markup that
+ and HTML, DocBook is very heavily oriented towards markup that
describes <emphasis>what</emphasis> something is, rather than describing
<emphasis>how</emphasis> it should be presented.</para>
@@ -724,7 +724,7 @@
<para>DocBook allows you to structure your documentation in several
ways. In the FreeBSD Documentation Project we are using two primary
- types of DocBook document, the book, and the article.</para>
+ types of DocBook document: the book and the article.</para>
<para>A book is organised into <sgmltag>chapter</sgmltag>s. This is a
mandatory requirement. There may be <sgmltag>part</sgmltag>s between
@@ -747,9 +747,9 @@
<para>Obviously, you should consider the nature of the documentation you
are writing in order to decide whether it is best marked up as a book
or an article. Articles are well suited to information that does not
- need to be broken down in to several chapters, and that is, relatively
+ need to be broken down into several chapters, and that is, relatively
speaking, quite short, at up to 20-25 pages of content. Books are
- best suited to information that can be broken up in to several
+ best suited to information that can be broken up into several
chapters, possibly with appendices and similar content as well.</para>
<para>The <ulink url="http://www.FreeBSD.org/tutorials/">FreeBSD
@@ -877,7 +877,7 @@
</chapter>]]></programlisting>
</example>
- <para>A chapter can not be empty, it must contain elements in addition
+ <para>A chapter cannot be empty; it must contain elements in addition
to <sgmltag>title</sgmltag>. If you need to include an empty
chapter then just use an empty paragraph.</para>
@@ -957,7 +957,7 @@
<para>You can introduce another layer of organisation between
<sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with one or
- more <sgmltag>part</sgmltag>s. This can not be done in an
+ more <sgmltag>part</sgmltag>s. This cannot be done in an
<sgmltag>article</sgmltag>.</para>
<programlisting><![ CDATA [<part>
@@ -990,7 +990,7 @@
<sect3>
<title>Paragraphs</title>
- <para>DocBook supports three types of paragraphs;
+ <para>DocBook supports three types of paragraphs:
<sgmltag>formalpara</sgmltag>, <sgmltag>para</sgmltag>, and
<sgmltag>simpara</sgmltag>.</para>
@@ -1134,12 +1134,12 @@
</para>
<para><sgmltag>itemizedlist</sgmltag> and
- <sgmltag>orderedlist</sgmltag> are similar to the counterparts in
+ <sgmltag>orderedlist</sgmltag> are similar to their counterparts in
HTML, <sgmltag>ul</sgmltag> and <sgmltag>ol</sgmltag>. Each one
consists of one or more <sgmltag>listitem</sgmltag> elements, and
each <sgmltag>listitem</sgmltag> contains one or more block
elements. The <sgmltag>listitem</sgmltag> elements are analagous to
- HTMLs <sgmltag>li</sgmltag> tags. However, unlike HTML they are
+ HTML's <sgmltag>li</sgmltag> tags. However, unlike HTML, they are
required.</para>
<para><sgmltag>procedure</sgmltag> is slightly different. It consists
@@ -1542,21 +1542,21 @@ This is the file called 'foo2'</screen>
<para>You will frequently want to refer to both applications and
commands when writing for the Handbook. The distinction between
- them is simple; an application is the name for a suite (or possibly
+ them is simple: an application is the name for a suite (or possibly
just 1) of programs that fulfil a particular task. A command is the
name of a program that the user can run.</para>
<para>In addition, you will occasionally need to list one or more of
the options that a command might take.</para>
- <para>Finally, you will often want to list a command with it's manual
+ <para>Finally, you will often want to list a command with its manual
section number, in the &ldquo;command(number)&rdquo; format so
common in Unix manuals.</para>
<para>Mark up application names with
<sgmltag>application</sgmltag>.</para>
- <para>When you want to list a command with it's manual section number
+ <para>When you want to list a command with its manual section number
(which should be most of the time) the DocBook element is
<sgmltag>citerefentry</sgmltag>. This will contain a further two
elements, <sgmltag>refentrytitle</sgmltag> and
@@ -1572,12 +1572,12 @@ This is the file called 'foo2'</screen>
<para>The file that contains these entities is in
<filename>doc/share/sgml/man-refs.ent</filename>, and can be
- referred to using this FPI;</para>
+ referred to using this FPI:</para>
<programlisting>PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"</programlisting>
<para>Therefore, the introduction to your documentation will probably
- look like this;</para>
+ look like this:</para>
<programlisting>&lt;!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
@@ -2108,7 +2108,7 @@ This is the file called 'foo2'</screen>
<para>Both of these elements have a <literal>linkend</literal>
attribute. The value of this attribute should be the value that you
have used in a <literal>id</literal> attribute (it does not matter
- if that value has not yet occured in your document, this will work
+ if that value has not yet occurred in your document; this will work
for forward links as well as backward links).</para>
<para>If you use <sgmltag>xref</sgmltag> then you have no control over
@@ -2229,7 +2229,7 @@ This is the file called 'foo2'</screen>
<title>* LinuxDoc</title>
<para>LinuxDoc is an adaptation of the QWERTZ DTD, first adopted by the
- <ulink url="http://sunsite.unc.edu/LDP/">Linux Documentation
+ <ulink url="http://www.linuxdoc.org/">Linux Documentation
Project</ulink>, and subsequently adopted by the FreeBSD Documentation
Project.</para>