Date: Tue, 27 Jul 2010 19:18:24 +0100 (BST) From: Anton Shterenlikht <mexas@bristol.ac.uk> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/149007: wrong program name on fdp-primer page Message-ID: <201007271818.o6RIIOIW083480@mech-cluster241.men.bris.ac.uk> Resent-Message-ID: <201007271820.o6RIK24m053764@freefall.freebsd.org>
index | next in thread | raw e-mail
>Number: 149007 >Category: docs >Synopsis: wrong program name on fdp-primer page >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: change-request >Submitter-Id: current-users >Arrival-Date: Tue Jul 27 18:20:02 UTC 2010 >Closed-Date: >Last-Modified: >Originator: Anton Shterenlikht >Release: FreeBSD 9.0-CURRENT ia64 >Organization: University of Bristol >Environment: System: FreeBSD mech-cluster241.men.bris.ac.uk 9.0-CURRENT FreeBSD 9.0-CURRENT #0 r209586: Wed Jun 30 09:59:43 BST 2010 mexas@mech-cluster241.men.bris.ac.uk:/usr/obj/usr/src/sys/TZAV ia64 >Description: On http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer-elements.html need to do s/nsgmls/onsgmls/g >How-To-Repeat: >Fix: try this patch --- chapter.sgml.diff begins here --- --- chapter.sgml.old 2010-07-27 19:05:14.000000000 +0100 +++ chapter.sgml 2010-07-27 19:05:32.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> --- chapter.sgml.diff ends here --- >Release-Note: >Audit-Trail: >Unformatted:help
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201007271818.o6RIIOIW083480>