- Created by Robert Reiner, last modified on 30. Jan 2020
projectdoc Toolbox
Renders the value of a document property as an image. The property value is required to an URL that points to an image.
- Audience
- Categories
- Tags
- Type
This macro transcludes the value of a document property and takes it as an URL to an image. The image is rendered instead of the URL text.
Properties
Document
The document the property is part of.
If not specified, the current document is used. This allows to render the value of a property of the same document at several places of this document, without duplicating the value.
Within the Document Properties Marker Macro
- you must not reference a property of the same document before it is defined. If you use this macro as the value of a document property, the macro must only reference properties that haven been specified prior.
- do not reference properties of pages with different page access restrictions!
Property Name
The name of the property to fetch the property value. This value is required to be a reference to an image.
The property may either be in plain text or a link (i.e. an anchor element with an href attribute).
Since 3.1
Since version 3.1 this value may also be an image (i.e. an img element with an src attribute).
This makes it easier for users to paste an image to a property value and then access this image via the Display Document Property As Image Macro.
Add Link
If checked, a link to this document is rendered with the image.
Until 1.17.1
Prior to version 2.0 a link to the referenced image is rendered, if the property is checked.
If Link Property is set, the value of this property is overridden.
Link Property
The name of the property to determine the URL for the image. If blank, no link will be rendered.
Since 2.0
This parameter is available since version 2.0.
Identifier
Unique identifier of the macro for the rendered context.
Features may supply default configurations dependent on the value of this property.
Since 4.0
This parameter is available since version 4.0 of the projectdoc Toolbox.
Identifier Classes
Identifiers to address this macro as part a group for the rendered context.
Features may supply default configurations dependent on the value of this property.
Since 4.0
This parameter is available since version 4.0 of the projectdoc Toolbox.
Autocomplete Space Closure
Define the scope to search for documents in the Autocomplete context.
Only documents within this scope will be accepted by the Autocomplete for the Documents parameter.
Further constraints on the space can be declared by the use of the Autocomplete Constraints parameter.
Default space is the delegate space of the current space.
Since 4.3
This parameter is available since version 4.3 of the projectdoc Toolbox.
Before this the space closure could not be changed from its default delegate space.
This property is only used in the context of the Autocomplete function. It is only enforced on Autocomplete in the browser.
Changes to the parameter value will only take effect on the next Autocomplete selections. But there is also no guarantee that the list of selected documents will not be filtered later. The not enforced constraint is that the selected documents should match the constraints.content
Autocomplete Constraints
Provide a Where clause to select on documents for the autocomplete feature of this macro.
This parameter is only to control the autocomplete feature of this macro. If empty, no constraints are put on the list documents presented.
Since 4.0
This parameter is available since version 4.0 of the projectdoc Toolbox.
This property is only used in the context of the Autocomplete function. It is only enforced on Autocomplete in the browser.
Changes to the parameter value will only take effect on the next Autocomplete selections. But there is also no guarantee that the list of selected documents will not be filtered later. The not enforced constraint is that the selected documents should match the constraints.content
Related macros
- Display Document Properties Macro
- Renders a template with property references.
- Display Document Property As Link Macro
- Renders the value of a document property as a link with an alternative label.
- Display Document Property As List Macro
- Renders the list value of a document property.
- Display Document Property Macro
- Renders the value of a property of a document.
- Display Document Property Ref Concat Macro
- Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property.
- Display Document Property Ref Macro
- Displays a document property from a referenced document.
- Display Space Attribute Macro
- Renders a space attribute value.
- Display Space Property Macro
- Renders a space property value.
- Tour Macro
- Renders a predefined list of documents in a table.
Resources
| Name | Short Description | Doctype |
|---|---|---|
| Deep Links in Queries | Deep links can be used on both sides of predicates in a Where Clause. | topic |
| Display List Macro | Lists references to projectdoc documents in a list. List contain names and optional short descriptions. | macro |
| Display List Template Macro | Lists references to projectdoc documents in a list. List items are defined by templates referencing properties. | macro |
| Display Table Macro | Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | macro |
| Index Card Macro | Renders transcluded content fetched from documents of a result set. | macro |
| Index Entries Table Macro | Renders a table of index entries. | macro |
| Transclude Documents Macro | Renders transcluded content fetched from documents of a result set. | macro |
