mojomojo::formatter::include(3pm) [debian man page]

MojoMojo::Formatter::Include(3pm)			User Contributed Perl Documentation			 MojoMojo::Formatter::Include(3pm)

   module_loaded
       Return true if the module is loaded.

NAME

       MojoMojo::Formatter::Include - Include files in your content.

DESCRIPTION

       Include files verbatim in your content, by writing {{include <url>}}. Can be used for transclusion from the same wiki, in which case the
       inline version of the page is pulled.

METHODS

   format_content_order
       Format order can be 1-99. The Include formatter runs on 5, before all formatters (except Redirect), so that included content (most often
       from the same wiki) can be parsed for markup.  To avoid markup interpretation, surround the {{include <url>}} with a "<div>":

	   <div>Some uninterpreted Markdown: {{include http://mysite.com/rawmarkdown.txt}}</div>

   format_content
       Calls the formatter. Takes a ref to the content as well as the context object.

   include <c> <url>
       Returns the content at the URL. Will store a cached version in "$c->cache".

SEE ALSO

       MojoMojo, Module::Pluggable::Ordered, URI::Fetch

AUTHORS

       Marcus Ramberg <mramberg@cpan.org>

LICENSE

       This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-08-07					 MojoMojo::Formatter::Include(3pm)

MojoMojo::Formatter(3pm)				User Contributed Perl Documentation				  MojoMojo::Formatter(3pm)

NAME

       MojoMojo::Formatter - Base class for all formatters

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;
	   }

DESCRIPTION

       This is the class to inherit from if you want to write your own formatter.

WRITING YOUR OWN FORMATTER

       See the synopsis for a really simple formatter example. MojoMojo uses 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:

       1  - MojoMojo::Formatter::Redirect - handles {{redirect /path}}
       5  - MojoMojo::Formatter::Include - handles {{include <url>}} before all other plugins, so that transcluded sections from the same wiki get
       parsed for markup
       10 - MojoMojo::Formatter::CPANHyperlink - handles {{cpan My::Module}}
       10 - MojoMojo::Formatter::YouTube - handles {{youtube <url>}}
       10 - MojoMojo::Formatter::Wiki - handles [[wikilinks]]
       10 - MojoMojo::Formatter::Pod - handles {{pod}} ... {{end}} blocks
       14 - MojoMojo::Formater::IRCLog - handles {{irc}} ... {{end}} blocks
       14 - MojoMojo::Formatter::SyntaxHighlight - Performs syntax highlighting on code blocks
       15 - Main formatter (MojoMojo::Formatter::Markdown or MojoMojo::Formatter::Textile)
       16 - MojoMojo::Formatter::Defang - removes harmful HTML and XSS
       91 - MojoMojo::Formatter::Comment - handles {{comments}}, inserts a comment box
       95 - MojoMojo::Formatter::TOC - replaces {{toc}} with a table of contents

       Note that if your formatter expects HTML text, it should run after the main formatter.

METHODS

   format_content
       If you want your formatter to do something, you also need to override "format_content". It gets passed its classname, a scalar ref to the
       content, and the context object. It should return the scalar ref.

   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
       "format_content". Also make sure to update "Site settings" (/.admin).

       Note that the main formatter runs at 15.

   module_loaded
       Return true if a formatter module is loaded.

   gen_re
	   gen_re(qr/irc/)

       Returns a regular expression for the given tag between matching double braces.

SEE ALSO

       MojoMojo, MojoMojo::Formatter::Textile, MojoMojo::Formatter::Markdown

AUTHORS

       Marcus Ramberg <mramberg@cpan.org>

LICENSE

       This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2010-05-23						  MojoMojo::Formatter(3pm)