Using Page ID in Templates - Revision history

Drn@ecs.soton.ac.uk: Removed reference to pagehooks

2024-07-17T15:12:40Z

Removed reference to pagehooks

Drn@ecs.soton.ac.uk at 11:39, 17 July 2024

2024-07-17T11:39:10Z

Drn@ecs.soton.ac.uk at 11:38, 17 July 2024

2024-07-17T11:38:38Z

Drn@ecs.soton.ac.uk at 11:38, 17 July 2024

2024-07-17T11:38:15Z

Drn@ecs.soton.ac.uk at 17:56, 6 February 2024

2024-02-06T17:56:10Z

Drn@ecs.soton.ac.uk at 17:55, 6 February 2024

2024-02-06T17:55:34Z

Drn@ecs.soton.ac.uk: Added advice about using the pin elsewhere.

2022-07-05T10:26:48Z

Added advice about using the pin elsewhere.

Drn@ecs.soton.ac.uk at 10:22, 5 July 2022

2022-07-05T10:22:55Z

Drn@ecs.soton.ac.uk: Tidied up layout

2022-07-05T10:21:47Z

Tidied up layout

Drn@ecs.soton.ac.uk: Added page about using Page ID to provide bespoke CSS per page.

2022-07-05T10:19:51Z

Added page about using Page ID to provide bespoke CSS per page.

New page

From [[EPrints 3.4.3]] onwards, it is possible to include the ID of a page dynamically into its template. This facilitates writing page-specific CSS to control the appearance of specific pages and the HTML elements they contain. This is acheived by setting a pin for the page ID, which is generated from the page being loaded. EPrints has two main types of pages:
:Static
; This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).
:Dynamic
; This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.

Depending on the type of page the page ID pin will take on a different form. AlL dynamic pages will use the class name of the Screen plugin, converting non-alphanumeric (nor underscore) characters into underscores. So <tt>EPrint::Edit</tt> becomes <tt>EPrint_Edit</tt>. Static pages will use the path of the static page, prepended by <tt>static</tt>. So the homepage which is on the root of the path will just have the page ID <tt>static</tt> whereas the information page will have the page ID <tt>static_information</tt>. Abstract pages will have the page ID <tt>static_abstract</tt> and browse view pages will have the Page ID <tt>static_view_year</tt> for the homepage of the year view <tt>static_view_year</tt> for an index of the year view and <tt>static_view_year_page</tt> for a listing for a particular year. Where a browse view may have additional menu pages like for different letters of the alphabet for the creators browse view, if you click to go to one of these menus the page ID will append <tt>_index</tt> (e.g. <tt>static_view_creators_index</tt>.

To apply the page ID pin to a template you need to use the markup <tt>{pin:page_id}</tt>. Let us say you want to add this page ID as the <tt>id</tt> to the <tt><body></tt> tag of the template this might look as follows:
<body id="page_{pin:page_id}">
This would further prepend the prefix <tt>page_</tt> to the ID of the body tag, so if you loaded an abstract page (after refreshing abstracts) it would look like:
<body id="page_static_abstract">
This could then be used in some custom CSS file to maybe reduce the size of the <tt><h1></tt> heading because your publications have very long titles and the font size is too large for abstract pages. E.g.
#page_static_abstract h1#page-title {
font-size: 1.8em;
}

[[Category:Howto]] [[Category::Documentation]]

@@ Line 1: / Line 1: @@
 From [[EPrints 3.4.3]] onwards, it is possible to include the ID of a page dynamically into its template.  This facilitates writing page-specific CSS to control the appearance of specific pages and the HTML elements they contain.  This is acheived by setting a pin for the page ID, which is generated from the page being loaded.  EPrints has two main types of pages:
 ;Static
-:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).  It may already be possible to do this using page hooks.  Example configuration under <code>$c->{pagehooks}</code> can be found in the [[misc.pl]] configuration file.
+:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).
 ;Dynamic
 :This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.
@@ Line 16: / Line 16: @@
+  }
 You can place the markup for the page ID pin under whichever attribute of whatever element you want. It will only work in template files and not in static, citation or workflow files.
 [[Category:Howto]]
 [[Category:Manual]]

@@ Line 1: / Line 1: @@
 From [[EPrints 3.4.3]] onwards, it is possible to include the ID of a page dynamically into its template.  This facilitates writing page-specific CSS to control the appearance of specific pages and the HTML elements they contain.  This is acheived by setting a pin for the page ID, which is generated from the page being loaded.  EPrints has two main types of pages:
 ;Static
-:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).  It page already be possible to do this using page hooks.  Example configuration under <code>$c->{pagehooks}</code> can be found in the [[misc.pl]] configuration file.
+:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).  It may already be possible to do this using page hooks.  Example configuration under <code>$c->{pagehooks}</code> can be found in the [[misc.pl]] configuration file.
 ;Dynamic
 :This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.

@@ Line 1: / Line 1: @@
 From [[EPrints 3.4.3]] onwards, it is possible to include the ID of a page dynamically into its template.  This facilitates writing page-specific CSS to control the appearance of specific pages and the HTML elements they contain.  This is acheived by setting a pin for the page ID, which is generated from the page being loaded.  EPrints has two main types of pages:
 ;Static
-:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).  It page already be possible to do this using page hooks.  Example configuration under <code>$c->{pagehooks</code> can be found in the [[misc.pl]] configuration file.
+:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).  It page already be possible to do this using page hooks.  Example configuration under <code>$c->{pagehooks}</code> can be found in the [[misc.pl]] configuration file.
 ;Dynamic
 :This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.

@@ Line 1: / Line 1: @@
 From [[EPrints 3.4.3]] onwards, it is possible to include the ID of a page dynamically into its template.  This facilitates writing page-specific CSS to control the appearance of specific pages and the HTML elements they contain.  This is acheived by setting a pin for the page ID, which is generated from the page being loaded.  EPrints has two main types of pages:
 ;Static
-:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).
+:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).  It page already be possible to do this using page hooks.  Example configuration under <code>$c->{pagehooks</code> can be found in the [[misc.pl]] configuration file.
 ;Dynamic
 :This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.
@@ Line 16: / Line 16: @@
+  }
 You can place the markup for the page ID pin under whichever attribute of whatever element you want. It will only work in template files and not in static, citation or workflow files.
 [[Category:Howto]]
 [[Category:Manual]]

@@ Line 15: / Line 15: @@
       font-size: 1.8em;
+  }
-You can place the markup for the page ID pin under whichever attribute of whatever element you want. It will only work in template files and not in static files.
+You can place the markup for the page ID pin under whichever attribute of whatever element you want. It will only work in template files and not in static, citation or workflow files.
 [[Category:Howto]]
 [[Category:Manual]]

← Older revision		Revision as of 10:22, 5 July 2022
Line 17:		Line 17:

	[[Category:Howto]]		[[Category:Howto]]
−	[[Category:~~Documentation~~]]	+	[[Category:Manual]]

@@ Line 1: / Line 1: @@
 From [[EPrints 3.4.3]] onwards, it is possible to include the ID of a page dynamically into its template.  This facilitates writing page-specific CSS to control the appearance of specific pages and the HTML elements they contain.  This is acheived by setting a pin for the page ID, which is generated from the page being loaded.  EPrints has two main types of pages:
-:Static
+;Static
-; This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).
+:This includes <tt>.xpage</tt> files found under <tt>[[Archives/ARCHIVEID/cfg/static/|cfg/static/]]</tt> or <tt>[[Archives/ARCHIVEID/cfg/lang/en/static/|cfg/lang/en/static]]</tt>, such as the homepage or information page, eprint abstract/summary pages (e.g. <tt>/id/eprint/123/</tt>) and browse view pages (e.g. /view/year/2022.html</tt>).
-:Dynamic
+;Dynamic
-; This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.
+:This includes pages generated from a [[Screen Plugins]], such as the search pages and back-end management/adminstration pages for editing eprints or managing the subject tree.
 Depending on the type of page the page ID pin will take on a different form.  AlL dynamic pages will use the class name of the Screen plugin, converting non-alphanumeric (nor underscore) characters into underscores.  So <tt>EPrint::Edit</tt> becomes <tt>EPrint_Edit</tt>.  Static pages will use the path of the static page, prepended by <tt>static</tt>.  So the homepage which is on the root of the path will just have the page ID <tt>static</tt> whereas the information page will have the page ID <tt>static_information</tt>.  Abstract pages will have the page ID <tt>static_abstract</tt> and browse view pages will have the Page ID <tt>static_view_year</tt> for the homepage of the year view <tt>static_view_year</tt> for an index of the year view and <tt>static_view_year_page</tt> for a listing for a particular year.  Where a browse view may have additional menu pages like for different letters of the alphabet for the creators browse view, if you click to go to one of these menus the page ID will append <tt>_index</tt> (e.g. <tt>static_view_creators_index</tt>.
@@ Line 11: / Line 11: @@
 This would further prepend the prefix <tt>page_</tt> to the ID of the body tag, so if you loaded an abstract page (after refreshing abstracts) it would look like:
   <body id="page_static_abstract">
-This could then be used in some custom CSS file to maybe reduce the size of the <tt><h1></tt> heading because your publications have very long titles and the font size is too large for abstract pages. E.g.
+This could then be used in some custom CSS file to maybe reduce the size of the <tt>h1</tt> heading because your publications have very long titles and the font size is too large for abstract pages. E.g.
   #page_static_abstract h1#page-title {
       font-size: 1.8em;
+  }
-[[Category:Howto]] [[Category::Documentation]]
+[[Category:Howto]]