Views.pl - Revision history

Libjlrs: /* View list options */

2025-04-28T13:15:50Z

‎View list options

Alan.stiles@open.ac.uk: /* Sections */ fixed typo

2024-07-02T16:45:18Z

‎Sections: fixed typo

Drn@ecs.soton.ac.uk: Added cfgd and dirs templates

2022-02-05T23:42:16Z

Added cfgd and dirs templates

Drn@ecs.soton.ac.uk: Added actually file name in bold.

2022-01-31T14:04:54Z

Added actually file name in bold.

Bdgregg@pitt.edu: Added the max_items view option per EP-Tech mailing list suggestion.

2015-08-27T14:25:42Z

Added the max_items view option per EP-Tech mailing list suggestion.

Kiz: /* Example */

2015-03-06T15:43:25Z

‎Example

Kiz at 15:24, 6 March 2015

2015-03-06T15:24:47Z

Rwf1v07@soton.ac.uk at 15:08, 9 December 2014

2014-12-09T15:08:37Z

D.vierkant@utwente.nl: viewtitle_eprints -> viewtitle_eprint , based on code: $phrase_id = "viewtitle_".$ds->confid()."_".$view->{id}."_list";

2012-01-27T10:39:08Z

viewtitle_eprints -> viewtitle_eprint , based on code: $phrase_id = "viewtitle_".$ds->confid()."_".$view->{id}."_list";

Pm705 at 12:44, 20 March 2010

2010-03-20T12:44:39Z

@@ Line 142: / Line 142: @@
 |variations <sup style="font-weight:bold; font-size:10px;">(V)</sup>
 |An array of strings describing different rendering of the items at the ''list''. For datails see [[#Variations|variations]]. Example:
-     variation => [ "creators_name;first_letter",
+     variations => [ "creators_name;first_letter",
          "type", "DEFAULT", ],
 |- valign="top"
@@ Line 159: / Line 159: @@
 |Defaults to 86400 (one day in seconds). If the lists in this view were generated more than than many seconds ago, it is regenerated.
 |}
 ===Variations===

@@ Line 337: / Line 337: @@
 |-valign="top"
 |group_sorting_function <sup style="font-weight:bold; font-size:10px;">(M)</sup>
-|A costum function which sorts the group identifiers. The only available function
+|A custom function which sorts the group identifiers. The only available function
 *"EPrints::Update::Views::default_sort"
 sorts alphabetically.

← Older revision		Revision as of 23:42, 5 February 2022
Line 1:		Line 1:
	[[Category:Browse Views]]		[[Category:Browse Views]]
		+	{{dirs}}
		+	{{cfgd}}

	'''views.pl''' contains configuration for rendering ''views''. Conceptually a ''view'' is a browsable list of eprints split into ''menus'' and a ''list''.		'''views.pl''' contains configuration for rendering ''views''. Conceptually a ''view'' is a browsable list of eprints split into ''menus'' and a ''list''.

@@ Line 1: / Line 1: @@
 [[Category:Browse Views]]
-[[Category:Documentation Needed]]
-== Views ==
+'''views.pl''' contains configuration for rendering ''views''.  Conceptually a ''view'' is a browsable list of eprints split into ''menus'' and a ''list''.
 <div align="center">

@@ Line 112: / Line 112: @@
 | max_menu_age&nbsp;<sup style="font-weight:bold; font-size:10px;">(V)</sup>
 | Defaults to 86400 (one day in seconds). If the menus in this view has been generated more than that many seconds ago, it is regenerated.
 |}

← Older revision		Revision as of 15:43, 6 March 2015
Line 495:		Line 495:

	This creates a table for each record, and CSS is used to manage the size & position of the various elements		This creates a table for each record, and CSS is used to manage the size & position of the various elements
		+
		+	===cfg/cfg.d/eprint_render.pl===
		+	When viewing a record, the main abstract view page can also be altered
		+
		+	In <code>cfg/cfg.d/eprint_render.pl</code>, towards the bottom of the subroutine <code>$c->{eprint_render}</code> is the following line:
		+
		+	my $page = $eprint->render_citation( "router_page", %fragments, flags=>$flags );
		+
		+	Here, '''router_page''' is the name of the citation file for creating the abstract page..... '''router_page.xml''' in this case

← Older revision		Revision as of 15:24, 6 March 2015
Line 397:		Line 397:
	\| ?		\| ?
	\|}		\|}
		+
		+	=Example=
		+	==EPrints 3.2 example==
		+	===cfg/cfg.d/views.pl===
		+	{ id => "target", # The 'name' for this view
		+	allow_null => 0,
		+	hide_empty => 1,
		+	menus => [
		+	{ fields => ["broker_reponame"], # The field(s) to use - in this case the 'reponame' sub-element of the 'broker' field
		+	new_column_at => [0], # force 2 columns, even if the
		+	# second is blank
		+	mode => "sections",
		+	open_first_section => 1,
		+	group_range_function => "EPrints::Update::Views::cluster_ranges_30",
		+	group_sorting_function => "EPrints::Update::Views::default_sort",
		+	},
		+	],
		+	order => "-date/title",
		+	citation => 'router', # This defines the file in cfg/citations/eprint/
		+	layout => 'router', # This is used in Views.pm to determine how to
		+	# join individual citations together...
		+	},
		+
		+	This creates a view, which will be 2-columns wide.
		+	Two important definitions here are:
		+	* '''citation''' defines the citation file used to create the block of html for each record to be displayed, and
		+	* '''layout''' indicates how those blocks are joined together.
		+
		+	====Layout====
		+	'''Layout''' can be one of:
		+	* paragraph (the default)
		+	puts <p> elements round each citation
		+
		+	* orderedlist
		+	makes an ordered list (1,2,3,4 or whatever the CSS defines)
		+
		+	* unorderedlist
		+	makes an unordered list
		+
		+	* ''anything else''
		+	just puts a newline (in the page source) after each citation
		+
		+	====citation====
		+	In our example, we're using a home-made citation layout
		+
		+	The citation file is in <code>/cfg/citations/eprint/</code>
		+
		+	In the above view, we have defined the citation format to be '''router''', therefore we need a file called '''router.xml''' in the citations directory.
		+
		+	Remember this format is used for each record, so needs to be complete in it's own right - and if you want records to line up vertically, you need to plan that in advance.
		+
		+
		+	<?xml version="1.0" ?>
		+	<!--
		+	Full citation for an eprint.
		+	-->
		+	<cite:citation xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns="http://eprints.org/ep3/control" xmlns:cite="http://eprints.org/ep3/citation" >
		+	<table class='ep_rt_citation'>;
		+	<tr><td colspan='2'>
		+	<choose>
		+	<when test="type = 'book' and is_set( creators )">
		+	<span class='strong'><print expr="creators_name"/></span>
		+	</when>
		+	.... more code ....
		+	</choose>
		+	</td><td style="width:8em">
		+	<if test="date"><span class='right strong'>(<print expr="date" opts="res=year"/>)</span></if>
		+	</td></tr>
		+	<tr><td style="width:50%">
		+	<cite:linkhere><xhtml:em><print expr="title" opts="magicstop"/></xhtml:em></cite:linkhere>
		+	</td>
		+	<choose>
		+	.... more code
		+	<when test="type = 'article'">
		+	<td>
		+	<if test="publication"><print expr="publication"/>
		+	<if test="volume">, <print expr="volume"/></if>
		+	<if test="number"> (<print expr="number"/>)</if>
		+	.</if>
		+	<if test="pagerange"> <print expr="pagerange"/>.</if>
		+	</td><td>
		+	<if test="issn"><span class='right'> ISSN <print expr="issn"/></span></if>
		+	</td>
		+	</when>
		+	.... more code
		+	</choose>
		+	</tr>
		+	<if test=" ! type.one_of( 'patent','thesis' )">
		+	<if test="ispublished.one_of('unpub', 'submitted', 'inpress')">
		+	<tr><td colspan='2'>
		+	(<print expr="ispublished"/>)
		+	</td></tr>
		+	</if>
		+	</if>
		+	</table>
		+	</cite:citation>
		+
		+	This creates a table for each record, and CSS is used to manage the size & position of the various elements

@@ Line 360: / Line 360: @@
 |Intro phrase on the next level
 |-valign="top"
-|viewtitle_eprints_<viewid>_menu_<level>
+|viewtitle_eprint_<viewid>_menu_<level>
 |Title of browse page at level <level>, which is 1, 2, ... In the phrase you can use the pins "value1", "value2", etc. where the number can be one less than the present level; the value of the pin is the actual value of the previous levels. See the example below.
 |-valign="top"
-|viewgroup_eprints_<viewid>_<filename>
+|viewgroup_eprint_<viewid>_<filename>
 |Used as a pin value for the title on the list pages, when [[#Variations|variations]] are used. <Filename> is the filename defined as the option of the variation, or, if it is not defined, then it is the fieldname at the beginning.
 |-valign="top"
-|viewtitle_eprints_<viewid>_list
+|viewtitle_eprint_<viewid>_list
 |Title of the list pages of the view. You can use the same pins as before ("value1", "value2", etc.). If the list was generated by a [[#Variations|variation]] then the "grouping" pin is also available.
 |}
 The following example shows how to define these values.
-  <epp:phrase id="viewname_eprints_divisions">Divisions</epp:phrase>
+  <epp:phrase id="viewname_eprint_divisions">Divisions</epp:phrase>
-  <epp:phrase id="viewtitle_eprints_divisions_menu_1">
+  <epp:phrase id="viewtitle_eprint_divisions_menu_1">
      Browse by Division and Year</epp:phrase>
-  <epp:phrase id="viewtitle_eprints_divisions_menu_2">
+  <epp:phrase id="viewtitle_eprint_divisions_menu_2">
      Browse by Year where Division is
       <epc:pin name="value1" /> </epp:phrase>