Yukki::Web::Plugin::YukkiText - format text/yukki files using markdown, etc.
version 0.121790
# Plugins are not used directly... my $repo = $self->model('Repository', { name => 'main' }); my $file = $repo->file({ full_path => "some-file.yukki' }); my $html = $file->fetch_formatted($ctx);
Yukkitext formatting is based on Multi-Markdown, which is an extension to regular markdown that adds tables, metadata, and a few other tidbits. In addition to this, yukkitext adds linking using double-bracket notation:
[[ A Link ]] [[ ./A Sub-Page Link ]] [[ ./A Sub-Dir/Sub-Page Link ]] [[ ./a-sub-dir/sub-page-link.pdf | Sub-Page PDF ]]
This link format is based loosely upon the format used by MojoMojo, which I was using prior to developing Yukki.
It also adds support for format helpers usinga double-curly brace notation:
{{attachment:Path/To/Attachment.pdf}} {{=:5 + 5}}
This returns the yukkitext formatter for "text/yukki".
This is the Text::MultiMarkdown object for rendering "yukkitext". Do not use.
Provides a format_markdown method delegated to markdown. Do not use.
format_markdown
markdown
Used to help render yukkilinks. Do not use.
Used to render plugged in markup. Do not use.
my $html = $view->yukkitext({ context => $ctx, repository => $repository_name, page => $page, file => $file, });
Yukkitext is markdown plus some extra stuff. The extra stuff is:
[[ main:/link/to/page.yukki | Link Title ]] - wiki link [[ /link/to/page.yukki | Link Title ]] - wiki link [[ /link/to/page.yukki ]] - wiki link {{attachment:file.pdf}} - attachment URL
Andrew Sterling Hanenkamp <hanenkamp@cpan.org>
This software is copyright (c) 2012 by Qubling Software LLC.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Yukki, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Yukki
CPAN shell
perl -MCPAN -e shell install Yukki
For more information on module installation, please visit the detailed CPAN module installation guide.