Adding new views - Revision history

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

2024-07-02T16:32:06Z

‎The basics: fixed typo

Af05v@ecs.soton.ac.uk at 12:55, 14 October 2015

2015-10-14T12:55:16Z

Denics@free.fr: /* Browse by type */

2012-03-23T14:35:40Z

‎Browse by type

Pm705 at 12:22, 20 March 2010

2010-03-20T12:22:04Z

Pm705 at 13:20, 8 February 2010

2010-02-08T13:20:10Z

WikiSysop: /* variations */

2008-11-19T14:17:00Z

‎variations

WikiSysop: /* variations */

2008-11-19T14:14:10Z

‎variations

WikiSysop: /* variations */

2008-11-19T14:12:44Z

‎variations

WikiSysop: /* variations */

2008-11-19T14:11:58Z

‎variations

WikiSysop: /* string */

2008-10-14T10:49:45Z

‎string

@@ Line 33: / Line 33: @@
 The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).
-The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).
+The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjects''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).
 Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).

← Older revision		Revision as of 12:55, 14 October 2015
Line 2:		Line 2:
	[[Category:Browse Views]]		[[Category:Browse Views]]

−	~~{{development}}~~

	Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content.		Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content.

@@ Line 99: / Line 99: @@
 ===Example view definitions===
-====Browse by type====
+====Browse by type (3.3.8)====
 Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:
+  {
-        id => "types",
+    id=>"doctype",
-        fields => "type",
+    menus => [
-        order => "-date/title",
-        hideempty => 1,
+      fields => [ "type" ],
   },

@@ Line 1: / Line 1: @@
 [[Category:Manual]]
-[[Category:Configuration]]
+[[Category:Browse Views]]
 {{development}}

← Older revision		Revision as of 13:20, 8 February 2010
Line 1:		Line 1:
		+
		+	[[Category:Manual]]
		+	[[Category:Configuration]]
		+
	{{development}}		{{development}}

← Older revision		Revision as of 14:17, 19 November 2008
Line 178:		Line 178:
	],		],

−	~~The following options are available:~~	+	See [[views.pl]] for the list of options.
−
−	~~{\| border="1" cellpadding="4"~~
−	~~\|reverse~~
−	~~\|Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric)~~. ~~Useful~~ for ~~dates as you may want~~ the ~~highest values first.~~
−	\|-
−	~~\|filename~~
−	~~\|Changes the filename of the view variation. The default is the name~~ of ~~the metadata field used, so if two variations use the same metadata field with different~~ options~~, this is needed.~~
−
−	~~filename=different_filename~~
−	\|-
−	~~\|first_value~~
−	~~\|If a field is multiple, only use the first value. Otherwise each item will appear once for each value.~~
−	\|-
−	~~\|first_initial~~
−	\|If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.
−	\|-
−	~~\|first_letter~~
−	~~\|The same as 'truncate=1'~~
−	\|-
−	~~\|truncate~~
−	~~\|Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.~~
−
−	~~truncate=4~~
−	\|-
−	~~\|tags~~
−	~~\|Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.~~
−	\|-
−	~~\|cloud~~
−	~~\|Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.~~
−	\|-
−	~~\|cloudmax~~
−	~~\|The % size of the largest tag in a tag cloud.~~
−	\|-
−	~~\|cloudmin~~
−	~~\|The % size of the smallest tag in a tag cloud.~~
−	\|-
−	~~\|jump~~
−	\|
−	~~jump=plain~~
−
−	~~Turns of the 'jump to' text before the list of subheading navigation links.~~
−	\|-
−	~~\|no_seperator (sic)~~
−	~~\|Turns of the separator between each subheading navigation link (by default a vertical bar symbol).~~
−	\|-
−	~~\|string~~
−	~~\|Uses values 'as is'. No ordervalues, no phrases.~~
−	\|-
−	~~\|hideup (since 3.1.1)~~
−	~~\|Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on~~ .~~include files)~~
−	\|}

@@ Line 180: / Line 180: @@
 The following options are available:
-{|
+{| border="1" cellpadding="4"
 |reverse
 |Reverses the order in which the groupings are shown.  Default is the ordervalue for that field (usually alphanumeric).  Useful for dates as you may want the highest values first.
@@ Line 202: / Line 202: @@
   truncate=4
 |tags
 |Useful for fields like keywords where values may be separated by commas or semi-colons.  The value is split on these two characters ( , and ; ) and a heading is created for each.
@@ Line 221: / Line 222: @@
 |-
 |no_seperator (sic)
-|Turns of the separator between each subheading navigation link (by default '|').
+|Turns of the separator between each subheading navigation link (by default a vertical bar symbol).
 |-
 |string

@@ Line 188: / Line 188: @@
   filename=different_filename
 |-
 |first_value
@@ Line 195: / Line 194: @@
 |first_initial
 |If using a name, truncate the given name to the first initial.  This will make items like "Les Carr" and "Leslie Carr" appear together.  Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.
-|=
+|-
 |first_letter
 |The same as 'truncate=1'

@@ Line 180: / Line 180: @@
 The following options are available:
-=====reverse=====
+{|
+|reverse
-Reverses the order in which the groupings are shown.  Default is the ordervalue for that field (usually alphanumeric).  Useful for dates as you may want the highest values first.
+|Reverses the order in which the groupings are shown.  Default is the ordervalue for that field (usually alphanumeric).  Useful for dates as you may want the highest values first.
+|-
-=====filename=====
+|filename
+|Changes the filename of the view variation.  The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.
   filename=different_filename
+|}
-=====first_value=====
+|-
+|first_value
-If a field is multiple, only use the first value.  Otherwise each item will appear once for each value.
+|If a field is multiple, only use the first value.  Otherwise each item will appear once for each value.
+|-
-=====first_initial=====
+|first_initial
+|If using a name, truncate the given name to the first initial.  This will make items like "Les Carr" and "Leslie Carr" appear together.  Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.
-If using a name, truncate the given name to the first initial.  This will make items like "Les Carr" and "Leslie Carr" appear together.  Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.
+|=
+|first_letter
-=====first_letter=====
+|The same as 'truncate=1'
+|-
-The same as 'truncate=1'
+|truncate
+|Use the first X characters of a value to group by.  truncate=4 may be useful for dates as it will group by the first four digits (the year) only.
   truncate=4
+|tags
-=====tags=====
+|Useful for fields like keywords where values may be separated by commas or semi-colons.  The value is split on these two characters ( , and ; ) and a heading is created for each.
+|-
-Useful for fields like keywords where values may be separated by commas or semi-colons.  The value is split on these two characters ( , and ; ) and a heading is created for each.
+|cloud
+|Creates a tag cloud.  Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.
-=====cloud=====
+|-
+|cloudmax
-Creates a tag cloud.  Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.
+|The % size of the largest tag in a tag cloud.
+|-
-=====cloudmax=====
+|cloudmin
+|The % size of the smallest tag in a tag cloud.
-The % size of the largest tag in a tag cloud.
+|-
+|jump
-=====cloudmin=====
    jump=plain
 Turns of the 'jump to' text before the list of subheading navigation links.
+|-
-=====no_seperator (sic)=====
+|no_seperator (sic)
+|Turns of the separator between each subheading navigation link (by default '|').
-Turns of the separator between each subheading navigation link (by default '|').
+|-
+|string
-=====string=====
+|Uses values 'as is'.  No ordervalues, no phrases.
+|-
-Uses values 'as is'.  No ordervalues, no phrases.
+|hideup (since 3.1.1)
+|Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)
-=====hideup (since 3.1.1) =====
+|}

← Older revision		Revision as of 10:49, 14 October 2008
Line 237:		Line 237:

	Uses values 'as is'. No ordervalues, no phrases.		Uses values 'as is'. No ordervalues, no phrases.
		+
		+	=====hideup (since 3.1.1) =====
		+	Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)