From: John Darrington <address@hidden>
To: Selma Leathem <address@hidden>
Cc: John Darrington <address@hidden>; Ben Pfaff <address@hidden>; "address@hidden" <address@hidden>
Sent:
Thursday, October 11, 2012 2:15 AM
Subject: Re: Problems with help in Html too
On Wed, Oct 10, 2012 at 10:34:14AM -0700, Selma Leathem wrote:
Thanks for the options. I don't mind fixing it, if you can tell me what I should do.
Ok, Here are some of the problems that I noticed. You should have seen
makeinfo report these as warnings, if not errors. In fact, I'm not sure
how you managed to produce any output. For me, it reported these errors
and aborted. I guess you must have told it to ignore errors somehow.
At any rate, you need to fix all the errors that makeinfo reports, otherwise
(as you noticed) the output will appear wierd or totally broken.
1. You have nested @floats This makes no sense and is invalid in Texinfo.
For example, there are many instances of code like:
@float
@table @asis
@item Type a new name in the cell.
@item Press the enter key.
@end table
@float Figure,
fig:pic6
@image{Images/pic6}
@caption{Edit @emph{name} in variable view.}
@end float
@end float
The outer @float here is wrong. Delete it.
2. In many places, you have code between a sectioning command and @node. For
example:
@node Variable View
@cindex Variable View
@subsection Variable View
The sectioning command must immediately follow the @node command. So
change this to:
@node Variable View
@subsection Variable View
@cindex Variable View
3. In a number of places, you have emph{Range-through} The @ seems to be
missing. (In fact, @emph is a bad idea here, but that's a different
issue).
4. On line 1408 you have @emph(compute) You have used () where {} are
appropriate.
5. Some of your @menus look like this:
@menu
*Extraction::
Extraction.
*Rotation:: Rotation.
@end menu
I've found in the past that the lack of a space after the * can confuse
makeinfo. Make sure they look like this:
@menu
* Extraction:: Extraction.
* Rotation:: Rotation.
@end menu
(Arguably this is a bug in makeinfo).
6. Some of your @node declarations are spelt different from what appears to
be the corresponding menu entry. For example, you have:
* Analyse:: Analyse.
(Cambridge style) but the @node is written (Oxford style):
@node Analyze
Similarly,
* Recode Into Different Variables:: Recode into Different Variables.
vs.
@node Recode into Different Variables
There are other
inconsistencies like this too. Make sure the nodes
are written the same as the menu entries.
7. There are lots of xrefs like (@xref{fig:pic4}) This is wrong, since
) may not follow @xref. Here you should use @pxref instead. Read
up in the Texinfo manual about when you should use @xref, @ref and @pxref.
8. You have a number of uses of @unnumberedsubsection
I see what your problem was here. You had got down to @subsubsection and
and found there was no lower level section, so used @unnumberedsubsection
instead. Unfortunately, this confuses makeinfo
For now, I suggest you simply delete or comment out the @unumberedsubsubsec,
the @node and the corresponding @menu - Later we can find a better solution
for this.
There are probably other issues too, which I haven't noticed.
If you fix the
above, and then build it using the process described in README.GIT or using
the Makefile from a *recent* build, then you will see any outstanding errors.
Once they are fixed, the broken output that you saw should go away.
If you have problems, ask here or on irc.
Thanks,
John
--
PGP Public key ID: 1024D/2DE827B3
fingerprint = 8797 A26D 0854 2EAB 0285 A290 8A67 719C 2DE8 27B3
See http://keys.gnupg.net or any PGP keyserver for public key.
psppire6.texi