- 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>
This commit is contained in:
Gabor Pali 2010-08-10 11:48:17 +00:00
parent f221e00ff1
commit f93f00e7a3
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=36217

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
<command>nsgmls</command> <link linkend="sgml-primer-validating">validating <command>onsgmls</command> <link linkend="sgml-primer-validating">validating
parser</link>. Normally, <command>nsgmls</command> reads in a document parser</link>. Normally, <command>onsgmls</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 <command>nsgmls</command> is given the <option>-s</option> <para>However, when <command>onsgmls</command> is given the <option>-s</option>
parameter, <command>nsgmls</command> will suppress its normal output, and parameter, <command>onsgmls</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 <command>nsgmls</command> to check that your document is <para>Use <command>onsgmls</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>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 output. This means that your document validated
successfully.</para> successfully.</para>
</step> </step>
@ -438,11 +438,11 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA
removing the <sgmltag>title</sgmltag> and removing the <sgmltag>title</sgmltag> and
<sgmltag>/title</sgmltag> tags, and re-run the validation.</para> <sgmltag>/title</sgmltag> tags, and re-run the validation.</para>
<screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput> <screen>&prompt.user; <userinput>onsgmls -s example.sgml</userinput>
nsgmls:example.sgml:5:4:E: character data is not allowed here onsgmls: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> 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> colon-separated groups, or columns.</para>
<informaltable frame="none" pgwide="1"> <informaltable frame="none" pgwide="1">
@ -458,7 +458,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<row> <row>
<entry>1</entry> <entry>1</entry>
<entry>The name of the program generating the error. This <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>
<row> <row>
@ -483,8 +483,8 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
message, <literal>W</literal> is for warnings, and message, <literal>W</literal> is for warnings, and
<literal>E</literal> is for errors<footnote> <literal>E</literal> is for errors<footnote>
<para>It is not always the fifth column either. <para>It is not always the fifth column either.
<command>nsgmls -sv</command> displays <command>onsgmls -sv</command> displays
<literal>nsgmls:I: SP version "1.3"</literal> <literal>onsgmls:I: "OpenSP" version "1.5.2"</literal>
(depending on the installed version). As you can see, (depending on the installed version). As you can see,
this is an informational message.</para> this is an informational message.</para>
</footnote>, and <literal>X</literal> is for </footnote>, and <literal>X</literal> is for
@ -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 <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 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 <command>nsgmls</command>.</para> check that the file still validates using <command>onsgmls</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
<command>nsgmls</command> gives when it encounters an invalid comment.</para> <command>onsgmls</command> gives when it encounters an invalid comment.</para>
</step> </step>
</procedure> </procedure>
</sect2> </sect2>
@ -1049,7 +1049,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 <command>nsgmls</command>.</para> <para>Validate the document using <command>onsgmls</command>.</para>
</step> </step>
<step> <step>
@ -1075,9 +1075,9 @@ 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 <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 &gt; example.html</userinput></screen> <screen>&prompt.user; <userinput>osgmlnorm example.sgml &gt; example.html</userinput></screen>
<para>You should find a normalized (i.e., entity references <para>You should find a normalized (i.e., entity references
expanded) copy of your document in expanded) copy of your document in
@ -1086,12 +1086,12 @@ 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 <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 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> 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 &gt; example.html</userinput></screen> <screen>&prompt.user; <userinput>osgmlnorm -d example.sgml &gt; example.html</userinput></screen>
</step> </step>
</procedure> </procedure>
</sect2> </sect2>
@ -1249,7 +1249,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>Produce <filename>example.html</filename> by normalizing <para>Produce <filename>example.html</filename> by normalizing
<filename>example.sgml</filename>.</para> <filename>example.sgml</filename>.</para>
<screen>&prompt.user; <userinput>sgmlnorm -d example.sgml &gt; example.html</userinput></screen> <screen>&prompt.user; <userinput>osgmlnorm -d example.sgml &gt; example.html</userinput></screen>
</step> </step>
<step> <step>
@ -1306,7 +1306,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>Produce <filename>example.html</filename> by normalizing <para>Produce <filename>example.html</filename> by normalizing
<filename>example.sgml</filename>.</para> <filename>example.sgml</filename>.</para>
<screen>&prompt.user; <userinput>sgmlnorm -d example.sgml &gt; example.html</userinput></screen> <screen>&prompt.user; <userinput>osgmlnorm -d example.sgml &gt; example.html</userinput></screen>
</step> </step>
<step> <step>
@ -1553,7 +1553,7 @@ nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
</step> </step>
<step> <step>
<para>Normalize this file using &man.sgmlnorm.1; and examine the <para>Normalize this file using <command>osgmlnorm</command> and examine the
output. Notice which paragraphs have appeared, which have output. Notice which paragraphs have appeared, which have
disappeared, and what has happened to the content of the CDATA disappeared, and what has happened to the content of the CDATA
marked section.</para> marked section.</para>