help-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Creating Pointers with `makeinfo'


From: Karl Berry
Subject: Re: Creating Pointers with `makeinfo'
Date: Wed, 19 Feb 2003 09:18:41 -0500

    In the texinfo documentation under nodes there is a section titled 
    "Creating Pointers with 'makeinfo'". But it does not explain how to do
    this. 

Yes, that section could stand some expansion and examples.

It's not so much what you do as what you don't do.  In brief,
1) write each node with just the node name, no other pointers.
2) put a sectioning command after each @node command.
3) include menus showing the order (this isn't logically necessary, but
   it's a limitation of the current implementation).  You can use the
   texinfo.el mode commands in Emacs to get these defined/updated.
   (Described in the texinfo manual.)
4) the document must be a normal hierarchy, meaning chapters at the top
   level, sections beneath, subsections beneath that.

For example:

@menu
* Whatever::
...
@end menu

@node Whatever
@chapter Whatever this means
...

@menu
* Subtopic::
* Another subtopic::
...
@end menu

@node Subtopic
@section This subtopic
...

@node Another subtopic
@section Another subtopic
...


For a real example, see
http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/texinfo/texinfo/doc/info-stnd.texi?rev=HEAD

Or most any current GNU manual, for that manual.

Hope this helps, let me know if you still can't get going.

karl




reply via email to

[Prev in Thread] Current Thread [Next in Thread]