Miscellaneous

For the most up-to-date documentation, please visit docs.brix.ch

Details

Options

asset

type: long, required: yes

The ID of the asset you wish to see the details of.

locale

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.

show

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 - DEPRECATED
  • share - add a button to share the current detail view as a deep link
  • downloads - links to all available download formats (and "add to basket" when you configure one)
  • pages - adds a page navigator for documents
  • links - 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)
alternative_name

type: long, required: no, default: 0

An information field ID to display instead of the asset name in the related assets (links).

send

type: long, required: no, default: false

The download format ID to use in the "Send hyperlink" link or false to disable that feature.

split

type: boolean, required: no, default: false

Whether to use separate tables for the different sections.

callback

type: function, required: no, default: null

Callback when anuraDetails has finished loading: function(options, data) {...}

download_directly

type: boolean, required: no, default: true

Whether to show the individual download formats as links. Turning this off will only leave the basket.

show_dlf_description

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.

icon_transform

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.

paginator_target

type: Object, required: no, default: '#cboxContent .cboxPhoto'

Where to update th page previews pages is enabled.

paginator_nav

type: Object, required: no, default: {prev: '←', next: '→'}

Customize the buttons used on the pages paginator, e.g. {prev: '<', next: '>'}

infofield_transform

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+'!'}}

infofield_sort

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.

metadata

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)

Events

  • anura-loaded (options, data) - triggered when the plugin has loaded all the detail information

DOM

<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>

Basket

Options

The basket functionality is available in all main views and the detail view. Use this object for their basket-parameter.

Name Example Default Comment
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.
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>

DOM

<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>

Events

  • anura-loaded (options) - triggered when the plugin has loaded all the detail information
  • anura-asset-added (options, asset, metadata) - triggered when an asset is added to the basket
  • anura-asset-removed (options, asset) - triggered when an asset is removed to the basket
  • anura-asset-failed (options, asset) - triggered when an asset could not be added to the basket
  • anura-cleared (options) - triggered when the basket is cleared (i.e. all assets got removed)
  • anura-toggled - triggered when the basket popup is toggled (i.e. shown or hidden)
  • anura-download (asset, download format) - triggered (on the entire window) for each downloaded asset

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
lightbox-dark lightbox-light lightbox-mobile

Options

server

type: URL, required: yes, default: -

The endpoint to use, e.g. http://your.celum.server/anura/first

locale

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.

trigger

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 (taken care of by the available main views).

toolbar

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:

  • available (bool) - whether the toolbar is provided at all, default is true
  • visible (bool) - whether the toolbar is visible by default, default is true
  • layout (Array) - which buttons to show, and in what order, default is ['title', 'counter', 'download', 'basket', 'sidebar', 'close']. Known buttons:
    • title - the title of the asset, as defined by the title attribute of the trigger
    • counter - which asset you're on, e.g. "7 / 50"
    • share - copies a deep link to your clipboard
    • download - download the asset directly from the lightbox
    • fullscreen - makes the preview image go fullscreen
    • theme - makes the preview image go fullscreen
    • basket - offers the usual "add to basket" functionality
    • sidebar - let's you toggle the visibility of the sidebar
    • theme - let's you toggle the visibility of the sidebar
    • prev - adds a 'previous'-button, usefull if you have navigation.buttons disabled
    • next - adds a 'next'-button, usefull if you have navigation.buttons disabled
    • close - closes the lightbox. Note that the close button will be auto-added when you specified none.
    • function - pass an arbitrary function for custom features - 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:

  • available (bool) - whether the sidebar is provided at all, default is true
  • visible (bool) - whether the sidebar is visible by default, default is true
  • settings (object) - settings to pass on to the sidebar, usually #details
  • callback (function(options, sidebar, asset)) - called whenever the sidebar opens or the next asset is displayed. Responsible for filling the sidebar with content. Default is sidebar.anuraDetails($.extend({}, options.sidebar.settings, {server: options.server, locale: options.locale, basket: options.basket, asset: asset}))
  • width (CSS) - how wide the sidebar should be, default is 30%. Note that in the mobile view it will change to 100%.
basket

type: jQuery object, required: no, 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: object, required: no, default: {buttons: true, click: true, keyboard: true}

Which navigation types to enable. Known sub-options:

  • buttons (bool) - adds floating prev/next arrows over the preview
  • click (bool) - go to the next/previous asset when clicking on the preview (swipe left/right on mobile is always on)
  • keyboard (bool) - whether to enable keyboard shortcuts. Known shortcuts:
    • esc, q - close the lightbox
    • left arrow, h - go to the previous asset
    • right arrow, l - go to the next aasset
    • b - add the asset to the basket (or remove it)
    • s - toggle the sidebar
    • t - toggle the toolbar
    • i - inverts the theme (dark or light)
theme

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} ...

pdfPreviews

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.

Events

  • anura-loaded (options) - triggered when the plugin has loaded
  • anura-lightbox-show (options) - triggered when the lightbox opens
  • anura-lightbox-hide (options) - triggered when the lightbox closes
  • anura-lightbox-sidebar-toggled (options, isVisible) - triggered when the sidebar is toggled
  • anura-lightbox-toolbar-toggled (options, isVisible) - triggered when the toolbar is toggled
  • anura-lightbox-show-asset (options, assetId, url, title) - triggered when an asset is shown (through open/next/prev)

Translations

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.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
search.cleanUp Clear
search.ignoreSelected No restriction
search.notSelected Not selected
search.modified Modified
search.selectAll Select all
search.selected Selected