Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wiki::toolkit::formatter::default(3pm) [debian 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)

Check Out this Related Man Page

Wiki::Toolkit::Plugin::RSS::Reader(3pm) 		User Contributed Perl Documentation		   Wiki::Toolkit::Plugin::RSS::Reader(3pm)

NAME

       Wiki::Toolkit::Plugin::RSS::Reader - retrieve RSS feeds for inclusion in Wiki::Toolkit nodes

DESCRIPTION

       Use this Wiki::Toolkit plugin to retrieve an RSS feed from a given URL so that you can include it in a wiki node.

SYNOPSIS

	   use Wiki::Toolkit::Plugin::RSS::Reader;

	   my $rss = Wiki::Toolkit::Plugin::RSS::Reader->new(
	     url   => 'http://example.com/feed.rss'
	   );

	   my @items = $rss->retrieve;

USAGE

       This is a plugin for Wiki::Toolkit, a toolkit for building wikis; therefore please consult the documentation for Wiki::Toolkit for relevant
       information.  This module can, however, be used standalone if you wish.

METHODS

   "new"
	   my $rss = Wiki::Toolkit::Plugin::RSS::Reader->new([options]);

       Create a new RSS reader. Valid options are "url" or "file" (a path to an RSS file); only one can be specified.

   "retrieve"
	   my @items = $rss->retrieve;

       "retrieve" will return an array of hashes, one for each item in the RSS feed. The hashes contain three items, "title", "link", and
       "description".

       If the URL or file you specified cannot be retrieved/read, "retrieve" will return undef rather than blowing up and surprising the person
       reading your wiki. If you want, you can specify "debug" to be 1 in the options to "new", which will cause the module to croak instead of
       failing silently.

AUTHOR

       Earle Martin (EMARTIN@cpan.org) The Wiki::Toolkit team, (http://www.wiki-toolkit.org/)

LEGAL

       Copyright 2004 Earle Martin.  Copyright 2006 the Wiki::Toolkit team.

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

perl v5.10.1							    2009-10-25				   Wiki::Toolkit::Plugin::RSS::Reader(3pm)
Man Page