1Pod::Simple::RTF(3)   User Contributed Perl Documentation  Pod::Simple::RTF(3)
2
3
4

NAME

6       Pod::Simple::RTF -- format Pod as RTF
7

SYNOPSIS

9         perl -MPod::Simple::RTF -e \
10          "exit Pod::Simple::RTF->filter(shift)->any_errata_seen" \
11          thingy.pod > thingy.rtf
12

DESCRIPTION

14       This class is a formatter that takes Pod and renders it as RTF, good
15       for viewing/printing in MSWord, WordPad/write.exe, TextEdit, etc.
16
17       This is a subclass of Pod::Simple and inherits all its methods.
18

FORMAT CONTROL ATTRIBUTES

20       You can set these attributes on the parser object before you call
21       "parse_file" (or a similar method) on it:
22
23       $parser->head1_halfpoint_size( halfpoint_integer );
24       $parser->head2_halfpoint_size( halfpoint_integer );
25       $parser->head3_halfpoint_size( halfpoint_integer );
26       $parser->head4_halfpoint_size( halfpoint_integer );
27           These methods set the size (in half-points, like 52 for 26-point)
28           that these heading levels will appear as.
29
30       $parser->codeblock_halfpoint_size( halfpoint_integer );
31           This method sets the size (in half-points, like 21 for 10.5-point)
32           that codeblocks ("verbatim sections") will appear as.
33
34       $parser->header_halfpoint_size( halfpoint_integer );
35           This method sets the size (in half-points, like 15 for 7.5-point)
36           that the header on each page will appear in.  The header is usually
37           just "modulename p. pagenumber".
38
39       $parser->normal_halfpoint_size( halfpoint_integer );
40           This method sets the size (in half-points, like 26 for 13-point)
41           that normal paragraphic text will appear in.
42
43       $parser->no_proofing_exemptions( true_or_false );
44           Set this value to true if you don't want the formatter to try
45           putting a hidden code on all Perl symbols (as best as it can notice
46           them) that labels them as being not in English, and so not worth
47           spellchecking.
48
49       $parser->doc_lang( microsoft_decimal_language_code )
50           This sets the language code to tag this document as being in. By
51           default, it is currently the value of the environment variable
52           "RTFDEFLANG", or if that's not set, then the value 1033 (for US
53           English).
54
55           Setting this appropriately is useful if you want to use the RTF to
56           spellcheck, and/or if you want it to hyphenate right.
57
58           Here are some notable values:
59
60             1033  US English
61             2057  UK English
62             3081  Australia English
63             4105  Canada English
64             1034  Spain Spanish
65             2058  Mexico Spanish
66             1031  Germany German
67             1036  France French
68             3084  Canada French
69             1035  Finnish
70             1044  Norwegian (Bokmal)
71             2068  Norwegian (Nynorsk)
72
73       If you are particularly interested in customizing this module's output
74       even more, see the source and/or write to me.
75

SEE ALSO

77       Pod::Simple, RTF::Writer, RTF::Cookbook, RTF::Document, RTF::Generator
78

80       Copyright (c) 2002 Sean M. Burke.  All rights reserved.
81
82       This library is free software; you can redistribute it and/or modify it
83       under the same terms as Perl itself.
84
85       This program is distributed in the hope that it will be useful, but
86       without any warranty; without even the implied warranty of mer‐
87       chantability or fitness for a particular purpose.
88

AUTHOR

90       Sean M. Burke "sburke@cpan.org"
91
92
93
94perl v5.8.8                       2003-11-02               Pod::Simple::RTF(3)
Impressum