Versions Compared

Key

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

...

Section
titleProperties


Section
titleDocument

The Resource document to reference. Leave blank, if the citation refers to current resource document.


Section
titleTemplate

The template to render the values. If you do not specify a page (refer to 'Source Page'), remove the page from the template.

This is the format of the template:

Panel
  $[Name] (${Authors}, ${page})



box-version
projectdoc-
since4.13

Since version 4.13 the parameter supports to reference a

Static Document Link
documentSpace Properties
labelspace property
. The name of the space property has to be prefixed with the paragraph sign ('§').

For instance, if the value for the template parameter is specified by the space property my-select, then the value of the template parameter is §my-select.

projectdoc-section
titleTooltip

The text entered with this parameter is rendered as a tooltip. If no tooltip is specified, the short description of the referenced resource document is used as a tooltip.

A blank value (e.g. a single space) will instruct the macro to render no tooltip.

Version Box
since4.5

This parameter is supported since version 4.5.


Version Box
since4.6

Since version 4.6 the tooltip supports templates. It may contain property placeholders (like ${Name} is written by ${Authors})  of the referenced document.



Section
titleSource Page

The page within the resource the citation points to. Usually this takes the form

  • p. 42
  • p. 23f
  • p. 23ff
  • p. 23-42.


Section
titleApply Space Properties

If checked the properties defined by the space of the document this macro is part of are applied as defaults.

Since these values are defaults they will only apply, if no document properties match.

Version Box
since4.13

This parameter is available since version 4.13.



Section
titleDefault Value

The default value to render, if the template resolves to a blank value.

Usually the default is a blank value. Set it to a non-blank to make sure that a template resolving to nothing is rendered with an alert message.


...