Wiki::...Default(3pm)

✨ bestie, this is the manual page for Wiki::Toolkit::Formatter::Default — the Wiki::...Default(3pm) entry from User Contributed Perl Documentation. It’s giving formatter-backend main character energy, and we’re obsessed. 💖

🌸 NAME 🌸

Wiki::Toolkit::Formatter::Default — a formatter for Wiki::Toolkit. That’s the name reveal, periodt. 💅

🦋 DESCRIPTION 🦋

A formatter backend for Wiki::Toolkit. No cap, that’s the whole description — vibe check passed. ✨

✨ 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). 🫶

• extended_links defaults to 0.
• implicit_links defaults to 1.
• allowed_tags is shown as [qw(b i)] in the example, but the actual default is allowing no tags at all. 🙈
• macros defaults to {}. Heads up, bestie: macros are processed after filtering out disallowed HTML tags. Currently macros are just strings; maybe later subs can be added if we think it might be useful. 🧚
• node_prefix defaults to 'wiki.cgi?node='.

Macro example:

macros => { qr/(^|\b)\@SEARCHBOX(\b|$)/ =>
            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 );

It first escapes any tags that weren’t specified as allowed on creation. Then it interpolates any macros. Then it calls Text::WikiFormat::format (with the config set up when new was called) to translate the raw Wiki language supplied into HTML. The pipeline ate and left no crumbs. 🔥

🌈 SEE ALSO 🌈

Go give these a look, iykyk:

• 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. 🫶

---

🌸 ok bestie, that’s the whole page. Footer tea for the very end: perl v5.32.0, 2021-01-04, Wiki::...Default(3pm). Go be iconic with your formatter. 💅✨