@node Texinfo@asis{::}Convert@asis{::}HTML @chapter Texinfo::Convert::HTML @node Texinfo@asis{::}Convert@asis{::}HTML NAME @section Texinfo::Convert::HTML NAME Texinfo::Convert::HTML - Convert Texinfo tree to HTML @node Texinfo@asis{::}Convert@asis{::}HTML SYNOPSIS @section Texinfo::Convert::HTML SYNOPSIS @verbatim my $converter = Texinfo::Convert::HTML->converter({'parser' => $parser}); $converter->output($tree); $converter->convert($tree); $converter->convert_tree($tree); $converter->output_internal_links(); # HTML only @end verbatim @node Texinfo@asis{::}Convert@asis{::}HTML NOTES @section Texinfo::Convert::HTML NOTES The Texinfo Perl module main purpose is to be used in @code{texi2any} to convert Texinfo to other formats. There is no promise of API stability. @node Texinfo@asis{::}Convert@asis{::}HTML DESCRIPTION @section Texinfo::Convert::HTML DESCRIPTION Texinfo::Convert::HTML converts a Texinfo tree to HTML. @node Texinfo@asis{::}Convert@asis{::}HTML METHODS @section Texinfo::Convert::HTML METHODS @table @asis @item $converter = Texinfo::Convert::HTML->converter($options) @anchor{Texinfo@asis{::}Convert@asis{::}HTML $converter = Texinfo@asis{::}Convert@asis{::}HTML->converter($options)} Initialize converter from Texinfo to HTML. The @emph{$options} hash reference holds options for the converter. In this option hash reference a @ref{Texinfo@asis{::}Parser NAME,, parser object} may be associated with the @emph{parser} key. The other options are Texinfo customization options and a few other options that can be passed to the converter. Most of the customization options are described in the Texinfo manual. Those customization options, when appropriate, override the document content. The parser should not be available directly anymore after getting the associated information. See @ref{Texinfo@asis{::}Convert@asis{::}Converter NAME,, Texinfo::Convert::Converter} for more information. @item $converter->output($tree) @anchor{Texinfo@asis{::}Convert@asis{::}HTML $converter->output($tree)} Convert a Texinfo tree @emph{$tree} and output the result in files as described in the Texinfo manual. @item $result = $converter->convert($tree) @anchor{Texinfo@asis{::}Convert@asis{::}HTML $result = $converter->convert($tree)} Convert a Texinfo tree @emph{$tree} and return the resulting output. @item $result = $converter->convert_tree($tree) @anchor{Texinfo@asis{::}Convert@asis{::}HTML $result = $converter->convert_tree($tree)} Convert a Texinfo tree portion @emph{$tree} and return the resulting output. This function does not try to output a full document but only portions. For a full document use @code{convert}. @item $result = $converter->output_internal_links() @anchor{Texinfo@asis{::}Convert@asis{::}HTML $result = $converter->output_internal_links()} @cindex @code{output_internal_links} Returns text representing the links in the document. The format should follow the @code{--internal-links} option of the @code{texi2any} specification. This is only supported in (and relevant for) HTML. @end table @node Texinfo@asis{::}Convert@asis{::}HTML AUTHOR @section Texinfo::Convert::HTML AUTHOR Patrice Dumas, @node Texinfo@asis{::}Convert@asis{::}HTML COPYRIGHT AND LICENSE @section 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.