API:EPrints/Update/Views

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

---

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Update::Views - Update view pages

SYNOPSIS

$c->{browse_views} = [
	{
		id => "year",
		order => "creators_name/title",
		menus => [
			{
				fields => [qw( date;res=year )],
				reverse_order => 1,
				allow_null => 1,
				new_column_at => [10, 10]
			},
		],
		variations => [qw(
			creators_name;first_letter
			type
			DEFAULT
		)],
	},
];

DESCRIPTION

Update the browse-by X web pages on demand.

OPTIONS

• id

Set the unique id for the view, which in the URL will be /view/[id]/...

• dataset = "archive"

Set the dataset id to retrieve records from.

• menus = [ ... ]

An array of hierarchical menu choices.

• order = ""

Order matching records by the given field structure.

• variations = [qw( DEFAULT )]

Add group-bys on additional pages. "DEFAULT" shows all of the records in a list.

• nolink = 0

Don't show a link to this view from the /view/ page.

Menus

• allow_null = 0
• fields = [qw( ... )]
• new_column_at = [x, y]
• reverse_order = 0
• mode = "default"

Use "sections" to cause the menu to be broken into sections.

• open_first_section = 1

Open the first section of the browse menu.

Variations

Format is:

  [fieldname];[options]

Where options is:

  [option1],[option2],[option3]=[value]

If no value is given the option is implicitly 1 (enable).

  creators_name;first_letter,allow_null=1

• allow_null = 0

Show items that have no value(s) for the selected field.

• cloud

Render a "Tag Cloud" of links, where the individual links are scaled by their frequency of occurence.

• cloudmin = 80, cloudmax = 200

Scale cloud tag links by between cloudmin and cloudmax percent from normal text size.

• first_letter

Implies truncate=1 and first_value.

• first_value

Only group-by on the first value in a multiple field.

• jump = none|plain|default

Hide the jump-to links, render just the links or render as a phrase ('Update/Views:jump_to').

• tags

Treat the field value as a comma or semi-colon separated list of values.

• truncate = n

Truncate the value to at most n characters.

METHODS

update_view_file

$filename = update_view_file( $repo, $langid, $localpath, $uri )

This is the function which decides which type of view it is:

  * the main menu of views
  * the top level menu of a view
  * the sub menu of a view
  * a page within a single value of a view

Does not update the file if it's not needed.

Pseudo-Views Class

name

$desc = $view->name

Returns a human-readable name of this view (for debugging).

update_view_by_path

$view->update_view_by_path( %opts )

Updates the view source files.

Options:

  on_write - callback called with the filename written
  langid - language to write
  do_menus - suppress generation of menus
  do_lists - suppress generation of lists

COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.