1.23 Sidebar
The following elements switch links in the sidebar to the different types of record view on or off :
config_viewer.xml
1
<sidebar>
2
<page enabled="true" />
3
<toc enabled="true" />
4
<thumbs enabled="true" />
5
<searchInItem enabled="true" />
6
<metadata enabled="true">
7
<visible>true</visible>
8
<showEventMetadata>true</showEventMetadata>
9
<showRecordLabelIfNoOtherViews>true</showRecordLabelIfNoOtherViews>
10
</metadata>
11
<fulltext enabled="true" />
12
<opac enabled="false" />
13
<sidebarBrowsingTerms enabled="true" />
14
<sidebarRssFeed enabled="true" />
15
<sidebarWidgetUsage enabled="true" introductionText="MASTERVALUE_LICENSETEXT">
16
<page>
17
<downloadOptions enabled="true">
18
<option label="label__download_option_preview_150" format="jpg" boxSizeInPixel="150" />
19
<option label="label__download_option_small_1024" format="jpg" boxSizeInPixel="1024" />
20
<option label="label__download_option_medium_2048" format="jpg" boxSizeInPixel="2048" />
21
<option label="label__download_option_large_4096" format="jpg" boxSizeInPixel="4096" />
22
<option label="Master" format="MASTER" boxSizeInPixel="max"/>
23
</downloadOptions>
24
</page>
25
<citationLinks enabled="true" recordIntroText="label__citation_link_record_introduction_text" docstructIntroText="label__citation_link_docstruct_introduction_text" imageIntroText="label__citation_link_image_introduction_text">
26
<links>
27
<link type="URL" for="record" label="URN" field="URN" prefix="https://nbn-resolving.org/" />
28
<link type="URL" for="record" label="Handle" field="MD_PI_HANDLE" prefix="https://hdl.handle.net/" />
29
<link type="URL" for="record" label="DOI" field="MD_PI_DOI" prefix="https://doi.org/" />
30
<link type="URL" for="record" label="PURL" field="MD_PURL_IAI" />
31
<link type="URL" for="image" label="DOI" field="MD_PI_DOI" prefix="https://doi.org/" suffix="#?page=" appendImageNumberToSuffix="true" />
32
<link type="URL" for="image" label="URN" field="IMAGEURN" prefix="https://nbn-resolving.org/" />
33
<link type="URL" for="image" label="URN" field="URN" prefix="https://nbn-resolving.org/" suffix="/fragment/page=" topstructValueFallback="true" appendImageNumberToSuffix="true" />
34
<link type="INTERNAL" for="record" label="LABEL_VIEWER_PURL" />
35
<link type="INTERNAL" for="docstruct" label="LABEL_VIEWER_PURL" />
36
<link type="INTERNAL" for="image" label="LABEL_VIEWER_PURL" />
37
</links>
38
</citationLinks>
39
<citationRecommendation enabled="true">
40
<styles>
41
<style>modern-language-association-7th-edition</style>
42
<style>apa-6th-edition</style>
43
<style>chicago-author-date-16th-edition</style>
44
<style>harvard-cite-them-right-no-et-al</style>
45
<style>oscola</style>
46
</styles>
47
<source>
48
<metadata label="MD_CITATION" value="MASTERVALUE_CITATION">
49
<param type="citeproc" dest="title" key="MD_TITLE" />
50
<param type="citeproc" dest="author" key="MD_CREATOR" />
51
<param type="citeproc" dest="publisher" key="MD_PUBLISHER" />
52
<param type="citeproc" dest="placepublish" key="MD_PLACEPUBLISH"/>
53
<param type="citeproc" dest="issued" key="MD_YEARPUBLISH" />
54
<param type="citeproc" dest="isbn" key="MD_ISBN"/>
55
</metadata>
56
</source>
57
</citationRecommendation>
58
</sidebarWidgetUsage>
59
<sidebarWidgetDownloads enabled="true" introductionText="">
60
<hideFileRegex>(EXAMPLE_.*|HIDDEN_.*)</hideFileRegex>
61
</sidebarWidgetDownloads>
62
</sidebar>
Copied!
Setting
Description
page/@enabled
Image-/Video-/Audio
toc/@enabled
Visibility of the link to the table of contents in the factory navigation. Attention: this is not the sidebar table of contents, for this see sidebarToc.
thumbs/@enabled
Page preview (Thumbnails)
searchInItem/@enabled
Search in record
metadata/@enabled
Metadata / Bibliographic data
If this switch is deactivated, the entire widget is not rendered.
metadata/showEventMetadata
Metadata from all LIDO events
metadata/showRecordLabelIfNoOtherViews
If this attribute is set to true and the Metadata View is the only available view for this record, the title of the record is displayed as the heading instead of "Bibliographic Data". The default value is false.
fulltext/@enabled
Fulltext
opac/@enabled
Displays an additional link to catalogue. The default value is false
sidebarBrowsingTerms/@enabled
Show or hide the browsing widget. The default value is true
sidebarRssFeed/@enabled
Show or hide the RSS feed widget. The default value is true
sidebarWidgetUsage/@enabled
Show or hide the widget. The default value is true
sidebarWidgetUsage/@introductionText
Optional introductory text or message key.
sidebarWidgetUsage/page/downloadOptions/@enabled
Shows or hides the download options. Default value is true.
sidebarWidgetUsage/page/downloadOptions/option
List of entries to be made available for download.
  • The label attribute contains a message key.
  • The format attribute specifies the file format. This must be a format supported by the IIIF Image API. The static string MASTER is automatically translated into the image format of the master image.
  • The attribute boxSizeInPixel contains a value in pixels. A square is created from this. The Goobi viewer then scales the image - keeping the aspect ratio - into the specified box and displays the real size in pixels in the download popover.
sidebarWidgetUsage/citationLinks/@enabled
Shows or hides the area. The default value is true.
sidebarWidgetUsage/citationLinks/links/link
List of entries to be displayed as citation links.
  • type: can take the value URL if a link is to be built, or INTERNAL to use the internal URL built by the Goobi viewer.
  • for: can contain the values record, docstruct or image and defines for which range the citation link is valid.
  • label: contains the message key for the name of the displayed citation link.
  • field: defines the solr field from which the value for the citation link should come. It is only evaluated for type="URL".
  • prefix: contains the part of the URL that comes before the value from the solr field. It is only evaluated for type="URL".
  • suffix: contains the part of the URL that comes after the value from the solr field. It is only evaluated for type="URL".
  • topstructValueFallback: if true the value of the main element is taken from the Solr index even if for="docstruct" or for="image" is set. Default value is false.
  • appendImageNumberToSuffix: If true the image number will be appended to the suffix. Default value is false.
sidebarWidgetUsage/citationRecommendation/@enabled
Shows or hides the area. The default value is true.
sidebarWidgetUsage/citationRecommendation/styles
Contains the list of Citeproc citation styles to be offered in the dropdown menu.
sidebarWidgetUsage/citationRecommendation/source/metadata
Contains the mapping from the Solr fields to the Citeproc values.
sidebarWidgetDownloads/@enabled
Show or hide the widget. The default value is true
sidebarWidgetDownloads/@introductionText
Optional introductory text or message key.
sidebarWidgetDownlads/hideFileRegex
If a regular expression is defined, files that match it are hidden in the widget. This is a purely visual option, the download of the files is still possible.
Within this section, the sidebar table of contents is also configured in the configuration file. Due to its thematic proximity, it is described in chapter 1.20.2.
The download for original content is also described here. Historically, this is still described in chapter 2.30.
Last modified 3mo ago
Copy link