Texinfo documentation "bug"

[Jaakko Hollmen]

Dear Texinfo -developers,

I have read through the documentation of Texinfo, in order to be
able to write Texinfo documentation for my upcoming open-source
software. I found a small bug in a documentation example, which
nonetheless could be slightly distrubing to those who learn the
stuff for the first time. The details of the environment follow.

--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---

The example in the Chapter "10. Quotations and Examples", in the
Section "10.10 address@hidden': Undoing a Line's Indentation" the
example does not compile. This is because the @example environment
is closed by @end group statement. So the example that is:

@example
This line follows an @@example command.
@exdent This line is exdented.
This line follows the exdented line.
The @@end example comes on the next line.
@end group

should be:

@example
This line follows an @@example command.
@exdent This line is exdented.
This line follows the exdented line.
The @@end example comes on the next line.
@end example

--- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---

This is pretty clear once you realize the mistake... Thanks for
developing Texinfo, maybe I come up with some contributions as well!

Best regards,
Jaakko Hollmén

------------------------------------------------------------------

joosua:~/zone_dev/zone> texi2dvi --version
texi2dvi (GNU Texinfo 4.8) 1.34

Copyright (C) 2004 Free Software Foundation, Inc.
There is NO warranty.  You may redistribute this software
under the terms of the GNU General Public License.
For more information about these matters, see the files named COPYING.
joosua:~/zone_dev/zone>

------------------------------------------------------------------

This manual is for GNU Texinfo (version 4.8, 29 December 2004), a
documentation system that can produce both online information and a
printed manual from a single source.

------------------------------------------------------------------

This little mistake should be relatively OS independent, therefore
I am not bugging you with the details of Ubuntu Linux OS running
on obsolete Shuttle hardware...

------------------------------------------------------------------

Compiling the example as part of a bigger document gives the 
following error message:

joosua:~/zone_dev/zone> tex zone.texinfo
This is TeX, Version 3.141592 (Web2C 7.5.4)
(./zone.texinfo (/usr/share/texmf/tex/texinfo/texinfo.tex
Loading texinfo [version 2004-11-25.16]: Basics, pdf, fonts, page headings,
tables, conditionals, indexing, sectioning, toc, environments, defuns, macros,
cross references, insertions, (/usr/share/texmf-tetex/tex/generic/epsf/epsf.tex
) localization, and turning on texinfo input format.) (./zone.aux) [1]
(./zone.tmp (./zone.tmp) (./zone.tmp) (./zone.tmp) (./zone.tmp) (./zone.tmp))
[2] (./zone.toc) [-1] Chapter 1
! This command can appear only in environment @group, not in environment @examp
le.
@badenverr ...temp , not @inenvironment @thisenv }

@checkenv address@hidden @thisenv @temp @else @badenverr
                                                  @fi
@\end ...pandafter @checkenv @csname address@hidden
                                                  @csname address@hidden @end...
l.128 @end group

?

------------------------------------------------------------------

---------------------------------------------------------------
Jaakko Hollmen, Laboratory of Computer and Information Science
Helsinki University of Technology, P.O. Box 5400, FIN-02015 HUT
URL:     http://www.cis.hut.fi/jhollmen,  address@hidden
tel:    +358  9 451 5290, fax. +358 9 451 3277
mobile: +358 50 326 0110
---------------------------------------------------------------