Versions Compared

Old Version 3

changes.mady.by.user Claudio Jordi

Saved on

compared with

New Version 4

changes.mady.by.user Claudio Jordi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Key

Type

Description

Reference Types

ref_types

Required

array

Array containing all individually defined ref_type objects.

Reference Type Object

ref_type

Required

string

Unique reference type name used internally

icon

Required

string

Material icon name used in Search results page and alongside the title above reference item

title

Required

string

Title to be displayed above reference item and as alt-text to icon in Search page

ref_item_title

string

Only used if present and no subtypes are specified. Reference item specific (overrides title) to be displayed above reference item. Interpreted as Jinja2 template.
See: Accessible variables and functions.

query

string

Required if no subtypes are specified. Squirro search query used to return reference items for particular item. Interpreted as Jinja2 template.
See: Accessible variables and functions.

available

string

Optional dynamic field value based on item. Interpreted as Jinja2 template.
Value interpretation:

  • true - reference item are accessible and Icon on search page is active

  • false - reference item are not present and Icon on search page is disabled

  • null or other value - unknown state, Icon stays active on search page - same as if available field was not specified.

Accessible variables and functions: item.created_at, item.external_id, item.id, item.keywords, item.language, item.link, item.title

Reference Subtypes

subtypes

array

List of reference subtypes if any.

Reference Subtype Object

ref_type

Required

string

Unique reference type name used internally

title

Required

string

Title to be displayed above reference item and as alt-text to icon in Search page

ref_item_title

string

Reference item specific (overrides title) to be displayed above reference item. Interpreted as Jinja2 template.

See: Accessible variables and functions.

query

Required

string

Squirro search query used to return reference items for particular item. Required if no subtypes are specified. Interpreted as Jinja2 template.

See: Accessible variables and functions.

Accessible variables and functions

...

  • item - the currently viewed item

  • ref_item - the referenced item

  • fields available in item and ref_item:

    • item.created_at

    • item.external_id

    • item.id

    • item.keywords

    • item.language

    • item.link

    • item.title

    • lang.get_name(item.language) - get a human readable language name based on ISO 639-1 code

...