Kevin Ryde > chart > App::Chart::Texinfo::Util

Download:
chart-249.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  16
Open  3
View/Report Bugs
Source  

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

syntax highlighting: