Codebase list texinfo / 59241d56-6b55-48c2-9310-7d0fe30b6d4d/main doc / tp_api / api_includes / Texinfo-Convert-Texinfo.texi
59241d56-6b55-48c2-9310-7d0fe30b6d4d/main

Tree @59241d56-6b55-48c2-9310-7d0fe30b6d4d/main (Download .tar.gz)

Texinfo-Convert-Texinfo.texi @59241d56-6b55-48c2-9310-7d0fe30b6d4d/mainraw · history · blame

@node Texinfo::Convert::Texinfo
@chapter Texinfo::Convert::Texinfo

@menu
* Texinfo@asis{::}Convert@asis{::}Texinfo NAME::
* Texinfo@asis{::}Convert@asis{::}Texinfo SYNOPSIS::
* Texinfo@asis{::}Convert@asis{::}Texinfo DESCRIPTION::
* Texinfo@asis{::}Convert@asis{::}Texinfo METHODS::
* Texinfo@asis{::}Convert@asis{::}Texinfo AUTHOR::
@end menu

@node Texinfo::Convert::Texinfo NAME
@section NAME

Texinfo::Convert::Texinfo - Convert a Texinfo tree to Texinfo code

@node Texinfo::Convert::Texinfo SYNOPSIS
@section SYNOPSIS

@verbatim
  use Texinfo::Convert::Texinfo qw(convert);
  
  my $texinfo_text = convert($tree);
@end verbatim

@node Texinfo::Convert::Texinfo DESCRIPTION
@section DESCRIPTION

Texinfo::Convert::Texinfo converts a Texinfo tree (described in 
@ref{Texinfo::Parser NAME}) to Texinfo code.  If the Texinfo tree results from 
parsing some Texinfo document, The converted Texinfo code should be
exactly the same as the initial document, except that user defined @@-macros 
and @code{@@value} are expanded, and some invalid code is discarded.

@node Texinfo::Convert::Texinfo METHODS
@section METHODS

@table @asis
@item $texinfo_text = convert($tree)
@anchor{Texinfo::Convert::Texinfo $texinfo_text = convert($tree)}

Converts the Texinfo tree @emph{$tree} to Texinfo code.

@end table

@node Texinfo::Convert::Texinfo AUTHOR
@section AUTHOR

Patrice Dumas, <pertusus@@free.fr>