old-www/HOWTO/Howtos-with-LinuxDoc-7.html

64 lines
3.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21">
<TITLE>: Errors and Error Messages</TITLE>
<LINK HREF="Howtos-with-LinuxDoc-8.html" REL=next>
<LINK HREF="Howtos-with-LinuxDoc-6.html" REL=previous>
<LINK HREF="Howtos-with-LinuxDoc.html#toc7" REL=contents>
</HEAD>
<BODY>
<A HREF="Howtos-with-LinuxDoc-8.html">Next</A>
<A HREF="Howtos-with-LinuxDoc-6.html">Previous</A>
<A HREF="Howtos-with-LinuxDoc.html#toc7">Contents</A>
<HR>
<H2><A NAME="s7">7.</A> <A HREF="Howtos-with-LinuxDoc.html#toc7">Errors and Error Messages</A></H2>
<H2><A NAME="ss7.1">7.1</A> <A HREF="Howtos-with-LinuxDoc.html#toc7.1">Errors That Don't Create Error Messages</A>
</H2>
<P>A major error is to forget to put a &lt;p&gt;. tag after a section
heading. Then there is no end to the section heading and all the
following paragraphs become part of the section heading and get into
the table of contents. Linuxdoc should be improved to spot this
error. To spot it manually, look at the table of contents in html or
text format. Fixing it requires just adding the missing p-tag.</P>
<H2><A NAME="ss7.2">7.2</A> <A HREF="Howtos-with-LinuxDoc.html#toc7.2">Actual Error Messages</A>
</H2>
<P> When you are running the linuxdoc program (sgml2html or sgml2txt
for example) you are likely to see some error messages. You need to
edit your document and fix the errors.</P>
<P>Omission of closing quotes is a common error. If you get an error
message that makes no sense and notice that at the error location are
some quotes (" ") that are OK, then the likely error is that you have
previously typed an opening quote with no closing quote. Like:
&lt;.... id="my home page &gt; so linuxdoc thinks that the next quote,
which may be many paragraphs after the missing quote location, is the
closing quote. Then after the false closing quote it expects a &gt; to
finish the tag but doesn't find one. To find and fix the missing
quote, just search backwards for a ".</P>
<P>A single error can cause a lot of error messages. In the example
above, a number of tags may be inside erroneous quotes that shouldn't
have been inside any quotes. So the linuxdoc will not find these tags.
As a result, it will not know that a certain tag is open and if it
finds a closing tag it will tell you that that tag was not open.
For example, if the &lt;itemize> tag was missed, then &lt;item>
tags may make no sense to linuxdoc and it will report an error for
each such tag found beyond the false closing quote. </P>
<P>One thing you should know is that the tag names are not case sensitive
so the error messages will show tag names in upper case (capital
letters) even though you typed them in lower case.</P>
<P>To understand the error messages better requires an understanding of
the jargon on sgml which you don't really need to learn unless you get
errors which you can't seem to get fixed and you don't understand the
error message. The following sector is about such jargon.</P>
<HR>
<A HREF="Howtos-with-LinuxDoc-8.html">Next</A>
<A HREF="Howtos-with-LinuxDoc-6.html">Previous</A>
<A HREF="Howtos-with-LinuxDoc.html#toc7">Contents</A>
</BODY>
</HTML>