Template variables

Every command sees these variables.

Overview

objects, f, files and p are the same for all objects of an export run. Even in a template with one document per object, objects is complete: {#objects.length#} outputs the number of all exported objects there.

$o: the current object

{#$o[`RegNr`] ?? ``#}
{#$o[`Originaltitel`] ?? ``#}
{#$o.object_id#}

Fields are addressed by their field name, in backticks. The fallback with ?? and an empty string is the standard style. The value is always the raw value as stored: numbers as strings, dates as YYYY-MM-DD. imask, fdate, fcheck and ffmt give readable forms.

Subfields: both notations

Address, object and geolocation fields have subfields. Moliri provides them nested and also keeps the original key. Both forms work:

{#$o[`Leihgeber`]?.address_designation ?? ``#}    nested
{#$o[`Leihgeber~address_designation`] ?? ``#}     literal

For nested access always use ?. rather than .: if the field is missing in the project or empty, $o[`Leihgeber`] is undefined. With . the expression fails, with ?. the fallback applies.

Switch fields

Switch fields return the stored value, usually 1 for yes. In JavaScript the string '0' counts as true. A plain truth test such as $o[`Kurierbegleitung`] ? … is therefore wrong. Either compare explicitly or use fcheck , which also reads custom stored values correctly:

Kurierbegleitung: {#($o[`Kurierbegleitung`] == 1) ? `Ja` : `Nein`#}
Kurierbegleitung: {#fcheck($o[`Kurierbegleitung`], `Ja`, `Nein`)#}

objects: all objects

{# FOR obj IN objects #}
{# INS $obj[`RegNr`] ?? `` #}
{# END-FOR obj #}

As soon as a FOR loop runs over objects, one document is created for all objects. See Template syntax .

f: field definitions

Contains the definition of each field including its configuration. Mainly for imask():

{# INS imask($o[`Breite`], f[`Breite`]) #}

The output then takes the number mask from the field configuration .

p: project data

Projekt: {# INS p.name ?? `` #}
Ort: {# INS p.place ?? `` #}
Zeitraum: {# INS fdate(p.start_date) #} bis {# INS fdate(p.end_date) #}

$f: files of the current object

Equivalent to files[String($o.object_id)] ?? [].

{# FOR file IN $f #}
{# IF [`image`, `image_other`, `svg`].includes($file.kind) #}
{# IMAGE img($file, { width: 6 }) #}
{# END-IF #}
{# END-FOR file #}

Properties of a file entry

Each entry also carries the ID as id. That is why file objects from $f can go straight to img().

files: all files by object

JS
files = {
  "10349": [ /* files of object 10349 */ ],
  "10350": [ /* files of object 10350 */ ]
}

{# FOR obj IN objects #}
{# INS $obj[`RegNr`] ?? `` #}
{# FOR file IN files[$obj.object_id] #}
{# IMAGE img($file, { width: 6 }) #}
{# END-FOR file #}
{# END-FOR obj #}

$m: field annotations

JS
$m = { "RegNr": { color: "red", comment: "…", source: "…" } }

Colour marking, comment and source for each field. In loops over objects, each object carries its own annotations as $obj.__m. $m is evaluated by deco() ; you can also read it directly:

{#$m[`Datierung`]?.comment ?? ``#}

$e: events of the current object

An array of the events , in the order set on the object. In a loop over objects, each object has its events as $obj.__events.

{# FOR ev IN $e #}
{# IF $ev.type === `ausstellung` #}
{# INS $ev.title #}{# INS combine($ev.role, { pre: ` (Kat. `, post: `)` }) #}
{# END-IF #}
{# END-FOR ev #}

date_from and date_to are the period of the event. date_from_override and date_to_override apply only to this object, for example a different loan period.

$l: links of the current object

The object’s links to authority data, addresses, objects and files, by the key of the link type: $l[`documented_in`] is the list of references “documented in”, in the order of the link area. In a loop over objects the same list is available under $obj.__links[`object`][`documented_in`], by library and type.

{# FOR d IN $l[`documented_in`] #}
{# INS $d.target?.label ?? `` #}{# INS combine($d.extra?.page, { pre: `, S. ` }) #}
{# END-FOR d #}

Types you may not read are missing from $l; a requested type without links gives an empty list. The check in the template editor knows $l: a type that does not exist in the project or cannot be read is listed there under Missing in project, but it is not an error.

$fmt: formatted field values

For fields with an output formatter:

{#$o[`Maße`]#}           raw
{#$fmt[`Maße`]#}         formatted, for example 118,5 × 64 × 21 cm
{#$fmt[`Maße.Objekt`]#}  a single entry

$fmt belongs to the current object and is wrong in loops over objects. Use ffmt($obj, `Maße`) there. Details under Output formatters in templates .

Do not confuse it with $f, which holds the files.

ui: view settings of the person exporting

The defaults are those of the view settings . If there is no setting at export time, Moliri uses Ja and Nein for switches.

Further reading

• Template syntax : the commands
• Template functions : the ten helpers
• Output formatters in templates : ffmt and $fmt
• Recipes : patterns to copy