Christopher J. Madsen > Texinfo-Menus-1.03 > Texinfo::Menus

Download:
Texinfo-Menus-1.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.03   Source  

NAME ^

Texinfo::Menus - Update node links and menus in Texinfo documents

VERSION ^

This document describes version 1.03 of Texinfo::Menus, released September 28, 2013.

SYNOPSIS ^

  use Texinfo::Menus;

  update_menus($filename, verbose => 1);

DESCRIPTION ^

Texinfo::Menus exports just one function: update_menus. It updates the menus and node links in a Texinfo file based on its chapter structure. The file may use @include to include other files, which may also @inlcude other files. Unlike the similar Emacs functions, update_menus does not require that each chapter be in a separate file.

The first node in the file should be named `Top'.

Each @node command must be followed immediately by a Texinfo structuring command (e.g, @chapter, @section, @appendix). A comment may come between them, but nothing else.

A node can supply a menu description with a comment in the form:

 @c DESC: Menu description

This comment (if present) must come after the structuring command.

OPTIONS ^

comments

update_menus normally adds comments to the master menu to retain the descriptions of subsection and lesser nodes. (This is useful when the subfiles are automatically generated and the descriptions are added by hand.) Use comments => 0 to prevent this.

detailed

Normally, update_menus generates a detailed node listing (consisting of the section nodes for each chapter) following the master menu. Use detailed => 0 to omit the detailed node listing.

verbose

The verbose option causes update_menus to generate a warning message if it finds multiple descriptions for a node (only one of which will be used). Use verbose => 1 to enable this.

CONFIGURATION AND ENVIRONMENT ^

Texinfo::Menus requires no configuration files or environment variables.

DEPENDENCIES ^

None.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

Texinfo::Menus cannot handle @include inside a menu.

AUTHOR ^

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-Texinfo-Menus AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Texinfo-Menus.

You can follow or contribute to Texinfo-Menus's development at http://github.com/madsen/texinfo-menus.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by Christopher J. Madsen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: