- Since nsgmls(1) and sgmlnorm(1) don't exist, use <command>

tag

Approved by:	josef (mentor)
This commit is contained in:
Kirill Ponomarev 2004-05-27 21:54:21 +00:00
parent 41efa07f40
commit 882cb83f8c
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=21035

View file

@ -412,23 +412,23 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA
<para>Try to validate this file using an SGML parser.</para> <para>Try to validate this file using an SGML parser.</para>
<para>Part of <filename role="package">textproc/docproj</filename> is the <para>Part of <filename role="package">textproc/docproj</filename> is the
&man.nsgmls.1; <link linkend="sgml-primer-validating">validating <command>nsgmls</command> <link linkend="sgml-primer-validating">validating
parser</link>. Normally, &man.nsgmls.1; reads in a document parser</link>. Normally, <command>nsgmls</command> reads in a document
marked up according to an SGML DTD and returns a copy of the marked up according to an SGML DTD and returns a copy of the
document's Element Structure Information Set (ESIS, but that is document's Element Structure Information Set (ESIS, but that is
not important right now).</para> not important right now).</para>
<para>However, when &man.nsgmls.1; is given the <option>-s</option> <para>However, when <command>nsgmls</command> is given the <option>-s</option>
parameter, &man.nsgmls.1; will suppress its normal output, and parameter, <command>nsgmls</command> will suppress its normal output, and
just print error messages. This makes it a useful way to check to just print error messages. This makes it a useful way to check to
see if your document is valid or not.</para> see if your document is valid or not.</para>
<para>Use &man.nsgmls.1; to check that your document is <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> <screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput></screen>
<para>As you will see, &man.nsgmls.1; returns without displaying any <para>As you will see, <command>nsgmls</command> returns without displaying any
output. This means that your document validated output. This means that your document validated
successfully.</para> successfully.</para>
</step> </step>
@ -442,7 +442,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA
nsgmls:example.sgml:5:4:E: character data is not allowed here 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> nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>The error output from &man.nsgmls.1; is organized into <para>The error output from <command>nsgmls</command> is organized into
colon-separated groups, or columns.</para> colon-separated groups, or columns.</para>
<informaltable frame="none"> <informaltable frame="none">
@ -512,7 +512,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>The second error is because <sgmltag>head</sgmltag> elements <para>The second error is because <sgmltag>head</sgmltag> elements
<emphasis>must</emphasis> contain a <sgmltag>title</sgmltag> <emphasis>must</emphasis> contain a <sgmltag>title</sgmltag>
element. Because it does not &man.nsgmls.1; considers that the element. Because it does not <command>nsgmls</command> considers that the
element has not been properly finished. However, the closing tag element has not been properly finished. However, the closing tag
indicates that the element has been closed before it has been indicates that the element has been closed before it has been
finished.</para> finished.</para>
@ -894,13 +894,13 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<procedure> <procedure>
<step> <step>
<para>Add some comments to <filename>example.sgml</filename>, and <para>Add some comments to <filename>example.sgml</filename>, and
check that the file still validates using &man.nsgmls.1;</para> check that the file still validates using <command>nsgmls</command></para>
</step> </step>
<step> <step>
<para>Add some invalid comments to <para>Add some invalid comments to
<filename>example.sgml</filename>, and see the error messages that <filename>example.sgml</filename>, and see the error messages that
&man.nsgmls.1; gives when it encounters an invalid comment.</para> <command>nsgmls</command> gives when it encounters an invalid comment.</para>
</step> </step>
</procedure> </procedure>
</sect2> </sect2>
@ -1045,7 +1045,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>Validate the document using &man.nsgmls.1;</para> <para>Validate the document using <command>nsgmls</command></para>
</step> </step>
<step> <step>
@ -1071,7 +1071,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
SGML is to expand all the entity references in the document, SGML is to expand all the entity references in the document,
replacing the entities with the text that they represent.</para> replacing the entities with the text that they represent.</para>
<para>You can use &man.sgmlnorm.1; to do this.</para> <para>You can use <command>sgmlnorm</command> to do this.</para>
<screen>&prompt.user; <userinput>sgmlnorm example.sgml > example.html</userinput></screen> <screen>&prompt.user; <userinput>sgmlnorm example.sgml > example.html</userinput></screen>
@ -1082,9 +1082,9 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>If you look at the output from &man.sgmlnorm.1; you will see <para>If you look at the output from <command>sgmlnorm</command>
that it does not include a DOCTYPE declaration at the start. To you will see that it does not include a DOCTYPE declaration at
include this you need to use the <option>-d</option> 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> <screen>&prompt.user; <userinput>sgmlnorm -d example.sgml > example.html</userinput></screen>