API:EPrints/Apache/Template
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::Apache::Template - Template Applying Module
DESCRIPTION
When HTML pages are served by EPrints they are processed through a template written in XML. Most repositories will have two templates - default.xml for HTTP and secure.xml for HTTPS.
Templates are parsed at server start-up and any included phrases are replaced at that point. Because templates persist over the lifetime of a server you do not typically perform any logic within the template itself, instead use a pin generated via Custom Pins.
The page content is added to the template via <epc:pins>.
Synopsis
<?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> ...
Custom Pins
In cfg.d/dynamic_template.pl:
$c->{dynamic_template}->{function} = sub {
my( $repo, $parts ) = @_;
$parts->{mypin} = $repo->xml->create_text_node( "Hello, World!" );
};
In archives/[archiveid]/cfg/templates/default.xml (copy from lib/templates/default.xml if not already exists):
<epc:pin ref="mypin" />
Or, for just the text content of a pin:
<epc:pin ref="mypin" textonly="yes" />
Default Pins
title
The title of the page.
page
The page content.
login_status_header
HTML <head> includes for the login status of the user - currently just some JavaScript variables.
head
Page-specific HTML <head> contents.
pagetop
(Unused?)
login_status
A menu containing EPrints::Plugin::Screens that appear in key_tools. The content from each plugin's render_action_link is rendered as a HTML <ul> list.
Historically this was the login/logout links plus key_tools but since 3.3 login/logout are Screen plugins as well.
languages
The render_action_link from EPrints::Plugin::Screen::SetLang.
METHODS
handler
$rc = EPrints::Apache::Template::handler( $r )
Handler for applying site layout templates.
SEE ALSO
The directories scanned for template sources are in EPrints::Repository/template_dirs.
COPYRIGHT
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 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 3.4. If not, see http://www.gnu.org/licenses/.
