Bug 149007
| Summary: | wrong program name on fdp-primer page | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Anton Shterenlikht <as> | ||||
| Component: | Books & Articles | Assignee: | Gabor Pali <pgj> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | ||||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
|
Description
Anton Shterenlikht
2010-07-27 19:20:02 UTC
Responsible Changed From-To: freebsd-doc->pgj Over to me. and s/sgmlnorm/osgmlnorm/g
Here's a full patch:
--- chapter.sgml.old 2010-07-27 19:47:19.000000000 +0100
+++ chapter.sgml 2010-07-27 19:47:45.000000000 +0100
@@ -412,23 +412,23 @@
<para>Try to validate this file using an SGML parser.</para>
<para>Part of <filename role="package">textproc/docproj</filename> is the
- <command>nsgmls</command> <link linkend="sgml-primer-validating">validating
- parser</link>. Normally, <command>nsgmls</command> reads in a document
+ <command>onsgmls</command> <link linkend="sgml-primer-validating">validating
+ parser</link>. Normally, <command>onsgmls</command> reads in a document
marked up according to an SGML DTD and returns a copy of the
document's Element Structure Information Set (ESIS, but that is
not important right now).</para>
- <para>However, when <command>nsgmls</command> is given the <option>-s</option>
- parameter, <command>nsgmls</command> will suppress its normal output, and
+ <para>However, when <command>onsgmls</command> is given the <option>-s</option>
+ parameter, <command>onsgmls</command> will suppress its normal output, and
just print error messages. This makes it a useful way to check to
see if your document is valid or not.</para>
- <para>Use <command>nsgmls</command> to check that your document is
+ <para>Use <command>onsgmls</command> to check that your document is
valid:</para>
- <screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput></screen>
+ <screen>&prompt.user; <userinput>onsgmls -s example.sgml</userinput></screen>
- <para>As you will see, <command>nsgmls</command> returns without displaying any
+ <para>As you will see, <command>onsgmls</command> returns without displaying any
output. This means that your document validated
successfully.</para>
</step>
@@ -438,11 +438,11 @@
removing the <sgmltag>title</sgmltag> and
<sgmltag>/title</sgmltag> tags, and re-run the validation.</para>
- <screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput>
-nsgmls:example.sgml:5:4:E: character data is not allowed here
-nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
+ <screen>&prompt.user; <userinput>onsgmls -s example.sgml</userinput>
+onsgmls:example.sgml:5:4:E: character data is not allowed here
+onsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
- <para>The error output from <command>nsgmls</command> is organized into
+ <para>The error output from <command>onsgmls</command> is organized into
colon-separated groups, or columns.</para>
<informaltable frame="none" pgwide="1">
@@ -458,7 +458,7 @@
<row>
<entry>1</entry>
<entry>The name of the program generating the error. This
- will always be <literal>nsgmls</literal>.</entry>
+ will always be <literal>onsgmls</literal>.</entry>
</row>
<row>
@@ -483,8 +483,8 @@
message, <literal>W</literal> is for warnings, and
<literal>E</literal> is for errors<footnote>
<para>It is not always the fifth column either.
- <command>nsgmls -sv</command> displays
- <literal>nsgmls:I: SP version "1.3"</literal>
+ <command>onsgmls -sv</command> displays
+ <literal>onsgmls:I: SP version "1.3"</literal>
(depending on the installed version). As you can see,
this is an informational message.</para>
</footnote>, and <literal>X</literal> is for
@@ -512,7 +512,7 @@
<para>The second error is because <sgmltag>head</sgmltag> elements
<emphasis>must</emphasis> contain a <sgmltag>title</sgmltag>
- element. Because it does not <command>nsgmls</command> considers that the
+ element. Because it does not <command>onsgmls</command> considers that the
element has not been properly finished. However, the closing tag
indicates that the element has been closed before it has been
finished.</para>
@@ -894,13 +894,13 @@
<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>onsgmls</command>.</para>
</step>
<step>
<para>Add some invalid comments to
<filename>example.sgml</filename>, and see the error messages that
- <command>nsgmls</command> gives when it encounters an invalid comment.</para>
+ <command>onsgmls</command> gives when it encounters an invalid comment.</para>
</step>
</procedure>
</sect2>
@@ -1049,7 +1049,7 @@
</step>
<step>
- <para>Validate the document using <command>nsgmls</command>.</para>
+ <para>Validate the document using <command>onsgmls</command>.</para>
</step>
<step>
@@ -1075,9 +1075,9 @@
SGML is to expand all the entity references in the document,
replacing the entities with the text that they represent.</para>
- <para>You can use <command>sgmlnorm</command> to do this.</para>
+ <para>You can use <command>osgmlnorm</command> to do this.</para>
- <screen>&prompt.user; <userinput>sgmlnorm example.sgml > example.html</userinput></screen>
+ <screen>&prompt.user; <userinput>osgmlnorm example.sgml > example.html</userinput></screen>
<para>You should find a normalized (i.e., entity references
expanded) copy of your document in
@@ -1086,12 +1086,12 @@
</step>
<step>
- <para>If you look at the output from <command>sgmlnorm</command>
+ <para>If you look at the output from <command>osgmlnorm</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>
- <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>
+ <screen>&prompt.user; <userinput>osgmlnorm -d example.sgml > example.html</userinput></screen>
</step>
</procedure>
</sect2>
@@ -1249,7 +1249,7 @@
<para>Produce <filename>example.html</filename> by normalizing
<filename>example.sgml</filename>.</para>
- <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>
+ <screen>&prompt.user; <userinput>osgmlnorm -d example.sgml > example.html</userinput></screen>
</step>
<step>
@@ -1306,7 +1306,7 @@
<para>Produce <filename>example.html</filename> by normalizing
<filename>example.sgml</filename>.</para>
- <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>
+ <screen>&prompt.user; <userinput>osgmlnorm -d example.sgml > example.html</userinput></screen>
</step>
<step>
@@ -1553,7 +1553,7 @@
</step>
<step>
- <para>Normalize this file using &man.sgmlnorm.1; and examine the
+ <para>Normalize this file using &man.osgmlnorm.1; and examine the
output. Notice which paragraphs have appeared, which have
disappeared, and what has happened to the content of the CDATA
marked section.</para>
--
Anton Shterenlikht
Room 2.6, Queen's Building
Mech Eng Dept
Bristol University
University Walk, Bristol BS8 1TR, UK
Tel: +44 (0)117 331 5944
Fax: +44 (0)117 929 4423
pgj 2010-08-10 11:48:17 UTC
FreeBSD doc repository
Modified files:
en_US.ISO8859-1/books/fdp-primer/sgml-primer chapter.sgml
Log:
- Replace software installed by textproc/jade with software installed by
textproc/opensp since that is the one which comes with
textproc/docproj by default
PR: docs/149007
Submitted by: Anton Shterenlikht <mexas@bristol.ac.uk>
Revision Changes Path
1.50 +25 -25 doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
State Changed From-To: open->closed The patch has been committed with minor modifications. Thank you for the submission! |
