19.1 Texinfo::Convert::HTML NAME ¶

Texinfo::Convert::HTML - Convert Texinfo tree to HTML

19.2 Texinfo::Convert::HTML SYNOPSIS ¶

  my $converter
    = Texinfo::Convert::HTML->converter({'NUMBER_SECTIONS' => 0});

  $converter->output($document);
  $converter->convert($document);
  $converter->convert_tree($tree);
  $converter->output_internal_links(); # HTML only

19.3 Texinfo::Convert::HTML NOTES ¶

The Texinfo Perl module main purpose is to be used in texi2any to convert Texinfo to other formats. There is no promise of API stability.

19.4 Texinfo::Convert::HTML DESCRIPTION ¶

Texinfo::Convert::HTML converts a Texinfo tree to HTML.

19.5 Texinfo::Convert::HTML METHODS ¶

$converter = Texinfo::Convert::HTML->converter($options)

Initialize converter from Texinfo to HTML.

The $options hash reference holds Texinfo customization options for the converter. These options should be Texinfo customization options that can be passed to the converter. Most of the customization options are described in the Texinfo manual or in the customization API manual. Those customization options, when appropriate, override the document content.

See Texinfo::Convert::Converter for more information.

$converter->output($document)

Convert a Texinfo parsed document $document and output the result in files as described in the Texinfo manual.

$result = $converter->convert($document)

Convert a Texinfo parsed document $document and return the resulting output.

$result = $converter->convert_tree($tree)

Convert a Texinfo tree portion $tree and return the resulting output. This function does not try to output a full document but only portions. For a full document use convert.

In general, this function should be called after the converter has been associated to a document by a call to output or convert.

$result = $converter->output_internal_links()

Returns text representing the links in the document. The format should follow the --internal-links option of the texi2any specification. This is only supported in (and relevant for) HTML.

19.6 Texinfo::Convert::HTML AUTHOR ¶

Patrice Dumas, <pertusus@free.fr>

19.7 Texinfo::Convert::HTML COPYRIGHT AND LICENSE ¶

Copyright 2010- Free Software Foundation, Inc. See the source file for all copyright years.

This library 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 of the License, or (at your option) any later version.