The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Yukki-0.111060
River stage zero No dependents
2 ++
/ Yukki::Web::View

NAME

Yukki::Web::View - base class for Yukki::Web views

VERSION

version 0.111060

DESCRIPTION

This is the base class for all Yukki::Web views.

ATTRIBUTES

app

This is the Yukki::Web singleton.

markdown

This is the Text::MultiMarkdown object for rendering "yukkitext". Do not use.

Provides a format_markdown method delegated to markdown. Do not use.

semantic

This is the Template::Semantic object that transforms the templates. Do not use.

METHODS

render_page

  my $document = $self->render_page({
      template => 'foo.html',
      context  => $ctx,
      vars     => { ... },
  });

This renders the given template and places it into the content section of the shell.html template.

The context is used to render parts of the shell template.

The vars are processed against the given template with Template::Semantic.

  my $document = $self->render_links(\@navigation_links);

This renders a set of links using the links.html template.

render

  my $document = $self->render({
      template => 'foo.html',
      vars     => { ... },
  });

This renders the named template using Template::Semantic. The vars are used as the ones passed to the process method.

Used to help render yukkilinks. Do not use.

yukkiplugin

Used to render plugged in markup. Do not use.

yukkitext

  my $html = $view->yukkitext({
      repository => $repository_name,
      yukkitext  => $yukkitext,
  });

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

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 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.