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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
package MojoMojo::Formatter;
=head1 NAME
MojoMojo::Formatter - Base class for all formatters
=head1 SYNOPSIS
package MojoMojo::Formatter::Simple;
use parent qw/MojoMojo::Formatter/;
sub format_content_order { 14 }
# so that it runs after inclusion of obscene web sites
# (MojoMojo::Formatter::Include runs at 6)
sub format_content {
my ($class, $content, $c) = @_;
$$content =~ s/fuck/f**k/g;
return $content;
}
=head1 DESCRIPTION
This is the class to inherit from if you want to write your own formatter.
=head1 WRITING YOUR OWN FORMATTER
See the synopsis for a really simple formatter example. MojoMojo uses
L<Module::Pluggable::Ordered> to process all the formatter plugins. Just
specify when you want to trigger your formatter by providing a format_content_order
method which returns a number to specify when you want to run. The plugin order
for the default plugins is currently as follows:
=over 4
=item 1 - L<MojoMojo::Formatter::Redirect> - handles {{redirect /path}}
=item 5 - L<MojoMojo::Formatter::Include> - handles {{include <url>}} before
all other plugins, so that transcluded sections from the same wiki get parsed
for markup
=item 10 - L<MojoMojo::Formatter::CPANHyperlink> - handles {{cpan My::Module}}
=item 10 - L<MojoMojo::Formatter::YouTube> - handles {{youtube <url>}}
=item 10 - L<MojoMojo::Formatter::Wiki> - handles [[wikilinks]]
=item 10 - L<MojoMojo::Formatter::Pod> - handles {{pod}} ... {{end}} blocks
=item 14 - L<MojoMojo::Formater::IRCLog> - handles {{irc}} ... {{end}} blocks
=item 14 - L<MojoMojo::Formatter::SyntaxHighlight> - Performs syntax highlighting
on code blocks
=item 15 - Main formatter (L<MojoMojo::Formatter::Markdown> or
L<MojoMojo::Formatter::Textile>)
=item 16 - L<MojoMojo::Formatter::Defang> - removes harmful HTML and XSS
=item 91 - L<MojoMojo::Formatter::Comment> - handles {{comments}}, inserts a comment box
=item 95 - L<MojoMojo::Formatter::TOC> - replaces {{toc}} with a table of contents
=back
Note that if your formatter expects HTML text, it should run after the
main formatter.
=head1 METHODS
=head2 format_content
If you want your formatter to do something, you also need to override
C<format_content>. It gets passed its classname, a scalar ref to the content,
and the context object. It should return the scalar ref.
=head2 main_format_content
Override this method if your formatter is a primary one (equivalent to Markdown or
Textile). It gets passed the same arguments as L</format_content>. Also make sure
to update "Site settings" (/.admin).
Note that the main formatter runs at 15.
=head2 module_loaded
Return true if a formatter module is loaded.
=cut
sub module_loaded { 1; }
=head2 gen_re
gen_re(qr/irc/)
Returns a regular expression for the given tag between matching double braces.
=cut
sub gen_re {
my ($self, $tag, $args)=@_;
$args ||= '';
return qr[{{\s*$tag\s*$args\s*}}];
}
=head1 SEE ALSO
L<MojoMojo>, L<MojoMojo::Formatter::Textile>, L<MojoMojo::Formatter::Markdown>
=head1 AUTHORS
Marcus Ramberg <mramberg@cpan.org>
=head1 LICENSE
This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
1;
|
