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 eventually 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       Fork, clone or download the latest version of "Pod::Simple::Wiki" from
64       the github repository: <http://github.com/jmcnamara/pod-simple-wiki/>
65
66       Copy the "/lib/Pod/Simple/Wiki/Template.pm" to a new module
67       "/lib/Pod/Simple/Wiki/Portmewiki.pm".
68
69       The module name should have the first letter capitalised and all others
70       lowercase, i.e, the same as returned by "ucfirst()".
71
72   Portme Step 2
73       Edit the module and replace all instances of "Template" with
74       "Portmewiki" (case sensitive).
75
76       Then replace all instances of "template" with "portmewiki" (case
77       sensitive).
78
79   Portme Step 3
80       The module should now work and can now be called as follows:
81
82           use Pod::Simple::Wiki;
83
84           my $parser = Pod::Simple::Wiki->new('portmewiki');
85
86       The default output format, in this configuration is Kwiki.
87
88   Portme Step 4
89       Write some tests.
90
91       Copy the tests in the "/t" directory for one of formats that is similar
92       to the format that you are porting.
93
94   Portme Step 5
95       Modify the source of "Portmewiki.pm" until all the tests pass and you
96       are happy with the output format.
97
98       Start by modifying the "tags" and then move on to the other methods.
99
100       If you encounter problems then you can turn on internal debugging:
101
102           my $parser = Pod::Simple::Wiki->new('portmewiki');
103           $parser->_debug(1);
104
105           Or for more debug information that you can deal with:
106
107           # At the start of your program and before anything else:
108           use Pod::Simple::Debug (5);
109
110           ...
111
112           $parser->_debug(0);
113
114       If you find yourself with a difficult porting issue then you may also
115       wish to read Pod::Simple::Methody and Pod::Simple::Subclassing.
116
117       Try to maintain the code style of this module. See the source for more
118       information.
119
120   Portme Step 6
121       Remove or replace all "portme" comments.
122
123   Portme Step 7
124       Send me a git pull request on Github with libs and tests and I'll
125       release it to CPAN.
126

METHODS

128       Pod::Simple::Wiki::Template inherits all of the methods of
129       "Pod::Simple" and "Pod::Simple::Wiki". See Pod::Simple and
130       Pod::Simple::Wiki for more details.
131

Template Specific information

133       Portme: Add some information specific to the Template format or this
134       module here. If required.
135

ACKNOWLEDGEMENTS

141       Thanks to Portme McPortme and Portme O'Portme for patches,
142       documentation or bugfixes.
143

DISCLAIMER OF WARRANTY

145       Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
146

AUTHORS

148       John McNamara jmcnamara@cpan.org
149
150       Portme McPortme portme@portme.org
151

COPYRIGHT

153       MMIII-MMXV, John McNamara.
154
155       All Rights Reserved. This module is free software. It may be used,
156       redistributed and/or modified under the same terms as Perl itself.
157
158
159
160perl v5.34.0                      2021-07-22    Pod::Simple::Wiki::Template(3)