Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod2wiki(1p) [debian man page]

POD2WIKI(1p)						User Contributed Perl Documentation					      POD2WIKI(1p)

NAME

       pod2wiki - A utility to convert Pod documents to Wiki format.

SYNOPSIS

       pod2wiki [--style --noerrata --help --man] podfile [outfile]

	   Options:
	       --style	    wiki style (defaults to wiki. See --help)
	       --noerrata   don't generate a "POD ERRORS" section
	       --help	    brief help message
	       --man	    full documentation

DESCRIPTION

       This program is used for converting Pod text to Wiki text.

       Pod is Perl's Plain Old Documentation format. See "man perlpod" or "perldoc perlpod".

       A Wiki is a user extensible web site. It uses very simple mark-up that is converted to Html. For an introduction to Wikis see:
       http://en.wikipedia.org/wiki/Wiki

OPTIONS

       podfile
	   The input file that contains the Pod file to be converted. It can also be stdin.

       outfile
	   The converted output file in wiki format. Defaults to stdout if not specified.

       --style or -s
	   Sets the wiki style of the output. If no "style" is specified the program defaults to "wiki". The available options are:

	   wiki
	       This is the original Wiki format as used on Ward Cunningham's Portland repository of Patterns. See http://c2.com/cgi/wiki

	   kwiki
	       This is the format as used by Brian Ingerson's Kwiki: http://www.kwiki.org

	   usemod
	       This is the format used by the Usemod wikis. See: http://www.usemod.com/cgi-bin/wiki.pl

	   twiki
	       This is the format used by TWiki wikis.	See: http://twiki.org/

	   tiddlywiki
	       This is the format used by the TiddlyWiki.  See: http://www.tiddlywiki.com/

	   textile
	       The Textile markup format as used on GitHub. See: http://textile.thresholdstate.com/

	   wikipedia or mediawiki
	       This is the format used by Wikipedia and MediaWiki wikis.  See: http://www.mediawiki.org/

	   moinmoin
	       This is the format used by MoinMoin wikis.  See: http://moinmo.in/MoinMoinWiki

	   confluence
	       This is the format used by Confluence.  See: http://www.atlassian.com/software/confluence/

       --noerrata or -noe
	   Don't generate a "POD ERRORS" section at the end of the document. Equivalent to the "Pod::Simple::no_errata_section()" method.

       --help or -h
	   Print a brief help message and exits.

       --man or -m
	   Prints the manual page and exits.

DISCLAIMER OF WARRANTY

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

AUTHOR

       John McNamara jmcnamara@cpan.org

COPYRIGHT

       X MMIII-MMVIII, 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.

perl v5.10.1							    2009-08-26							      POD2WIKI(1p)

Check Out this Related Man Page

Wiki::Toolkit::Formatter::Default(3pm)			User Contributed Perl Documentation		    Wiki::Toolkit::Formatter::Default(3pm)

NAME

       Wiki::Toolkit::Formatter::Default - A formatter for Wiki::Toolkit.

DESCRIPTION

       A formatter backend for Wiki::Toolkit.

SYNOPSIS

	 my $store     = Wiki::Toolkit::Store::SQLite->new( ... );
	 # See below for parameter details.
	 my $formatter = Wiki::Toolkit::Formatter::Default->new( %config );
	 my $wiki      = Wiki::Toolkit->new( store     => $store,
					     formatter => $formatter );

METHODS

       new
	     my $formatter = Wiki::Toolkit::Formatter::Default->new(
			    extended_links  => 0,
			    implicit_links  => 1,
			    allowed_tags    => [qw(b i)],  # defaults to none
			    macros	    => {},
			    node_prefix     => 'wiki.cgi?node=' );

	   Parameters will default to the values shown above (apart from "allowed_tags", which defaults to allowing no tags).

	   o   macros - be aware that macros are processed after filtering out disallowed HTML tags.  Currently macros are just strings, maybe
	       later we can add in subs if we think it might be useful.

	   Macro example:

	     macros => { qr/(^|)@SEARCHBOX(|$)/ =>
			 qq(<form action="wiki.cgi" method="get">
			      <input type="hidden" name="action" value="search">
			      <input type="text" size="20" name="terms">
			      <input type="submit"></form>) }

       format
	     my $html = $formatter->format( $content );

	   Escapes any tags which weren't specified as allowed on creation, then interpolates any macros, then calls Text::WikiFormat::format
	   (with the config set up when new was called) to translate the raw Wiki language supplied into HTML.

SEE ALSO

       Wiki::Toolkit::Formatter::WikiLinkFormatterParent Wiki::Toolkit

AUTHOR

       Kake Pugh (kake@earth.li).

COPYRIGHT

	    Copyright (C) 2002-2003 Kake Pugh.	All Rights Reserved.
	    Copyright (C) 2006 the Wiki::Toolkit team. All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-09-25				    Wiki::Toolkit::Formatter::Default(3pm)
Man Page