Kevin Ryde
and 1 contributors

NAME

App::Chart::Texinfo::Util -- some texinfo utilities

SYNOPSIS

 use App::Chart::Texinfo::Util;
 $anchor = App::Chart::Texinfo::Util::node_to_html_anchor ($node);

 # or imported
 use App::Chart::Texinfo::Util ':all';
 $anchor = node_to_html_anchor ($node);

DESCRIPTION

A function which hasn't found a better place to live yet.

FUNCTIONS

$string = App::Chart::Texinfo::Util::node_to_html_anchor ($node)

Return a HTML anchor for a Texinfo node name, as per anchor generation specified in the Texinfo manual "HTML Xref Node Name Expansion" and "HTML Xref 8-bit Character Expansion". It encodes various spaces and non-alphanumeric characters as hexadecimal "_HHHH" sequences. For example,

    App::Chart::Texinfo::Util::node_to_html_anchor ('My Node-Name')
    # returns 'My-Node_002dName'

Perl utf8 wide-char strings can be passed here. Characters beyond 255 are taken to be unicode and encoded as 4 or 6 hex digits per the Texinfo spec.

SEE ALSO

Texinfo::Menus

HOME PAGE

http://user42.tuxfamily.org/chart/index.html

LICENCE

Copyright 2007, 2008, 2009, 2010, 2011, 2016 Kevin Ryde

Chart is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Chart is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Chart; see the file COPYING. Failing that, see http://www.gnu.org/licenses/.