| Pod-Simple-Wiki-Wikka documentation | Contained in the Pod-Simple-Wiki-Wikka distribution. |
Pod::Simple::Wiki::Wikka - A class for creating Pod to Wikka wiki filters.
This module isn't used directly. Instead it is called via Pod::Simple::Wiki:
#!/usr/bin/perl -w
use strict;
use Pod::Simple::Wiki;
my $parser = Pod::Simple::Wiki->new('Wikka');
...
Convert Pod to a WakkaWiki wiki format using the installed pod2wiki utility:
pod2wiki --style template file.pod > file.wiki
The Pod::Simple::Wiki::Wikka module is used for converting Pod text to Wiki text.
Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation.
For an introduction to WakkaWiki see: http://docs.wikkawiki.org/WakkaWiki
This module isn't generally invoked directly. Instead it is called via Pod::Simple::Wiki. See the Pod::Simple::Wiki and pod2wiki documentation for more information.
Pod::Simple::Wiki::Wikka inherits all of the methods of Pod::Simple and Pod::Simple::Wiki. See Pod::Simple and Pod::Simple::Wiki for more details.
This module also installs a pod2wiki command line utility. See pod2wiki --help for details.
Thanks to Portme McPortme and Portme O'Portme for patches, documentation or bugfixes.
Nov 21, 2008 - Fixed bug in test script. (No changes to actual code.)
Nov 20, 2008 - Inital release.
Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
John McNamara jmcnamara@cpan.org
Daniel T Staal DStaal@usa.net
Copyright 2008, Daniel T. Staal, adapted from boilerplate by John McNamara.
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
| Pod-Simple-Wiki-Wikka documentation | Contained in the Pod-Simple-Wiki-Wikka distribution. |
package Pod::Simple::Wiki::Wikka; use Pod::Simple::Wiki; use strict; use vars qw(@ISA $VERSION); @ISA = qw(Pod::Simple::Wiki); $VERSION = '0.09'; ############################################################################### # # The tag to wiki mappings. # my $tags = { '<b>' => '**', '</b>' => '**', '<i>' => '//', '</i>' => '//', '<tt>' => '##', '</tt>' => '##', '<pre>' => '', '</pre>' => "\n\n", '<h1>' => "\n====== ", '</h1>' => " ======\n\n", '<h2>' => "\n===== ", '</h2>' => " =====\n\n", '<h3>' => "\n==== ", '</h3>' => " ====\n\n", '<h4>' => "\n=== ", '</h4>' => " ===\n\n", }; ############################################################################### # # new() # # Simple constructor inheriting from Pod::Simple::Wiki. # sub new { my $class = shift; my $self = Pod::Simple::Wiki->new('wiki', @_); $self->{_tags} = $tags; bless $self, $class; return $self; } ############################################################################### # # _indent_item() # # Indents an "over-item" to the correct level. # sub _indent_item { my $self = shift; my $item_type = $_[0]; my $item_param = $_[1]; my $indent_level = $self->{_item_indent}; if ($item_type eq 'bullet') { $self->_append('~' x $indent_level . '- '); } elsif ($item_type eq 'number') { $self->_append('~' x $indent_level . '1) '); } elsif ($item_type eq 'text') { $self->_append('~' x $indent_level . ''); } } ############################################################################### # # _handle_text() # # Perform any necessary transforms on the text. This is mainly used to escape # inadvertent CamelCase words. # sub _handle_text { my $self = shift; my $text = $_[0]; # Only escape words in paragraphs if (not $self->{_in_Para}) { $self->{_wiki_text} .= $text; return; } # Split the text into tokens but maintain the whitespace my @tokens = split /(\s+)/, $text; # Portme: # Escape any tokens here, if necessary. # Rejoin the tokens and whitespace. $self->{_wiki_text} .= join '', @tokens; } ############################################################################### # # Functions to deal with =over ... =back regions for # # Bulleted lists # Numbered lists # Text lists # Block lists # sub _end_item_text {$_[0]->_output("\n")} ############################################################################### # # _start_Para() # # Special handling for paragraphs that are part of an "over" block. # sub _start_Para { my $self = shift; my $indent_level = $self->{_item_indent}; if ($self->{_in_over_block}) { # Do something here is necessary } } 1; __END__