Pod::Simple::Wiki::Template(3pm)

1Pod::Simple::Wiki::TempUlsaetre(C3o)ntributed Perl DocumPeondt:a:tSiiomnple::Wiki::Template(3)
2
3
4

NAME

6       Pod::Simple::Wiki::Template - A class for creating Pod to Template wiki
7       filters.
8

SYNOPSIS

10       This module isn't used directly. Instead it is called via
11       "Pod::Simple::Wiki":
12
13           #!/usr/bin/perl -w
14
15           use strict;
16           use Pod::Simple::Wiki;
17
18
19           my $parser = Pod::Simple::Wiki->new('template');
20
21           ...
22
23       Convert Pod to a Template wiki format using the installed "pod2wiki"
24       utility:
25
26           pod2wiki --style template file.pod > file.wiki
27

DESCRIPTION

29       This module is used as a boiler plate or example of how to create a new
30       "Pod::Simple::Wiki::" module. See the Portme section below.
31
32       The "Pod::Simple::Wiki::Template" module is used for converting Pod
33       text to Wiki text.
34
35       Pod (Plain Old Documentation) is a simple markup language used for
36       writing Perl documentation.
37
38       For an introduction to Template see: http://www.portme.org
39
40       This module isn't generally invoked directly. Instead it is called via
41       "Pod::Simple::Wiki". See the Pod::Simple::Wiki and pod2wiki
42       documentation for more information.
43

PORTME

45       This module is used as a boiler plate or example of how to create a new
46       "Pod::Simple::Wiki::" module.
47
48       If you are thinking of creating a new "Pod::Simple::Wiki::" you should
49       use this module as a basis.
50
51       Portme. Any comments in the code or documentation that begin with or
52       contain the word "portme" are intended for the "porter", the person who
53       is creating the new module. You should read all of the "portme"
54       comments and eventully delete them when the module is finished.
55
56       The following are some suggested steps in porting the module. For the
57       sake of example say we wish to convert Pod to a format called
58       "portmewiki". Also for the sake of this example we will assume that you
59       know how to install and work on a module or work on it in a local
60       source tree using "-I./lib" or "-Mblib".
61
62   Portme Step 1
63       Copy the "/lib/Pod/Simple/Wiki/Template.pm" to a new module
64       "/lib/Pod/Simple/Wiki/Portmewiki.pm".
65
66       The module name should have the first letter capitalised and all others
67       lowercase, i.e, the same as returned by "ucfirst()".
68
69   Portme Step 2
70       Edit the module and replace all instances of "Template" with
71       "Portmewiki" (case sensitive).
72
73       Then replace all instances of "template" with "portmewiki" (case
74       sensitive).
75
76   Portme Step 3
77       The module should now work and can now be called as follows:
78
79           use Pod::Simple::Wiki;
80
81           my $parser = Pod::Simple::Wiki->new('portmewiki');
82
83       The default output format, in this configuration is Kwiki.
84
85   Portme Step 4
86       Write some tests.
87
88       Copy the tests in the "/t" directory for one of formats that is similar
89       to the format that you are porting.
90
91   Portme Step 5
92       Modify the source of "Portmewiki.pm" until all the tests pass and you
93       are happy with the output format.
94
95       Start by modifying the "tags" and then move on to the other methods.
96
97       If you encounter problems then you can turn on internal debugging:
98
99           my $parser = Pod::Simple::Wiki->new('portmewiki');
100           $parser->_debug(1);
101
102           Or for more debug information that you can deal with:
103
104           # At the start of your program and before anything else:
105           use Pod::Simple::Debug (5);
106
107           ...
108
109           $parser->_debug(0);
110
111       If you find yourself with a difficult porting issue then you may also
112       wish to read Pod::Simple::Methody and Pod::Simple::Subclassing.
113
114       Try to maintain the code style of this module. See the source for more
115       information.
116
117   Portme Step 6
118       Remove or replace all "portme" comments.
119
120   Portme Step 7
121       Send it to me the tarred directory with libs and tests and I'll release
122       it to CPAN.
123

METHODS

125       Pod::Simple::Wiki::Template inherits all of the methods of
126       "Pod::Simple" and "Pod::Simple::Wiki". See Pod::Simple and
127       Pod::Simple::Wiki for more details.
128

Template Specific information

130       Portme: Add some information specific to the Template format or this
131       module here. If required.
132

ACKNOWLEDGEMENTS

138       Thanks to Portme McPortme and Portme O'Portme for patches,
139       documentation or bugfixes.
140

DISCLAIMER OF WARRANTY

142       Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
143

AUTHORS

145       John McNamara jmcnamara@cpan.org
146
147       Portme McPortme portme@portme.org
148

COPYRIGHT

150       AX MMIII-MMVIII, John McNamara.
151
152       All Rights Reserved. This module is free software. It may be used,
153       redistributed and/or modified under the same terms as Perl itself.
154
155
156
157perl v5.12.0                      2008-05-24    Pod::Simple::Wiki::Template(3)