API:EPrints/Apache/Template - Revision history

Pod2wiki at 17:25, 15 March 2023

2023-03-15T17:25:18Z

Pod2wiki at 17:25, 15 March 2023

2023-03-15T17:25:08Z

Pod2wiki at 22:52, 14 December 2021

2021-12-14T22:52:44Z

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

Tdb01r at 11:11, 18 April 2012

2012-04-18T11:11:31Z

Tdb01r at 11:10, 18 April 2012

2012-04-18T11:10:18Z

Tdb01r at 11:08, 18 April 2012

2012-04-18T11:08:58Z

Tdb01r at 11:08, 18 April 2012

2012-04-18T11:08:11Z

Tdb01r at 16:16, 16 April 2012

2012-04-16T16:16:42Z

@@ 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 -->

@@ Line 7: / Line 7: @@
 ==NAME==
 '''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%; '>
@@ Line 16: / Line 31: @@
 </div>
 <!-- Pod2Wiki=head_synopsis -->
-==SYNOPSIS==
+===Synopsis===
    &lt;?xml version="1.0" standalone="no"?&gt;
    &lt;!DOCTYPE html SYSTEM "entities.dtd"&gt;
@@ 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>
@@ Line 48: / Line 48: @@
 <!-- Pod2Wiki=head_custom_pins -->
 ===Custom Pins===
-In <tt>cfg.d/dynamic_template.pl</tt>:
+In ''cfg.d/dynamic_template.pl'':
    $c-&gt;{dynamic_template}-&gt;{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):
    &lt;epc:pin ref="mypin" /&gt;
@@ Line 107: / Line 107: @@
 ====login_status_header====
-HTML &lt;head&gt; includes for the login status of the user - currently just some JavaScript variables.
+HTML <tt>&lt;head</tt>&gt; 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%; '>
@@ Line 119: / Line 119: @@
 ====head====
-Page-specific HTML &lt;head&gt; contents.
+Page-specific HTML <tt>&lt;head</tt>&gt; contents.
 <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====
-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 &lt;ul&gt; 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>&lt;ul</tt>&gt; 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%; '>
@@ Line 190: / Line 190: @@
 <!-- Pod2Wiki=head_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%; '>
@@ 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 -->

@@ Line 159: / Line 159: @@
 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>
@@ Line 167: / Line 176: @@
 </div>
 <!-- Pod2Wiki=item_handler -->
-====$rc = EPrints::Apache::Template::handler( $r )====
+===handler===
 Handler for applying site layout templates.

@@ Line 14: / Line 14: @@
 <!-- Pod2Wiki=head_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">
 <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:
-<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" >
 <xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control">

@@ Line 14: / Line 14: @@
 <!-- Pod2Wiki=head_synopsis -->
 ==SYNOPSIS==
-<source lang="perl
+<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">
@@ Line 52: / Line 50: @@
 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"  ?>
 <!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">
@@ Line 102: / Line 98: @@
 In <code>cfg.d/dynamic_template.pl</code>:
-<source lang="perl
+<source lang="perl">$c->{dynamic_template}->{function} = sub {
 	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):
-<source lang="perl
+<source lang="perl"><epc:pin ref="mypin" /></source>
 Or, for just the text content of a pin:
-<source lang="perl
+<source lang="perl"><epc:pin ref="mypin" textonly="yes" /></source>
 <!-- Edit below this comment -->

@@ Line 14: / Line 14: @@
 <!-- Pod2Wiki=head_synopsis -->
 ==SYNOPSIS==
-<source lang="xml
+<source lang="perl
 "><?xml version="1.0" standalone="no"?>
@@ Line 52: / Line 52: @@
 Static files with the ''.xpage'' extension are rendered using templates:
-<pre>  &lt;?xml version="1.0" encoding="utf-8"  standalone="no"  ?&gt;
+<source lang="perl
-  &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;
+"><?xml version="1.0" encoding="utf-8"  standalone="no"  ?>
-    &lt;xpage:template&gt;default&lt;/xpage:template&gt;
+<!DOCTYPE page SYSTEM "entities.dtd" >
-    &lt;xpage:head&gt;
+<xpage:page xmlns="http://www.w3.org/1999/xhtml" xmlns:xpage="http://eprints.org/ep3/xpage" xmlns:epc="http://eprints.org/ep3/control">
-      &lt;style type="text/css"&gt;h1 { text-weight: bold }&lt;/style&gt;
+	<xpage:template>default</xpage:template>
-    &lt;/xpage:head&gt;
+	<xpage:head>
-    &lt;xpage:title&gt;My first XPage&lt;/xpage:title&gt;
+		<style type="text/css">h1 { text-weight: bold }</style>
-    &lt;xpage:body&gt;
+	</xpage:head>
-      Writing XPages is easy.
+	<xpage:title>My first XPage</xpage:title>
-    &lt;/xpage:body&gt;
+	<xpage:body>
-  &lt;/xpage:page&gt;</pre>
+		Writing XPages is easy.
 <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).
@@ Line 100: / Line 102: @@
 In <code>cfg.d/dynamic_template.pl</code>:
-<pre>  $c-&gt;{dynamic_template}-&gt;{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>
 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>
+<source lang="perl
 Or, for just the text content of a pin:
-<pre>  &lt;epc:pin ref="mypin" textonly="yes" /&gt;</pre>
+<source lang="perl
 <!-- Edit below this comment -->

@@ Line 18: / Line 18: @@
 <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>
+    <title><epc:pin ref="title" textonly="yes"/> - <epc:phrase ref="archive_name"/></title>
-   ...</source>
+    <epc:pin ref="head" />
 <!-- Edit below this comment -->
@@ Line 64: / Line 71: @@
 <!-- Pod2Wiki=head_default_pins -->
 ===Default Pins===
 * title
 : The title of the page.
@@ Line 69: / Line 79: @@
 * page
 : The page content.
 * login_status
@@ Line 87: / Line 88: @@
 : The <code>render_action_link</code> from [[API:EPrints/Plugin/Screen/SetLang|EPrints::Plugin::Screen::SetLang]].
 <!-- Edit below this comment -->