montnaro@sprite.crd.ge.com (Skip Montanaro) (08/28/89)
I'm trying to use (tex)info to do some project documentation. Since we
expect the document to be quite long, and because it is a multi-person
project, it is split into separate files. I am having trouble getting
info to traverse the boundary between files. Here is a short sample
(/tmp/sample.texinfo):
\input texinfo @c -*-Texinfo-*-
@setfilename sample.info
@node Top, Other, (DIR), (DIR)
@menu
* Other: (/tmp/other.info). Some other node
@end menu
@include other.texinfo
@bye
/tmp/sample.info references /tmp/other.info. /tmp/other.texinfo is:
@c -*-Texinfo-*-
@setfilename other.info
@node Other,, (/tmp/sample.info)Top, (/tmp/sample.info)Top
This node gives you access to Other One and Other Two.
@menu
* Other One::
* Other Two::
@end menu
@node Other One, Other Two, Other Two, Other
This is node Other One.
@node Other Two, Other One, Other One, Other
This is node Other Two.
The menu entry in my info (dir) file is:
* Sample: (/tmp/sample.info). Just a test node.
I can successfully visit the node called 'sample' using Info-menu, but
when I try to visit the node called 'other', I get an error 'No such
node: Top'. If I try to visit 'other' using Info-next, I get 'No such
node: Other'. Can someone tell what I botched in sample.texinfo or
other.texinfo?
Thanks,
Skip Montanaro (montanaro@sprite.crd.ge.com)pk@tut.fi (Kellom{ki Pertti) (08/29/89)
On 28 Aug 89 15:11:30 GMT,montnaro@sprite.crd.ge.com (Skip Montanaro) said:
Skip> I'm trying to use (tex)info to do some project documentation. Since we
Skip> expect the document to be quite long, and because it is a multi-person
Skip> project, it is split into separate files. I am having trouble getting
Skip> info to traverse the boundary between files. Here is a short sample
Skip> (/tmp/sample.texinfo):
...
Skip> I can successfully visit the node called 'sample' using Info-menu, but
Skip> when I try to visit the node called 'other', I get an error 'No such
Skip> node: Top'. If I try to visit 'other' using Info-next, I get 'No such
Skip> node: Other'. Can someone tell what I botched in sample.texinfo or
Skip> other.texinfo?
From the texinfo documentation:
The top node of the file, named `top', should have as its parent the
name of a node in another file, where there is a menu that leads to this
file. ...
Thus the top node of each info file must be named `top', at least
that's my impression. I'm currently using texinfo and a tool called
schemeTeX (a kind of simplistic web for scheme) on a project of mine.
What I do, is that I have a master texinfo file that @include's all
the others. I then use a piece of elisp to expand all the @include's
and do texinfo-format-buffer on the whole bunch to make the info file.
I've found it very useful to have the documentation+source code on
line during program development. I have some crude elisp support for
writing schemeTeX source code (combined scheme code and texinfo). If I
ever manage to package it nicely, I'll make it available. Maybe I
could even do it as a class project and get some credit...
--
Pertti Kellom\"aki (TeX format) # Software will be a science when programmers
Tampere Univ. of Technology # stand on each other's shoulders instead
Software Systems Lab # of each other's toes