blob: 3f7acd03a1b48447a2ccf458bcd671265972f675 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# Automatically generated from maintain/template.pod
=head1 NAME
Texinfo::Convert::OUTFORMAT - Convert Texinfo tree to OUTFORMAT
=head1 SYNOPSIS
my $converter
= Texinfo::Convert::OUTFORMAT->converter({'parser' => $parser});
$converter->output($tree);
$converter->convert($tree);
$converter->convert_tree($tree);
__HTML $converter->output_internal_links(); # HTML only
=head1 DESCRIPTION
Texinfo::Convert::OUTFORMAT converts a Texinfo tree to OUTFORMAT.
=head1 METHODS
=over
=item $converter = Texinfo::Convert::OUTFORMAT->converter($options)
Initialize converter from Texinfo to OUTFORMAT.
The I<$options> hash reference holds options for the converter. In
this option hash reference a parser object may be associated with the
I<parser> key. The other options should be configuration options
described in the Texinfo manual. Those options, when appropriate,
override the document content.
See L<Texinfo::Convert::Converter> for more informations.
=item $converter->output($tree)
Convert a Texinfo tree I<$tree> and output the result in files as
described in the Texinfo manual.
=item $result = $converter->convert($tree)
Convert a Texinfo tree I<$tree> or tree portion and return
the resulting output.
=item $result = $converter->convert_tree($tree)
Convert a Texinfo tree portion I<$tree> and return the resulting
output. This function does not try to output a full document but only
portions. For a full document use C<convert>.
__HTML =item $result = $converter->output_internal_links()
__HTML
__HTML Returns text representing the links in the document. The format should
__HTML follow the C<--internal-links> option of the texi2any/makeinfo
__HTML specification. This is only supported in (and relevant for) HTML.
__HTML
=back
=head1 AUTHOR
Patrice Dumas, E<lt>pertusus@free.frE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2016 Free Software Foundation, Inc.
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.
=cut
|