Page tree
Skip to end of metadata
Go to start of metadata

The Manner in which the Extension Operates

This extension makes it possible to generate a HTML file with a list of publications belonging to a selected group publication. The list does not contain other group publications, but it takes into account possible publications grouped in other publications (as well as multiple embedded publications).

Once the “New group object” option has been selected from the “Tools” menu in the Administrator Application, there appears a dialog box (see the image below) where the identifier of the group publication should be entered. In the next window, the user should indicate the file in which the generated list is to be saved. If the operation is carried out correctly, there will appear a message saying that the list has been saved.

Wprowadzanie identyfikatora publikacji grupowej

Configuring the Extension

In order to change the settings of the plugin, the user should select the “Configuration” item from the “Program” menu, select the plugin (“Publication list in a group publication”), and click the “Configure” button. There will appear a standard configuration window, in the user can enter the directory on the drive or the website address from which the configuration file is to be loaded for the extension. As usual, option “Use the configuration from the given source” should be marked.

The name of the file required by the generator of a publication list is index.vm; it is the template of the HTML file to be generated. The template is saved in the Apache Velocity format. For more information about that technology, see here. The structure of the template used in the default setting is presented below.

## define $library_url below appropriately to your digital library url.
#set($library_url = "")

  <meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
<TABLE border="1">
<th>Tytuł publikacji</th>
<th>Link do publikacji</th>
<th>Identyfikator OAI</th>
#foreach( $pub in $pubs )
	<td><a href="http:/$library_url/publication/$pub.getId()">http://$library_url/publication/$pub.getId()</a>

As shown in the template, variable $pubs can be used in it. The variable is a list of objects which describe the publications in the selected group publication. The following methods are made available by the objects:

  • getId()– returns the publication identifier;
  • getLabel() – returns the name of the publication (visible in the Editor Application, not directly related to the values visible to the reader).
  • No labels