diff options
| author | Yaroslav Tykhiy <ytykhiy@gmail.com> | 2005-09-12 16:47:36 +0000 |
|---|---|---|
| committer | Yaroslav Tykhiy <ytykhiy@gmail.com> | 2005-09-12 16:47:36 +0000 |
| commit | 9e1d1c15667b6952a9a06f0a67121e3376bb4ccd (patch) | |
| tree | ee662fc776f0eb80e4700f0c6987174a5d0b1d28 /en_US.ISO8859-1/books/fdp-primer/sgml-primer | |
| parent | 1a445039a6f5bc425463995cabdb7f7b8a56bfbd (diff) | |
| download | doc-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/sgml-primer')
| -rw-r--r-- | en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml | 44 |
1 files changed, 22 insertions, 22 deletions
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><!THIS IS OUTSIDE THE COMMENT></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>&<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 ¤t.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 &lt; and - &amp; whenever you need to include one or other of these </para> + &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>></literal></para> + <literal>></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> ]]></programlisting> <para>When producing the hard-copy version, change the entity's - definition to;</para> + definition to:</para> <programlisting><!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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ <!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> |