aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer
diff options
context:
space:
mode:
authorYaroslav Tykhiy <ytykhiy@gmail.com>2005-09-12 16:47:36 +0000
committerYaroslav Tykhiy <ytykhiy@gmail.com>2005-09-12 16:47:36 +0000
commit9e1d1c15667b6952a9a06f0a67121e3376bb4ccd (patch)
treeee662fc776f0eb80e4700f0c6987174a5d0b1d28 /en_US.ISO8859-1/books/fdp-primer
parent1a445039a6f5bc425463995cabdb7f7b8a56bfbd (diff)
downloaddoc-9e1d1c15667b6952a9a06f0a67121e3376bb4ccd.tar.gz
doc-9e1d1c15667b6952a9a06f0a67121e3376bb4ccd.zip
Except for some rare cases, always use punctuation to finish a
sentence at the end of a paragraph so that the readers don't think that some text is missing. Consistently use colons to finish sentences introductory to examples.
Notes
Notes: svn path=/head/; revision=25615
Diffstat (limited to 'en_US.ISO8859-1/books/fdp-primer')
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml4
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml28
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml44
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml6
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml4
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml8
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml6
7 files changed, 50 insertions, 50 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml
index b171aeddb2..ca0beb0f5e 100644
--- a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.sgml
@@ -422,10 +422,10 @@ PRI_LANG?= en_US.ISO8859-1
<para><maketarget>install</maketarget> and
<maketarget>package</maketarget> both go down the
directory tree calling the real versions of themselves
- in the subdirectories.
+ in the subdirectories
(<maketarget>realinstall</maketarget> and
<maketarget>realpackage</maketarget>
- respectively)</para>
+ respectively).</para>
</listitem>
<listitem>
diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
index 08ef201c3f..cafc9ef65f 100644
--- a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
@@ -322,7 +322,7 @@
<title><sgmltag>pre</sgmltag></title>
<para>You could use <sgmltag>pre</sgmltag> to mark up an e-mail
- message;</para>
+ message:</para>
<programlisting><![ CDATA [<pre> From: nik@FreeBSD.org
To: freebsd-doc@FreeBSD.org
@@ -654,7 +654,7 @@
<title>Linking to a named part of the same document</title>
<para>Assume that the <literal>para1</literal> example resides in
- this document</para>
+ this document:</para>
<programlisting><![ CDATA [<p>More information can be found in the
<a href="#para1">first paragraph</a> of this
@@ -727,7 +727,7 @@
<para>In compliance with the DocBook guidelines for writing FPIs for
DocBook customizations, the FPI for the FreeBSD extended DocBook DTD
- is;</para>
+ is:</para>
<programlisting>PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN"</programlisting>
</sect2>
@@ -1039,7 +1039,7 @@
<para>Use:</para>
- <programlisting><![ CDATA [<para>A small excerpt from the US Constitution;</para>
+ <programlisting><![ CDATA [<para>A small excerpt from the US Constitution:</para>
<blockquote>
<title>Preamble to the Constitution of the United States</title>
@@ -1086,7 +1086,7 @@
use <sgmltag>sidebar</sgmltag>.</para>
<para>The circumstances in which to choose one of these elements over
- another is unclear. The DocBook documentation suggests;</para>
+ another is unclear. The DocBook documentation suggests:</para>
<itemizedlist>
<listitem>
@@ -1274,7 +1274,7 @@ main(void)
<para>Appearance:</para>
<para>When you have finished, your program should look like
- this;</para>
+ this:</para>
<programlisting>#include &lt;stdio.h&gt;
@@ -1306,7 +1306,7 @@ main(void)
<sgmltag>calloutlist</sgmltag></title>
<programlisting><![ CDATA[<para>When you have finished, your program should look like
- this;</para>
+ this:</para>
<programlisting>#include &lt;stdio.h&gt; <co id="co-ex-include">
@@ -1335,7 +1335,7 @@ main(void)
<para>Appearance:</para>
<para>When you have finished, your program should look like
- this;</para>
+ this:</para>
<programlisting>#include &lt;stdio.h&gt; <co id="co-ex-include">
@@ -2477,7 +2477,7 @@ IMAGES+= fig3.png
<para>For example, if you have <filename>chapter1/fig1.png</filename>,
then <filename>chapter1/chapter.sgml</filename> should
- contain</para>
+ contain:</para>
<programlisting>&lt;mediaobject>
&lt;imageobject>
@@ -2491,11 +2491,11 @@ IMAGES+= fig3.png
<calloutlist>
<callout arearefs="co-image-dir">
<para>The directory name must be included in the
- <literal>fileref</literal> attribute</para>
+ <literal>fileref</literal> attribute.</para>
</callout>
</calloutlist>
- <para>The <filename>Makefile</filename> must contain</para>
+ <para>The <filename>Makefile</filename> must contain:</para>
<programlisting>&hellip;
IMAGES= chapter1/fig1.png
@@ -2586,7 +2586,7 @@ IMAGES= chapter1/fig1.png
<title>Using <sgmltag>xref</sgmltag></title>
<para>Assume that this fragment appears somewhere in a document that
- includes the <literal>id</literal> example;</para>
+ includes the <literal>id</literal> example:</para>
<programlisting><![ CDATA [<para>More information can be found
in <xref linkend="chapter1">.</para>
@@ -2596,7 +2596,7 @@ IMAGES= chapter1/fig1.png
<para>The text of the link will be generated automatically, and will
look like (<emphasis>emphasized</emphasis> text indicates the text
- that will be the link);</para>
+ that will be the link):</para>
<blockquote>
<para>More information can be found in <emphasis>Chapter
@@ -2637,7 +2637,7 @@ IMAGES= chapter1/fig1.png
<para>This will generate the following
(<emphasis>emphasized</emphasis> text indicates the text that will
- be the link);</para>
+ be the link):</para>
<blockquote>
<para>More information can be found in <emphasis>the first
diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
index 5ad5d14f44..b126788a0b 100644
--- a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
@@ -96,7 +96,7 @@
document.</para>
<para>The previous example is actually represented in this document like
- this;</para>
+ this:</para>
<programlisting><![ CDATA [
<para>To remove <filename>/tmp/foo</filename> use &man.rm.1;.</para>
@@ -389,7 +389,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA
<procedure>
<step>
<para>Create <filename>example.sgml</filename>, and enter the
- following text;</para>
+ following text:</para>
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
@@ -424,7 +424,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA
see if your document is valid or not.</para>
<para>Use <command>nsgmls</command> to check that your document is
- valid;</para>
+ valid:</para>
<screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput></screen>
@@ -537,7 +537,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
declaration.</para>
<para>A typical declaration for a document written to conform with version
- 4.0 of the HTML DTD looks like this;</para>
+ 4.0 of the HTML DTD looks like this:</para>
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN">]]></programlisting>
@@ -613,7 +613,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</note>
<para>FPIs must follow a specific syntax. This syntax is as
- follows;</para>
+ follows:</para>
<programlisting>"<replaceable>Owner</replaceable>//<replaceable>Keyword</replaceable> <replaceable>Description</replaceable>//<replaceable>Language</replaceable>"</programlisting>
@@ -702,7 +702,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>In order to do this it can use a catalog file. A catalog file
(typically called <filename>catalog</filename>) contains lines that
map FPIs to filenames. For example, if the catalog file contained
- the line;</para>
+ the line:</para>
<programlisting>PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting>
@@ -730,7 +730,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
colon-separated list of catalog files (including their full
path).</para>
- <para>Typically, you will want to include the following files;</para>
+ <para>Typically, you will want to include the following files:</para>
<itemizedlist>
<listitem>
@@ -870,7 +870,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
-- back inside the comment -->]]></programlisting>
- <para>The SGML parser will treat this as though it were actually;</para>
+ <para>The SGML parser will treat this as though it were actually:</para>
<programlisting>&lt;!THIS IS OUTSIDE THE COMMENT&gt;</programlisting>
@@ -894,7 +894,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<procedure>
<step>
<para>Add some comments to <filename>example.sgml</filename>, and
- check that the file still validates using <command>nsgmls</command></para>
+ check that the file still validates using <command>nsgmls</command>.</para>
</step>
<step>
@@ -936,7 +936,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<literal>&amp;<replaceable>entity-name</replaceable>;</literal>. For
example, suppose you had an entity called
<literal>current.version</literal> which expanded to the current
- version number of your product. You could write;</para>
+ version number of your product. You could write:</para>
<programlisting><![ CDATA [<para>The current version of our product is
&current.version;.</para>]]></programlisting>
@@ -953,7 +953,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
it assumes the next text will be the name of an entity.</para>
<para>Fortunately, you can use the two general entities &amp;lt; and
- &amp;amp; whenever you need to include one or other of these </para>
+ &amp;amp; whenever you need to include one or other of these.</para>
<para>A general entity can only be defined within an SGML context.
Typically, this is done immediately after the DOCTYPE
@@ -1045,7 +1045,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step>
<step>
- <para>Validate the document using <command>nsgmls</command></para>
+ <para>Validate the document using <command>nsgmls</command>.</para>
</step>
<step>
@@ -1085,7 +1085,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>If you look at the output from <command>sgmlnorm</command>
you will see that it does not include a DOCTYPE declaration at
the start. To include this you need to use the <option>-d</option>
- option;</para>
+ option:</para>
<screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>
</step>
@@ -1171,7 +1171,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>First, place your entity definitions in a separate file, called
<filename>chapters.ent</filename>. This file contains the
- following;</para>
+ following:</para>
<programlisting><![ CDATA [<!ENTITY chapter.1 SYSTEM "chapter1.sgml">
<!ENTITY chapter.2 SYSTEM "chapter2.sgml">
@@ -1180,7 +1180,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>Now create a parameter entity to refer to the contents of the
file. Then use the parameter entity to load the file into the
document, which will then make all the general entities available
- for use. Then use the general entities as before;</para>
+ for use. Then use the general entities as before:</para>
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!-- Define a parameter entity to load in the chapter general entities -->
@@ -1210,14 +1210,14 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<filename>para2.sgml</filename>, and
<filename>para3.sgml</filename>.</para>
- <para>Put content similar to the following in each file;</para>
+ <para>Put content similar to the following in each file:</para>
<programlisting><![ CDATA [<p>This is the first paragraph.</p>]]></programlisting>
</step>
<step>
<para>Edit <filename>example.sgml</filename> so that it looks like
- this;</para>
+ this:</para>
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY version "1.1">
@@ -1267,7 +1267,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<procedure>
<step>
<para>Edit <filename>example.sgml</filename> so that it looks like
- this;</para>
+ this:</para>
<programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % entities SYSTEM "entities.sgml"> %entities;
@@ -1345,7 +1345,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>The marked section is finished by closing the two square brackets,
and then returning to the document context from the SGML context with
- <literal>&gt;</literal></para>
+ <literal>&gt;</literal>.</para>
<sect2>
<title>Marked section keywords</title>
@@ -1492,7 +1492,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
]]&gt;</programlisting>
<para>When producing the hard-copy version, change the entity's
- definition to;</para>
+ definition to:</para>
<programlisting>&lt;!ENTITY % electronic.copy "IGNORE"></programlisting>
@@ -1509,7 +1509,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<procedure>
<step>
<para>Create a new file, <filename>section.sgml</filename>, that
- contains the following;</para>
+ contains the following:</para>
<programlisting>&lt;!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
&lt;!ENTITY % text.output "INCLUDE">
@@ -1552,7 +1552,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>Change the definition of the <literal>text.output</literal>
entity from <literal>INCLUDE</literal> to
<literal>IGNORE</literal>. Re-normalize the file, and examine the
- output to see what has changed. </para>
+ output to see what has changed.</para>
</step>
</procedure>
</sect2>
diff --git a/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml
index 3d9b8b2f5e..6c0953a65c 100644
--- a/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml
@@ -40,18 +40,18 @@
<orderedlist>
<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>
<para>promote consistency between the different documentation
organizations, to make it easier to switch between working on
- different documents</para>
+ different documents;</para>
</listitem>
<listitem>
<para>make it easy to decide where in the tree new documentation should
- be placed</para>
+ be placed.</para>
</listitem>
</orderedlist>
diff --git a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml
index 7b60650171..f1f5ab7a7d 100644
--- a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml
@@ -45,7 +45,7 @@
<para>Make sure your documentation ports are up to date! When in
doubt, remove the old ports using &man.pkg.delete.1; command before
installing the port. For example, we currently depend on
- jade-1.2 and if you have installed jade-1.1, please do</para>
+ jade-1.2 and if you have installed jade-1.1, please do:</para>
<screen>&prompt.root; <userinput>pkg_delete jade-1.1</userinput></screen>
</note>
@@ -153,7 +153,7 @@
<para>If you want to unset the variable
<makevar>ENGLISH_ONLY</makevar> and build all pages, including
translations, set the variable <makevar>ENGLISH_ONLY</makevar>
- to an empty value</para>
+ to an empty value:</para>
<screen>&prompt.root; <userinput>make ENGLISH_ONLY="" all install clean</userinput></screen>
</listitem>
diff --git a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
index 87a1bcd26f..a9a9249709 100644
--- a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
@@ -243,7 +243,7 @@
<para>Finally, you should have directories for each document.</para>
<para>For example, a hypothetical Swedish translation might look
- like</para>
+ like:</para>
<programlisting>doc/
sv_SE.ISO8859-1/
@@ -348,7 +348,7 @@
<para>The entity names are defined in ISO8879, which is in the ports
tree as <filename role="package">textproc/iso8879</filename>.</para>
- <para>A few examples include</para>
+ <para>A few examples include:</para>
<segmentedlist>
<segtitle>Entity</segtitle>
@@ -408,7 +408,7 @@
<para>Yes.</para>
<para>The header of the English version of each document will look
- something like this;</para>
+ something like this:</para>
<programlisting>&lt;!--
The FreeBSD Documentation Project
@@ -432,7 +432,7 @@
<para>In addition, you should add a third line which indicates which
revision of the English text this is based on.</para>
- <para>So, the Spanish version of this file might start</para>
+ <para>So, the Spanish version of this file might start:</para>
<programlisting>&lt;!--
The FreeBSD Spanish Documentation Project
diff --git a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml
index 873cf7cafa..d6f8a670d3 100644
--- a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml
@@ -109,11 +109,11 @@
<informalexample>
<para>Use the command <command>cvsup</command> to update your
- sources</para>
+ sources.</para>
</informalexample>
<informalexample>
- <para>Use <command>cvsup</command> to update your sources</para>
+ <para>Use <command>cvsup</command> to update your sources.</para>
</informalexample>
<para>These two examples show this for filenames. The second example
@@ -139,7 +139,7 @@
</informalexample>
<informalexample>
- <para>See &man.csh.1;</para>
+ <para>See &man.csh.1;.</para>
</informalexample>
</listitem>
</varlistentry>