OpenGuides::Template - Do Template Toolkit related stuff for OpenGuides applications.


Does all the Template Toolkit stuff for OpenGuides. Distributed and installed as part of the OpenGuides project, not intended for independent installation. This documentation is probably only useful to OpenGuides developers.


  use Config::Tiny;
  use OpenGuides::Utils;
  use OpenGuides::Template;

  my $config = Config::Tiny->read('wiki.conf');
  my $wiki = OpenGuides::Utils->make_wiki_object( config => $config );

  print OpenGuides::Template->output( wiki     => $wiki,
                                      config   => $config,
                                      template => "",
                                      vars     => { foo => "bar" }


  print OpenGuides::Template->output( wiki         => $wiki,
                                      config       => $config,
                                      template     => "",
                                      content_type => "text/html",
                                      cookies      => $cookie,
                                      vars         => {foo => "bar"}

Returns everything you need to send to STDOUT, including the Content-Type: header. Croaks unless template is supplied.

The variables supplied in vars are passed through to the template specified. Additional Template Toolkit variables are automatically set and passed through as well, as described below. Note: variables set in vars will over-ride any variables of the same name in the config object or the user cookies.

  • openguides_version

  • site_name

  • cgi_url

  • full_cgi_url

  • enable_page_deletion (gets set to true or false - defaults to false)

  • contact_email

  • stylesheet

  • home_link

  • formatting_rules_link (unless omit_formatting_link is set in user cookie)

  • navbar_on_home_page

  • home_name

    If node is supplied:

    * node_name

    * node_param (the node name escaped for use in URLs)

Content-Type: defaults to text/html and is omitted if the content_type arg is explicitly set to the blank string.

  my %node_data = $wiki->retrieve_node( "Home Page" );

  my %metadata_vars = OpenGuides::Template->extract_metadata_vars(
                                        wiki     => $wiki,
                                        config   => $config,
                                        metadata => $node_data{metadata} );

  # -- or --

  my %metadata_vars = OpenGuides::Template->extract_metadata_vars(
                                        wiki     => $wiki,
                                        config   => $config,
                                        cgi_obj  => $q );

  # -- then --

  print OpenGuides::Template->output( wiki     => $wiki,
                                      config   => $config,
                                      template => "",
                                      vars     => { foo => "bar",
                                                    %metadata_vars }

Picks out things like categories, locales, phone number etc from EITHER the metadata hash returned by CGI::Wiki OR the query parameters in a CGI object, and packages them nicely for passing to templates or storing in CGI::Wiki datastore. If you supply both metadata and cgi_obj then metadata will take precedence, but don't do that.


The OpenGuides Project (


  Copyright (C) 2003 The OpenGuides Project.  All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 91:

You can't have =items (as at line 95) unless the first thing after the =over is an =item