type: URL, required: yes, default: -
The endpoint to use, e.g. http://your.celum.server/anura/first
type: String, required: no, default: CELUM's default language
The locale (ISO 639-1) to use, i.e. en
. The availability of these depend on your CELUM configuration, usually en, de or fr. When left empty, CELUM's default language will be used.
type: long, required: yes
The ID of the asset you wish to see the details of.
type: String, required: no, default: CELUM's default language
The locale (ISO 639-1) to use, i.e. en
. The availability of these depend on your CELUM configuration, usually en, de or fr. When left empty, CELUM's default language will be used.
type: List of String , required: no, default:
['general','infofields','pages','downloads','links']
What sections to show, and in what order. Any of:
general
- general information about the asset, such as name, type and size (unordered)infofields
- information fields of the asset (no field-sets, unordered)keywords
, keyword_links
, keyword_paths
, keyword_path_links
- DEPRECATEDshare
- add a button to share the current detail view as a deep linkdownloads
- links to all available download formats (and "add to basket" when you configure one)pages
- adds a page navigator for documentslinks
- show related assets (through one definable relation type)similar
- show similar assets (does a search on the nodes that the current asset is assigned to)metadata
- shows a fully configurable mix of the fields that are available in general
and infofields
(see metadata)function (asset_id, metadata, table, options) {}
- custom section (.append to the table you get)type: long, required: no, default: 0
An information field ID to display instead of the asset name in the related assets (links).
type: long, required: no, default: false
The download format ID to use in the "Send hyperlink" link or false to disable that feature.
type: boolean, required: no, default: false
Whether to use separate tables for the different sections.
type: function, required: no, default: null
Callback when anuraDetails has finished loading: function(options, data) {...}
type: boolean, required: no, default: true
Whether to show the individual download formats as links. Turning this off will only leave the basket.
type: boolean, required: no, default: true
Whether to show the description of the download formats on an extra line instead of just as a tooltip.
type: boolean, required: no, default:
function(icon) {return icon.replace('/big/', '/small/')}
Transforms the download format icon URLs, useful for dark themes to transform light into dark.
type: Object, required: no, default:
'#cboxContent .cboxPhoto'
Where to update th page previews pages is enabled.
type: Object, required: no, default:
{prev: '←', next: '→'}
Customize the buttons used on the pages paginator, e.g. {prev: '<', next: '>'}
type: map of functions, required: no, default: {}
Enables you to manipulate the values of an information field (per infofield ID), e.g. {3: function(info) {return 'Hello '+info.value+'!'}}
type: function, required: no, default: function(a, b) {return a.name.localeCompare(b.name, undefined, {numeric: true, sensitivity: 'base'})}
DEPRECATED - custom sorting function for the infofields
section. You'll probably want to use metadata
instead.
type: List of String, required: no, default: true
What metadata fields to show when show contains metadata
. This is a replacement for general
and infofields
where you can determine what shows up and in what order.
The keys are identical to the classes given to the rows in the general/infofields sections, e.g. ['id', 'created', 'info_102']. (since 2.8)
<div class="anura-details-container">
<table class="anura-table-0">
<tbody>
<tr class="title general">
<td colspan="2">Object Details</td>
</tr>
<tr class="general">
<td class="anura-name">Name</td>
<td class="anura-value">Athene Cunicularia</td>
</tr>
<tr class="general"><!--etc--></tr>
<!--etc-->
<tr class="title infofields">
<td colspan="2">Information Fields</td>
</tr>
<tr class="infofield">
<td class="anura-name">Description</td>
<td class="anura-value">A Burrowing Owl near Goiânia, Goiás, Brazil. It is standing on one leg</td>
</tr>
<tr class="infofield"><!--etc--></tr>
<!--etc-->
<tr class="title download">
<td colspan="2">Download Formats</td>
</tr>
<tr class="basket">
<td colspan="2">
<a class="anura-details-download">
<div class="basket-img"></div>
<div class="anura-details-download-name">Add to basket</div>
</a>
</td>
</tr>
<tr class="dlf">
<td colspan="2">
<a class="anura-details-download">
<img src="...">
<div class="anura-details-download-name" title="Original Format">Original Format</div>
</a>
</td>
</tr>
<tr class="dlf"><!--etc--></tr>
<!--etc-->
</tbody>
</table>
</div>
The basket functionality is available in all main views and the detail view. Use this object for their basket-parameter.
Name | Example | Default | Comment |
---|---|---|---|
server | http://your.celum.server/anura/first |
- | URL, required |
locale | en |
CELUM's default | ISO 639-1 |
add | [asset_id1, asset_id2, ...] |
null | Assets to add to the basket (int or array of int) |
remove | [asset_id1, asset_id2, ...] |
null | Assets to remove from the basket (int or array of int) |
action | 'show' |
- | Action after initialization, one of: show, hide, toggle or clear |
force_zip | true |
false | Force even single asset downloads to be delivered in a ZIP-file |
cookies | false |
true | Use cookies to persist the basket (requires jquery.cookies.js). Provide a string instead to differentiate multiple baskets, e.g. cookies: 'foo' will use the cookie 'anura-basket-foo'. |
send | true |
false | adds a "mailto" button that points to the download URL of the basket's content. Clicking on it leads straight to the download without showing the anura page. |
pin | 'link' or 'send' | false | adds a PIN creation link - link opens the PIN in a new window, send by mail via a mailto-link, since 2.9 |
share | true |
false | adds a "share" button copies a link with the basket's content to the clipboard. Cliking on it shows the anura page and opens the basket. since 2.8 |
terms_and_conditions | {title: 'T&C', message: 'Lorem ipsum', confirm: 'I agree'} |
null | show terms and conditions - when the confirm-parameter is present, a checkbox will appear and hide the download buttons until you check it. Localize any of the three texts by providing {de: 'Ich bin einverstanden', en: 'I agree'} instead of just a string. You can also set it to true to copy CELUM's downloadFormatInterceptor settings. |
icon_transform | function(icon) {return icon.replace('/dark/', '/light/')} |
function(icon) {return icon.replace('/big/', '/small/')} | Icon transformation callback to change size/color |
clear_after_download | false |
true | Clears the basket when the download starts |
require_email | true |
false | require the user to input his e-mail address before he can download anything (useful when using anura.1.downloadHandler=anuraMailInputDownloader) |
show_description | false |
true | Show the description of the download formats as a second line (instead of a tooltip) |
max_assets | 10 |
0 | The maximum number of assets that a basket may contain (FIFO). 0 disables the feature. (since 2.8) |
show_failed | true |
false | Show a placeholder for failed assets (that the user doesn't have access to, useful then share is true. (since 2.8) |
default_format | 3 |
null | The download format that should be selected by default (when available). since 2.8 |
If your basket target element contains a span (preferably with the class
counter
), the number of assets in the basket will be updated there,
i.e.<div id="anura-basket">Basket (<span class="counter">7</span>)</div>
_terms_andconditions has callbacks:
<div id="anura-basket-overlay">
<div class="anura-basket-popup anura-locale-">
<div class="anura-basket-popup-titlebar"><span>×</span></div>
<div class="anura-basket-thumbs">
<div class="anura-basket-thumb"><img src="...">
<div class="anura-basket-thumb-delete hover"></div>
</div>
<div class="anura-basket-thumb"><!--etc--></div>
<!--etc-->
</div>
<div class="anura-basket-download">
<h3 class="anura-basket-download-title">Download:</h3>
<div class="anura-basket-download-holder">Download Format X</div>
<div class="anura-basket-download-holder"><!--etc--></div>
<!--etc-->
<h3 class="anura-basket-download-send">Send:</h3>
<div class="anura-basket-download-holder mailto">Send Hyperlink</div>
<span class="anura-basket-reset">clear</span>
</div>
</div>
</div>
Since 2.9, anura ships with its own lightbox, as all the other ones have their own quirks. Other lightboxes are still supported for now, but we'd encourage you to use this one :-)
Dark | Light | Mobile |
---|---|---|
![]() |
![]() |
![]() |
type: URL, required: yes, default: -
The endpoint to use, e.g. http://your.celum.server/anura/first
type: String, required: no, default: CELUM's default language
The locale (ISO 639-1) to use, i.e. en
. The availability of these depend on your CELUM configuration, usually en, de or fr. When left empty, CELUM's default language will be used.
type: String, required: no, default:
'a[rel^=anura-lightbox]'
The elements that when clicked open the lightbox.
Note that it expects the attributes data-asset-id, src and title to be set on the trigger elements (this is taken care of by all main views that we ship).
type: object, required: no, default:
{available: true, visible: true, layout: ['title', 'counter', 'download', 'basket', 'sidebar', 'close']}
Whether to show a toolbar, if said toolbar is visible by default, and what buttons are present on the toolbar.
Known sub-options:
true
true
['title', 'counter', 'download', 'basket', 'sidebar', 'close']
. Known buttons:
title
- the title of the asset, as defined by the title attribute of the triggercounter
- which asset you're on, e.g. "7 / 50"share
- copies a deep link to your clipboarddownload
- download the asset directly from the lightboxfullscreen
- makes the preview image go fullscreentheme
- makes the preview image go fullscreenbasket
- offers the usual "add to basket" functionality. Requires basket to be set.sidebar
- let's you toggle the visibility of the sidebartheme
- let's you toggle the visibility of the sidebarprev
- adds a 'previous'-button, usefull if you have navigation.buttons disablednext
- adds a 'next'-button, usefull if you have navigation.buttons disabledslideshow
- adds a 'slideshow' button to show the next asset in x seconds (default: 5s)close
- closes the lightbox. Note that the close button will be auto-added when you specified none.function(options, toolbar)
type: object, required: no, default:
{available: true, visible: true, settings: {}, callback: function, width: '30%'}
Whether to show the sidebar, if the sidebar is visible by default, what happens inside the sidebar, and how wide it should be.
Known sub-options:
true
true
sidebar.anuraDetails($.extend({}, options.sidebar.settings, {server: options.server, locale: options.locale, basket: options.basket, asset: asset}))
30%
. Note that in the mobile view it will change to 100%
.type: jQuery object, required: only when using 'basket' in toolbar, default: null
The download basket to use where the user can collect assets to download, as returned by your $.anuraBasket()
-call.
This enables the corresponding basket buttons in the download_menu and detail_view. Required when you used basket
in the toolbar layout.
type: long, required: only when using 'download' in toolbar, default: 0
Which download format to use for the "download" button. Temporary option until a dropdown with available formats is implemented.
type: object, required: no, default:
{buttons: true, click: true, keyboard: true}
Which navigation types to enable. Known sub-options:
esc
, q
- close the lightboxleft arrow
, h
- go to the previous assetright arrow
, l
- go to the next aassetb
- add the asset to the basket (or remove it)s
- toggle the sidebart
- toggle the toolbari
- inverts the theme (dark or light)type: String, required: no, default:
dark
Which theme to use, currently eighter dark
or light
. You can provide your own theme and declare CSS rules using .anura-lightbox-theme-{your theme} ...
type: String, required: no, default: -
Used to trigger an action from outside, one of
{title: 'your title', url: 'https://some.jpg', mime: 'image/jpeg'}
type: boolean, required: no, default: true
Whether to enable inline PDF previews for documents. Note that this relies on the built-in PDF-viewer of the browser. Requires back-end v2.9 or later.
When using full text search, the words you searched for will be highlighted (currently only works in Firefox, see Chromium Issue #792647 )
type: boolean, required: no, default: true, since: 2.9
Whether to use the native browser player to play videos (otherwise CELUM's is used)
type: boolean, required: no, default: true for screens larger than 1024x1024px, false otherwise
Whether to use the high resolution preview format (up to 3000x3000px instead of up to 1024x1024px)
type: long, required: no, default: 5000, since: 2.9
How long to pause between each asset then in slideshow-mode (see toolbar)
All strings used by the front-end are retrieved from CELUM's message bundle. You can override any of these be prepending anura.
to the key, so the changes only affect Anura, but not CELUM's UI. E.g. anura.paging.page=P.
. The keys that already start with anura are provided by the back-end.
key | value (EN) |
---|---|
actionmenu.sidebar.enable | Show Sidebar |
anura.addToBasket | Add to basket |
anura.download.mailinput.mail | E-Mail Address |
anura.download.mailinput.text | Please enter your contact information, so we can inform you about changes to the assets (such as copyright expiration). |
anura.loadMore | load more |
anura.removeFromBasket | Remove from basket |
anura.similarAssets | Similar Assets |
anura.slideshow | Slideshow |
anura.versions.date | Version date |
anura.versions.nr | Version number |
assetlist.header.image | Preview |
assetlist.header.mediaType | Asset Type |
assetlist.header.name | Name |
assetlist.header.originalFileName | File Name |
assetlist.viewsettings | View |
AssetProperties.fileExtension | File extension |
common.copyToClipboard | Copy link to clipboard |
common.form.inactive | Not available |
common.object.creationDate | Created |
common.object.lastModifiedDate | Modified |
common.object.originalFileSize | File size |
common.object.technicaltype | File type |
detailview.generalinfo.title | General Information |
detailview.keywords.title | Keywords |
detailview.technicaltype.size | Size |
DocDocumentProperties.pages | Pages |
downloadformatgroup.all.downloadFormat | All Download Formats |
downloadFormatInterceptor.messageBox.message | The author intended not to use any copyrighted material ... |
downloadFormatInterceptor.messageBox.title | Disclaimer |
downloadformatmanagement.downloadformat.name | Download Format |
externallinks.error.nopermission.asset | You have no permission for asset with id: {0}! |
fileproperties.* | (dynamic, see local fileProperties-fields.xml, name=...) |
general.close | Close |
general.download | Download |
general.infofields | Information Fields |
general.links | Links |
general.next | Next |
general.previous | Previous |
general.units.px | Pixel |
interceptor.disclaimerconfirmation | Accept |
loading.general | Loading... |
MediaAssetProperties.filesize | File size |
MENUITEMID_DOWNLOAD | Download |
MENUITEMID_MAILTO | Send Hyperlink |
MENUITEMID_METADATA | Metadata |
MENUITEMID_SEND | Send |
MENUITEMID_SHARE | Share |
MENUITEMID_SHOW_FULLSCREEN_PREVIEW | Fullscreen Preview |
object.originalFileName | Filename |
paging.page | Page |
PdfDocumentProperties.modifiedDate | Modified date |
PdfDocumentProperties.pages | Pages |
pinaccess.name.fallback | PIN-Link |
search.cleanUp | Clear |
search.documentProperties | Properties |
search.ignoreSelected | No restriction |
search.notSelected | Not selected |
search.modified | Modified |
search.searchItem | Search term |
search.searchOtherObjects | Unknown |
search.selectAll | Select all |
search.selected | Selected |
search.startSearch | Search |
search.uploaded | Uploaded |
share.newPin | New PIN-Link |
TgaImageProperties.creationDate | Creation Date |
© brix IT Solutions