View source for API:perl lib/EPrints/Apache/Template.pm

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Apache/Template.pm|package_name=perl_lib/EPrints/Apache/Template.pm}}[[Category:API|PERL_LIB/EPRINTS/APACHE/TEMPLATE.PM]][[Category:API:perl_lib/EPrints/Apache/Template.pm|PERL_LIB/EPRINTS/APACHE/TEMPLATE.PM]][[Category:API:perl_lib/EPrints/Apache/Template.pm|PERL_LIB/EPRINTS/APACHE/TEMPLATE.PM]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''EPrints::Apache::Template''' - Template Applying Module

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_synopsis -->
==SYNOPSIS==
<source lang="perl"><?xml version="1.0" standalone="no"?>
<!DOCTYPE html SYSTEM "entities.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">
  <head>
	  <title><epc:pin ref="title" textonly="yes"/> - <epc:phrase ref="archive_name"/></title>
  ...</source>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
This module renders HTML page content using a template.

Templates are parsed and rendered at server start-up, expanding phrases and any EPC. If you need to include dynamic content in the page use use a pin generated via {{API:PodLink|file=perl_lib|package_name=perl_lib|section=EPrints|text=perl_lib/EPrints/Apache/Template.pm/Dynamic Pins}}.

The page title, content and other core page structures are supplied via {{API:PodLink|file=perl_lib|package_name=perl_lib|section=EPrints|text=perl_lib/EPrints/Apache/Template.pm/Default Pins}}.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_static_html_pages -->
===Static HTML Pages===
Static files with the ''.xpage'' extension are rendered using templates:

<pre>  &lt;?xml version="1.0" encoding="utf-8"  standalone="no"  ?&gt;
  &lt;!DOCTYPE page SYSTEM "entities.dtd" &gt;
  &lt;xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control"&gt;
    &lt;xpage:template&gt;default&lt;/xpage:template&gt;
    &lt;xpage:head&gt;
      &lt;style type="text/css"&gt;h1 { text-weight: bold }&lt;/style&gt;
    &lt;/xpage:head&gt;
    &lt;xpage:title&gt;My first XPage&lt;/xpage:title&gt;
    &lt;xpage:body&gt;
      Writing XPages is easy.
    &lt;/xpage:body&gt;
  &lt;/xpage:page&gt;</pre>

<code>&lt;xpage:template&gt;</code> is a special pin that, instead of supplying content to the template, changes the template used for rendering. The content is just the template name (without the ''.xml'' extension).

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_default_pins -->
===Default Pins===
* title
: The title of the page.

* page
: The page content.

* login_status_header
: HTML &lt;head&gt; includes for the login status of the user - currently just some JavaScript variables.

* head
: Page-specific HTML &lt;head&gt; contents.

* pagetop
: (Unused?)

* login_status
: A menu containing [[API:EPrints/Plugin/Screen|EPrints::Plugin::Screen]]s that appear in <code>key_tools</code>. The content from each plugin's <code>render_action_link</code> is rendered as a HTML &lt;ul&gt; list.

: Historically this was the login/logout links plus <code>key_tools</code> but since 3.3 login/logout are Screen plugins as well.

* languages
: The <code>render_action_link</code> from [[API:EPrints/Plugin/Screen/SetLang|EPrints::Plugin::Screen::SetLang]].

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_dynamic_pins -->
===Dynamic Pins===
In <code>cfg.d/dynamic_template.pl</code>:

<pre>  $c-&gt;{dynamic_template}-&gt;{function} = sub {
    my( $repo, $parts ) = @_;
  
    $parts->{mypin} = $repo->xml->create_text_node( "Hello, World!" );
  };</pre>

In <code>archives/[archiveid]/cfg/templates/default.xml</code> (copy from <code>lib/templates/default.xml</code> if not already exists):

<pre>  &lt;epc:pin ref="mypin" /&gt;</pre>

Or, for just the text content of a pin:

<pre>  &lt;epc:pin ref="mypin" textonly="yes" /&gt;</pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_methods -->
==METHODS==
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_see_also -->
==SEE ALSO==
The directories scanned for template sources are in [[API:EPrints/Repository#template_dirs|EPrints::Repository/template_dirs]].

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->