---
name: "MojoMojo::Formatter"
section: "3pm"
platform: "linux"
package: "libmojomojo-perl"
version: "1.12+dfsg-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/MojoMojo::Formatter"
---

# MojoMojo::Formatter(3pm)

Base class for all formatters

## 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.