API:EPrints/Apache/Template - Revision history

Pod2wiki at 17:25, 15 March 2023

2023-03-15T17:25:18Z

@@ Line 203: / Line 203: @@
 {{API:Copyright}}
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->

Pod2wiki at 17:25, 15 March 2023

2023-03-15T17:25:08Z

← Older revision		Revision as of 17:25, 15 March 2023
Line 7:		Line 7:
	==NAME==		==NAME==
	'''EPrints::Apache::Template''' - Template Applying Module		'''EPrints::Apache::Template''' - Template Applying Module

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_description -->
			==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 [[API:EPrints/Apache/Template#Custom_Pins\|Custom Pins]].

			The page content is added to the template via <tt><epc:pins</tt>>.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 16:		Line 31:
	</div>		</div>
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==~~SYNOPSIS~~==		===Synopsis===
	<?xml version="1.0" standalone="no"?>		<?xml version="1.0" standalone="no"?>
	<!DOCTYPE html SYSTEM "entities.dtd">		<!DOCTYPE html SYSTEM "entities.dtd">
Line 24:		Line 39:
	...		...

	~~<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>~~
	~~<span style='display:none'>User Comments</span>~~
	~~<!-- Edit below this comment -->~~


	~~<!-- Pod2Wiki= -->~~
	~~</div>~~
	~~<!-- Pod2Wiki=head_description -->~~
	~~==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 [[API:EPrints/Apache/Template#Custom_Pins\|Custom Pins]].

	~~The page content is added to the template via <epc:pins>.~~

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	<span style='display:none'>User Comments</span>		<span style='display:none'>User Comments</span>
Line 48:		Line 48:
	<!-- Pod2Wiki=head_custom_pins -->		<!-- Pod2Wiki=head_custom_pins -->
	===Custom Pins===		===Custom Pins===
	In ~~<tt>~~cfg.d/dynamic_template.pl~~</tt>~~:		In ''cfg.d/dynamic_template.pl'':

	$c->{dynamic_template}->{function} = sub {		$c->{dynamic_template}->{function} = sub {
Line 56:		Line 56:
	};		};

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

	<epc:pin ref="mypin" />		<epc:pin ref="mypin" />
Line 107:		Line 107:
	====login_status_header====		====login_status_header====

	HTML <head> includes for the login status of the user - currently just some JavaScript variables.		HTML <tt><head</tt>> includes for the login status of the user - currently just some JavaScript variables.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 119:		Line 119:
	====head====		====head====

	Page-specific HTML <head> contents.		Page-specific HTML <tt><head</tt>> contents.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 143:		Line 143:
	====login_status====		====login_status====

	A menu containing [[API:EPrints/Plugin/Screen\|EPrints::Plugin::Screen]]s that appear in <tt>key_tools</tt>. The content from each plugin's <tt>render_action_link</tt> is rendered as a HTML <ul> list.		A menu containing [[API:EPrints/Plugin/Screen\|EPrints::Plugin::Screen]]s that appear in <tt>key_tools</tt>. The content from each plugin's <tt>render_action_link</tt> is rendered as a HTML <tt><ul</tt>> list.

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

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 190:		Line 190:
	<!-- Pod2Wiki=head_see_also -->		<!-- Pod2Wiki=head_see_also -->
	==SEE ALSO==		==SEE ALSO==
	The directories scanned for template sources are in [[API:EPrints/Repository#template_dirs\|EPrints::Repository/template_dirs]].		The directories scanned for template sources are in [[API:EPrints/Repository#template_dirs\|EPrints::Repository/template_dirs]].

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 203:		Line 203:
	{{API:Copyright}}		{{API:Copyright}}
	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=befin -->
			COPYRIGHTCopyright 2023 University of Southampton. EPrints 3.4 is supplied by EPrints Services.

			http://www.eprints.org/eprints-3.4/

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=end -->
			COPYRIGHT<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	<span style='display:none'>User Comments</span>		<span style='display:none'>User Comments</span>
	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Pod2wiki at 22:52, 14 December 2021

2021-12-14T22:52:44Z

← Older revision		Revision as of 22:52, 14 December 2021
Line 159:		Line 159:
	The <tt>render_action_link</tt> from [[API:EPrints/Plugin/Screen/SetLang\|EPrints::Plugin::Screen::SetLang]].		The <tt>render_action_link</tt> from [[API:EPrints/Plugin/Screen/SetLang\|EPrints::Plugin::Screen::SetLang]].

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_methods -->
			==METHODS==
	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	<span style='display:none'>User Comments</span>		<span style='display:none'>User Comments</span>
Line 167:		Line 176:
	</div>		</div>
	<!-- Pod2Wiki=item_handler -->		<!-- Pod2Wiki=item_handler -->
	===~~=$rc = EPrints::Apache::Template::~~handler~~( $r )=~~===		===handler===

			$rc = EPrints::Apache::Template::handler( $r )
	Handler for applying site layout templates.		Handler for applying site layout templates.

Pod2wiki at 22:46, 14 December 2021

2021-12-14T22:46:28Z

Show changes

Tdb01r at 11:16, 18 April 2012

2012-04-18T11:16:29Z

← Older revision		Revision as of 11:16, 18 April 2012
Line 14:		Line 14:
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==SYNOPSIS==		==SYNOPSIS==
	<source lang="~~perl~~"><?xml version="1.0" standalone="no"?>		<source lang="xml"><?xml version="1.0" standalone="no"?>
	<!DOCTYPE html SYSTEM "entities.dtd">		<!DOCTYPE html SYSTEM "entities.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">		<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">
Line 50:		Line 50:
	Static files with the ''.xpage'' extension are rendered using templates:		Static files with the ''.xpage'' extension are rendered using templates:

	<source lang="~~perl~~"><?xml version="1.0" encoding="utf-8" standalone="no" ?>		<source lang="xml"><?xml version="1.0" encoding="utf-8" standalone="no" ?>
	<!DOCTYPE page SYSTEM "entities.dtd" >		<!DOCTYPE page SYSTEM "entities.dtd" >
	<xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control">		<xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control">

Tdb01r at 11:11, 18 April 2012

2012-04-18T11:11:31Z

← Older revision		Revision as of 11:11, 18 April 2012
Line 14:		Line 14:
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==SYNOPSIS==		==SYNOPSIS==
	<source lang="perl		<source lang="perl"><?xml version="1.0" standalone="no"?>

	"><?xml version="1.0" standalone="no"?>
	<!DOCTYPE html SYSTEM "entities.dtd">		<!DOCTYPE html SYSTEM "entities.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">		<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">
Line 52:		Line 50:
	Static files with the ''.xpage'' extension are rendered using templates:		Static files with the ''.xpage'' extension are rendered using templates:

	<source lang="perl		<source lang="perl"><?xml version="1.0" encoding="utf-8" standalone="no" ?>

	"><?xml version="1.0" encoding="utf-8" standalone="no" ?>
	<!DOCTYPE page SYSTEM "entities.dtd" >		<!DOCTYPE page SYSTEM "entities.dtd" >
	<xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control">		<xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control">
Line 102:		Line 98:
	In <code>cfg.d/dynamic_template.pl</code>:		In <code>cfg.d/dynamic_template.pl</code>:

	<source lang="perl		<source lang="perl">$c->{dynamic_template}->{function} = sub {

	">$c->{dynamic_template}->{function} = sub {
	my( $repo, $parts ) = @_;		my( $repo, $parts ) = @_;

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

	<source lang="perl		<source lang="perl"><epc:pin ref="mypin" /></source>

	"><epc:pin ref="mypin" /></source>

	Or, for just the text content of a pin:		Or, for just the text content of a pin:

	<source lang="perl		<source lang="perl"><epc:pin ref="mypin" textonly="yes" /></source>

	"><epc:pin ref="mypin" textonly="yes" /></source>

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 11:10, 18 April 2012

2012-04-18T11:10:18Z

← Older revision		Revision as of 11:10, 18 April 2012
Line 14:		Line 14:
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==SYNOPSIS==		==SYNOPSIS==
	<source lang="~~xml~~		<source lang="perl

	"><?xml version="1.0" standalone="no"?>		"><?xml version="1.0" standalone="no"?>
Line 52:		Line 52:
	Static files with the ''.xpage'' extension are rendered using templates:		Static files with the ''.xpage'' extension are rendered using templates:

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

	<code><xpage:template></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).		<code><xpage:template></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).
Line 100:		Line 102:
	In <code>cfg.d/dynamic_template.pl</code>:		In <code>cfg.d/dynamic_template.pl</code>:

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

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

	<~~pre~~> ~~<~~epc:pin ref="mypin" /~~>~~</~~pre~~>		<source lang="perl

			"><epc:pin ref="mypin" /></source>

	Or, for just the text content of a pin:		Or, for just the text content of a pin:

	<~~pre~~> ~~<~~epc:pin ref="mypin" textonly="yes" /~~>~~</~~pre~~>		<source lang="perl

			"><epc:pin ref="mypin" textonly="yes" /></source>

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 11:08, 18 April 2012

2012-04-18T11:08:58Z

← Older revision		Revision as of 11:08, 18 April 2012
Line 14:		Line 14:
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==SYNOPSIS==		==SYNOPSIS==
	<source lang="~~html~~		<source lang="xml

	"><?xml version="1.0" standalone="no"?>		"><?xml version="1.0" standalone="no"?>

Tdb01r at 11:08, 18 April 2012

2012-04-18T11:08:11Z

← Older revision		Revision as of 11:08, 18 April 2012
Line 14:		Line 14:
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==SYNOPSIS==		==SYNOPSIS==
	<source lang="~~perl~~"><?xml version="1.0" standalone="no"?>		<source lang="html

			"><?xml version="1.0" standalone="no"?>
	<!DOCTYPE html SYSTEM "entities.dtd">		<!DOCTYPE html SYSTEM "entities.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">		<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">

Tdb01r at 16:16, 16 April 2012

2012-04-16T16:16:42Z

← Older revision		Revision as of 16:16, 16 April 2012
Line 18:		Line 18:
	<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">		<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epc="http://eprints.org/ep3/control">
	<head>		<head>
	<title><epc:pin ref="title" textonly="yes"/> - <epc:phrase ref="archive_name"/></title>		<title><epc:pin ref="title" textonly="yes"/> - <epc:phrase ref="archive_name"/></title>
	~~...~~</source>		<epc:pin ref="head" />
			</head>
			<body>
			<div><epc:pin ref="login_status" /> <epc:pin ref="languages" /></div>
			<h1><epc:pin ref="title" /></h1>
			<p><epc:pin ref="body" /></p>
			</body>
			</html></source>

	<!-- Edit below this comment -->		<!-- Edit below this comment -->
Line 64:		Line 71:
	<!-- Pod2Wiki=head_default_pins -->		<!-- Pod2Wiki=head_default_pins -->
	===Default Pins===		===Default Pins===
			* head
			: Page-specific HTML <head> contents.

	* title		* title
	: The title of the page.		: The title of the page.
Line 69:		Line 79:
	* page		* page
	: The page content.		: 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		* login_status
Line 87:		Line 88:
	: The <code>render_action_link</code> from [[API:EPrints/Plugin/Screen/SetLang\|EPrints::Plugin::Screen::SetLang]].		: The <code>render_action_link</code> from [[API:EPrints/Plugin/Screen/SetLang\|EPrints::Plugin::Screen::SetLang]].

			* pagetop - <em>unused</em>
			* login_status_header - <em>unused</em>
	<!-- Edit below this comment -->		<!-- Edit below this comment -->