Available decorator components

List of components

include:contact
include:events
include:feed
include:feeds
include:file
include:folder
include:fs-education-plan
include:image-listing
include:library-search
include:media-player
include:messages
include:number-of-resources
include:person-search-form
include:property
include:publications
include:recent-comments
include:ref
include:resource-list
include:resources
include:search-form
include:shared-text
include:tag-cloud
include:tags
include:ub-mapping
include:unit-search-form
include:uri-menu
resource:breadcrumb
resource:email-friend
resource:feedback
resource:manage-url
resource:property
resource:share-at
resource:subfolder-menu
resource:tags
resource:toc

include:contact

Description

Includes contact information from a vcard identified by the url parameter. It support vcard in text, json and xml formats.

Parameters

contact: Include contact details like email and phone numbers.

contact-mobile: Use mobile as the contact phone number if it exists.

postal: Include postal address.

title: The title shown for the included contact. Overrides the title in the vcard

url: The vcard url. For host local vcards, you get authenticated retrieval of the resource if you skip the protocol/host part.

visiting: Include visiting address.

Examples

            ${include:contact url=[/people/john.html?vrtx=vcf]}
          

            ${include:contact url=[/people/john.html?vrtx=vcf] title=[Coordinator]}
          

            ${include:contact url=[/people/john.html?vrtx=vcf] contact=[true]}
          

            ${include:contact url=[/people/john.html?vrtx=vcf] postal=[true] visiting=[true]}
          

include:events

Description

Inserts a event list component on the page

Parameters

add-to-calendar: Set to 'true' if you want add to calendar function. Default is 'false'.

all-events-link: Set to 'true' to display 'All events' link at the bottom of the list. Default is 'false'.

date-icon: Set to 'true' if you want to show event date icon. Default is 'false'.

display-tags: Set to 'true' if you want to display tags for the event. Default is 'false'

event-description: Must be set to 'true' to show event description

events-title: Set to true if you want to display title of the events folder. Default is 'false'

if-empty-message: Sets message to be shown if there are no events.

include-if-empty: Set to 'false' if you don't want to display empty events. Default is 'true'.

list-only-once: Set to 'false' if you want to list events for each day it is held.Default is 'true'.

max-events: The max number of events to display, defaults to 5

override-all-events-link-text: Sets text to be shown instead of go to all events link.

show-date: Set to false if you want to hide date on events. Default is 'true'

show-end-time: Set to 'false' if you want to hide end time for an event. This option is only available when each event is listed only once. Default is 'true'.

show-location: Set to 'false' if you don't want to show event location. Default is 'true'.

show-only-ongoing: Set to true if you only want to display ongoing events. Default is 'false'

show-picture: Set to 'true' if you want to show picture for an event. Default is 'false'.

uri: Uri to the event folder. This is a required parameter.

Examples

            ${include:events uri=[/my/events/folder/] event-description=[true] date-icon=[true] show-picture=[true] add-to-calendar=[true]}
          

include:feed

Description

Inserts a feed (RSS, Atom) component on the page

Parameters

all-messages-link: Set to 'true' to display 'All messages' link at the bottom. Defaults to 'false'.

allow-markup: Set to 'true' to include span elements and class attributes.

authors: Must be set to 'true' to show item authors.

display-categories: Set to 'true' if feed elements should display contents of category field.

display-feed-title: Set to 'false' if you don't want to show feed title

element-order: The order in which the elementes are listed.

feed-description: Must be set to 'true' to show feed description.

feed-title: Deprecated (use 'display-feed-title' instead). Kept to avoid breaking existing component references. (Set to 'false' if you don't want to show feed title).

if-empty-message: Message to be displayed if feed is empty.

include-if-empty: Set to 'false' if you don't want to display empty feeds. Default is 'true'.

item-description: Must be set to 'true' to show item descriptions.

item-picture: Must be set to 'true' to show item picture.

max-messages: The max number of messages to display, defaults to 10.

media-download: Set to 'true' to show download link for media items.

media-inline: Set to 'true' to show a player for media items. Will only do it for: audio/mpeg: (.mp3, .m3a ...). audio/mp4: (.m4a, .mp4a). audio/ogg: (.ogg, .oga, .opus). audio/webm: (.weba). audio/flac: (.flac). audio/x-wav: (.wav). For broadest browser support choose audio/mpeg (.mp3). Most browsers and platforms also supports audio/mp4.

metadatasets: List of metadatasets to display (from feed extension 'vrtx:metadatasets').

offset: The position in the message list to display messages from. Default is 0.

override-all-messages-link-text: Sets text to be shown instead of read more messages link.

override-feed-title: Optional string overriding the feed title

published-date: How to display published date, defaults to date and time. Set to 'date' to only display the date, or 'none' to not show the date.

sort: Items are shown in the same order as the feed by default.Set to 'published-date' or 'item-title' to sort by this instead. You can control the direction of the sorting by using the keywords 'asc' or 'desc'. Usage examples: sort=[asc], sort=[item-title desc], sort=[published-date asc], etc. The default is descending direction (newest first) for 'published-date' and ascending when sorting by 'item-title'.

url: The feed url. For host local feeds, you get authenticated retrieval of the resource if you skip the protocol/host part

Examples

            ${include:feed url=[/news/?vrtx=feed]}
          

            ${include:feed url=[/news/?vrtx=feed] item-picture=[true] item-description=[true]}
          

            ${include:feed url=[/news/?vrtx=feed] sort=[asc]}
          

            ${include:feed url=[/news/?vrtx=feed] sort=[item-title desc]}
          

            ${include:feed url=[/news/?vrtx=feed] sort=[published-date asc]}
          

            ${include:feed url=[/news/?vrtx=feed] element-order=[title,publishDate,picture,description]}
          

include:feeds

Description

Inserts a feed (RSS, Atom) component on the page

Parameters

allow-markup: Set to 'true' to include span elements and class attributes.

authors: Must be set to 'true' to show item authors.

display-categories: Set to 'true' if feed elements should display contents of category field.

display-channel: Whether to display the channel for feed items. Defaults to 'true'

element-order: The order in which the elementes are listed.

feed-title: Deprecated (use 'display-channel' instead). Kept to avoid breaking existing component references. (Set to 'false' if you don't want to show feed title).

if-empty-message: Message to be displayed if feed is empty.

include-if-empty: Set to 'false' if you don't want to display empty feeds. Default is 'true'.

item-description: Must be set to 'true' to show item descriptions.

item-picture: Must be set to 'true' to show item picture.

max-messages: The max number of messages to display, defaults to 10.

media-download: Set to 'true' to show download link for media items.

media-inline: Set to 'true' to show a player for media items. Will only do it for: audio/mpeg: (.mp3, .m3a ...). audio/mp4: (.m4a, .mp4a). audio/ogg: (.ogg, .oga, .opus). audio/webm: (.weba). audio/flac: (.flac). audio/x-wav: (.wav). For broadest browser support choose audio/mpeg (.mp3). Most browsers and platforms also supports audio/mp4.

metadatasets: List of metadatasets to display (from feed extension 'vrtx:metadatasets').

offset: The position in the message list to display messages from. Default is 0.

published-date: How to display published date, defaults to date and time. Set to 'date' to only display the date, or 'none' to not show the date.

sort: Items are shown in the same order as the feed by default.Set to 'published-date' or 'item-title' to sort by this instead. You can control the direction of the sorting by using the keywords 'asc' or 'desc'. Usage examples: sort=[asc], sort=[item-title desc], sort=[published-date asc], etc. The default is descending direction (newest first) for 'published-date' and ascending when sorting by 'item-title'.

urls: Comma separated list of feed URLs. Add ';channel=<text>' to a URL to override channel information for individual feeds

Examples

            ${include:feeds urls=[/news/?vrtx=feed,/events/?vrtx=feed]}
          

            ${include:feeds urls=[/news/?vrtx=feed,/events/?vrtx=feed] display-channel=[true] sort=[published-date asc]}
          

            ${include:feeds urls=[/news/?vrtx=feed;channel=Custom channel info,/events/?vrtx=feed] display-channel=[true]}
          

include:file

Description

Includes the contents of another document in the page

Parameters

authenticated: The default is that only resources readable for everyone is included. If this is set to 'true', the include is done as the currently logged in user (if any). This should only be used when the same permissions apply to the resource including and the resource included.Note that this doesn't apply to virtual includes of full URLs.

element: Selects an element from the included document (used in conjunction with the 'file' or 'virtual' parameters). The parameter must be a dot-separated path from the root element to the desired element: for example, the expression 'html.body.h1' selects the (first) h1 element in the HTML body.

file: The path to the file to include. Both relative and absolute paths are interpreted

ignore-missing: Whether to ignore missing resources. Default is 'false'.(This parameter only applies when using the file parameter.)

virtual: Either a complete URL, or a path to the file to include. Both relative and absolute paths are interpreted.

Examples

            ${include:file file=[/about/address.html] element=[html.body.h1]}
          

include:folder

Description

Inserts a folder item list component on the page

Parameters

compact-view: Set to 'true' to show compact view. Default is false

folder-title: Set to 'true' to show folder title. Default is false

go-to-folder-link: Set to 'true' to show 'Go to folder' link. Default is false

max-items: Defines how many items from the folder that will be visible in the list. Any defined value must be above 0 else the default value is 10

sorting: Sort the listing on one or more properties, e.g. 'modifiedBy asc,lastModified desc'

uri: Uri to the folder. This is a required parameter

Examples

            ${include:folder uri=[/path/to/folder/] max-items=[5] go-to-folder-link=[true] folder-title=[true]}
          

include:fs-education-plan

Description

Generate the study model from FS data

Parameters

educationPlan: A A Json.ListContainer containing studieoppbygninger from FS Graphql

fallback: Fall back to an earlier version of a course if one is not found for the term in question

include:image-listing

Description

Inserts an image list or gallery, depending on parameter setup.

Parameters

exclude-scripts: Use to exclude multiple inclusion of scripts for gallery display. Set to 'true' when including more than one image gallery on same page. Default is 'false'.

fade-effect: Milliseconds of fade effect for choosen image. Default is 0 or off, and max is 999 ms.

hide-thumbnails: Optional parameter used when parameter 'type' is set to 'gallery'. When set to 'true', will hide thumbnails in gallery view. Default is 'false'.

limit: Maximum number of images to show in list. Default is 5.

max-height: Optional parameter used when parameter 'type' is set to 'gallery'. Default is 4-3 (on). Can be set to '4-3', '16-9' or 'none' (off).

type: How to the display the component. Default is 'list'. 'gallery' will display an embedded gallery.

uri: URI of the image folder to include pictures from (root-relative or absolute).

Examples

            ${include:image-listing uri=[/about/images] type=[gallery] fade-effect=[200]}
          

include:library-search

Description

include:media-player

Description

Inserts media player if it is an article document

Parameters

autoplay: Start playing immediately if set to 'true', it will start playing in muted mode. Default is 'false'

content-type: Content type of media file

height: Height of player

live-stream-type: Indicates type of live stream. (RTMP, HLS or DASH)

loop: Loops video if set to 'true'. Default is 'false'

poster: Poster image for video

show-download-link: Shows download link if set to 'true'. Default is 'false'

show-embed-box: Shows embed box for iframe sharing if set to 'true. Default is 'false'

stream-type: Set to live for live stream

url: Media file url or uri

width: Width of player

Examples

            ${include:media-player url=[rtmp://stream-prod01.uio.no/vod/mp4:uio/usit/test/big_buck_bunny_1200.mp4] width=[720] height=[406] content-type=[video/mp4]}
          

include:messages

Description

Parameters

compact-view: Set to 'true' to show compact view. Default is false

include-if-empty: Set to 'false' if you don't want to display empty message listings. Default is 'true'.

max-number-of-messages: Maximum number of messages to display.

show-created-by: Must be set to 'true' to show who created the message.

title: Title to set on messages list.

uri: URI of the message folder to include messages from.

Examples

            ${include:messages uri=[/messages/to/display/] max-number-of-messages=[15]}
          

include:number-of-resources

Description

Counts the total number of resources, optionally under a provided folder reference.

Parameters

exclude-folders: Comma seperated list with absolute paths to folder to NOT include in count (optional). Overrides any match provided by parameter 'folder'.

folders: Comma seperated list with absolute paths to folder to count resources from (optional).

resource-type: The resource type to count. Default is 'file' (optional).

Description

Display an input form for person search.

Parameters

affiliation: Optional. The type of affiliation to restrict search to. E.g. 'affiliation=[employee]' will search for employees only. Valid values are 'employee', 'employee_sci', 'employee_adm' and 'student'.

areacode: Optional. The areacode to restrict search to. E.g. 'areacode=[140000]' will search for persons affiliated with unit 140000 (Faculty of Humanities) only. Cannot take multiple areacodes.

lang: Optional. The language to match search results on. Valid values are 'no', 'nn' and 'en'. Current language if not provided.

submit: Optional. The local path to submit to. Current path if not provided.

include:property

Description

Report a property on a resource, as specified by either uri or uri-level. The property is formatted and localized.

Parameters

format: Optional format specification

id: Identifies the property to report. One of 'uri', 'name', 'type' or '<prefix>:<name>' identifying a property.

ignore-retrieval-errors: Whether to ignore resource retrieval errors, such as 'resource not found', 'unauthorized' etc. Default is 'false'.

uri: Report property for resource specified by this (absolute or relative) uri.

uri-level: Report property for the resource on this level of the current resource's uri.Root ("/") has level 0. If the current resource is on a higher level, nothing is reported.

include:publications

Description

Inserts a publications component on the page. Mandatory parameters are 'publication-type' and 'publication-identifier'(legacy: 'publication-type-identifier').

Parameters

compact-view: Option to use compact view of the component. Default is 'false'.

display-title: Option to show title of component. Default is 'true'

internal-document-uri: Manual results content file.

merge-and-hide-tabs: Option to hide tabs and merge all publications into one view. Default is 'false'

number-of-publications: Option to override number of publications to show. Default is '100'.

publication-identifier: Identifier of object to retrieve.

publication-type: Set type of publications to retrive. Choices are 'unit', 'person' or 'project'.

publication-type-identifier: Identifier of object to retrieve (old, for compatability).

show-cristin-publications-link: Option to show a link to publications externally. Default is 'true'

show-custom-publications: Show custom publications specified in custom publications file ('internal-document-uri')

show-summary: Option to show publication summary. Default is 'true'

surname-first: Option to display contributor names as 'Surname, Firstname' instead of 'Firstname Surname'. Default is 'true'

Examples

            ${include:publications publication-type=[unit] publication-identifier=[100000]}
          

            ${include:publications publication-type=[unit] publication-identifier=[10*]}
          

            ${include:publications publication-type=[unit] publication-identifier=[*]}
          

            ${include:publications publication-type=[unit] publication-identifier=[1010*]}
          

            ${include:publications publication-type=[unit] publication-identifier=[101010]}
          

include:recent-comments

Description

Lists recent comments under the current collection

Parameters

include-if-empty: Set to 'false' if you don't want to display empty comments. Default is 'true'.

max-comments: Maximum number of comments to display. The default value is 10.

Examples

            ${include:recent-comments max-comments=[5] include-if-empty=[false]}
          

include:ref

Description

Parameters

id: Identity for the reference

program-id: Optional identity for program to help identify a program option

referencetype: Type of reference

include:resource-list

Description

List resources from a set of folders

Parameters

display-tile: Whether the title list tile should be shown. Default true (optional).

folders: Which explicit folders to list resources from (required).

go-to-folder-link: Whether a link to the folder should be provided. Default false (optional).

max-items: How many resources to list from each folder (optional).

parent-folder: Parent folder to start search from. (optional). Explicit relative folder references provided in property 'folders' will use this as their parent.

resource-type: The resource type to include. Default is 'file' (optional).

result-sets: How many columns the result set should be devided in. Default two (optional).

Examples

            ${include:resource-list folders=[/first/folder,/second/folder] resource-type=[article] max-items=[50]}
          

include:resources

Description

Include some specific resources.

Parameters

item-description: Must be set to 'true' to show item descriptions.

item-picture: Must be set to 'true' to show item picture.

metadatasets: Comma separated list of metadatasets to display, e.g. 'article-categories, event-type, institute'

published-date: How to display published date, defaults to date and time. Set to 'date' to only display the date, or 'none' to not show the date.

uris: Comma separated list of absolute or relative paths to resources.

Description

Inserts search-form that searches current directory. To override you can specify 'uri' parameter.

include:shared-text

Description

Parameters

file: File (no file extension) containing shared text snippets

folder: Path to folder containing shared text snippets

key: ID of shared text snippet

namespace: Property namespace (use with 'propName')

propName: Property name (use with 'namespace')

uri: Full path to the shared text document

Examples

            ${include:shared-text uri=[/vrtx/fellestekst/uh/organisasjonsenhet.html] key=[EIE]}
          

Description

Renders a tag cloud as an alphabetically sorted list. Classes are put on the elements for representing the magnitude of the individual tags in the cloud. List elements will be assigned classes 'tag-magnitude-N', where N represents the magnitude as a bounded positive integer number.

Parameters

limit: Set limit on how many tags to include. Setting this to a low value will show only the most popular tags. Default is: 20

magnitude-max: Sets the maximum magnitude for a tags in the cloud (an integer number bigger than 1). The tags with the highest occurrence will be assigned the maximum magnitude value. You can use this to adjust the granularity of the magnitude-scale. Note that this number must be bigger than or equal to the minimum value (see next parameter). Default value is: 5

magnitude-min: Sets the minimum magnitude for a tag in the tag cloud (an integer number bigger than 1). The tags with the lowest occurrence within the result set will be assigned the minimum magnitude value. The result set can be restricted using the parameters 'scope' and 'limit'. Default value is: 1

scope: Set the URI scope for the tag cloud. Relative URIs are allowed. Only tags existing in the folder tree given by the URI will be taken into consideration when generating the tag cloud. The default value is the current directory and below.

service-url: Deprecated: NO LONGER USED. Kept to avoid breaking existing component references.

tag-occurence-min: Limit tag cloud to include only tags with an occurrence count higher than or equal to this minimal value. This can be used to weed out tags with for instance only one or two occurrences within the scope. The default value is 1. Increase this as needed, if your tag cloud contains many undesirable small tags with only few occurrences.

tag-occurrence-min: Limit tag cloud to include only tags with an occurrence count higher than or equal to this minimal value. This can be used to weed out tags with for instance only one or two occurrences within the scope. The default value is 1. Increase this as needed, if your tag cloud contains many undesirable small tags with only few occurrences.

Examples

            ${include:tag-cloud scope=[/my/folder] limit=[15] tag-occurrence-min=[5] magnitude-max=[8] magnitude-min=[1]}
          

include:tags

Description

Renders tags as an alphabetically sorted list.

Parameters

display-dropdown: Whether or not to display tags as a dropdown menu. Default is: false

display-scope: Whether or not to display the current scope in the page title when linking to a single tag. Default is 'false'

limit: Set limit on how many tags to include. Setting this to a low value will show only the most popular tags. Default is: 2147483647

override-resource-type-title: User provided resource type title to use in page title when linking to a single tag.

resource-type: Comma seperated list of resource types to search for tags in.

result-sets: The number of result sets to split the result into. The default value is: 1

scope: Set the URI scope for the tag cloud. Relative URIs are allowed. Only tags existing in the folder tree given by the URI will be taken into consideration when generating the tag cloud. The default value is the current directory and below.

show-occurence: Display a number indicating the number of documents associated with the tag. Default value is: false

show-occurrence: Display a number indicating the number of documents associated with the tag. Default value is: false

sort-selected-by: Comma seperated list of attributes to sort a selected tag by from the result. Each attribute in the format [prefix]:[name]:[sortdirection]. Prefix is optional. For example: resource:surname:asc

url-pattern: Pattern for generating a tag URL. Occurrences of '%t' are replaced with the tag value. Occurrences of %p are replaced with the current URI

whitelist: Comma separated whitelist of tags. Whitelist is optional. Example: whitelist=[tag1,tag2]

Examples

            ${include:tags scope=[/example/folder] limit=[15] result-sets=[2] show-occurrence=[true] resource-type=[structured-article,structured-event]}
          

include:ub-mapping

Description

Parameters

link-title: Title for the ub-mapping link.

prefix: Prefix to ub-mapping. This parameter is required.

uri: URI of the ub-mapping file.

Examples

            ${include:ub-mapping prefix=[inf]}
          

Description

Inserts search-form that searches current directory. To override you can specify 'uri' parameter.

Description

Displays a menu based on the subfolders of a specified folder (path)

Parameters

authenticated: The default is that only resources readable for everyone is listed. If this is set to 'true', the listing is done as the currently logged in user (if any).

depth: Specifies the number of levels to retrieve subfolders for. The default value is '1', which retrieves the top level.

display-from-level: Defines the starting URI level for the menu (cannot be used with the 'uri' parameter)

exclude-children: A listing of child resources to exclude (cannot be used in conjunction with 'include-children').

include-children: An explicit listing of the child resources to include. (Only applicable for resources at level 1.)

include-parent-folder: Whether or not to include the selected folder itself in the menu. Defaults to 'false'.

parent-folder-title: Overrides the parent folder title if include-parent-folder is set to true.

style: Defines the style of the menu. Must be one of [horizontal, tabs, vertical, none]. Defaults to none.

uri: The URI (path) to the selected folder.

Examples

            ${include:uri-menu style=[horizontal] uri=[/example/folder] include-parent-folder=[true] parent-folder-title=[Home] authenticated=[true]}
          

            ${include:uri-menu display-from-level=[2] depth=[3] exclude-children=[bilder,intern]}
          

Description

Inserts a breadcrumb trail to the current document

Parameters

display-folders-hidden-from-navigation: Display folders hidden from navigation in breadcrumb trail. The default is 'false'.

display-from-level: Defines the starting URI level for the breadcrumb

display-services: Display name of service. The default is 'true'.

downcase: If set to 'true', display breadcrumb elements in lower-case. The default is 'false'.

hide-prefix: If set to 'true', the prefix 'You are here:' will be hidden. The default is 'false'.

include-last-element: Whether to include the last element in the breadcrumb. The default is 'false'.

stop-at-level: This stops the breadcrumb generation at a certain number of levels. The default is none.

Examples

            ${resource:breadcrumb downcase=[true]}
          

resource:email-friend

Description

Inserts a URL to email-a-friend service

resource:feedback

Description

Component for giving feedback

Parameters

contact-url: Specify contact url. Default is { "default": "https://www.uio.no/om/kontaktinformasjon/", "en": "https://www.uio.no/english/about/contact/" }

mail-to: Specify who will receive feedback email. Default is tilbakemelding@admin.uio.no

reply-to-field: Enables reply to email address field. Overrides contacl url.

Examples

            ${resource:feedback mail-to=[nettredaktor@example.com] contact-url=[https://www.example.com/services/contact/]}
          

            ${resource:feedback mail-to=[nettredaktor@example.com] reply-to-field=[true]}
          

resource:manage-url

Description

Inserts the admin URL of the current document

Parameters

display-only-if-auth: If set to 'true', do not display anything unless the user is logged in.

resource:property

Description

Report a property on the current resource, as a formatted and localized string

Parameters

format: Optional format specification

id: Identifies the property to report. One of 'uri', 'name', 'type' or '<prefix>:<name>' identifying a property.

ignore-retrieval-errors: Whether to ignore resource retrieval errors, such as 'resource not found', 'unauthorized' etc. Default is 'false'.

Examples

            ${resource:property id=[uri] uri=[/example/folder/index.html]}
          

            ${resource:property id=[name] uri=[/example/folder/index.html]}
          

            ${resource:property id=[type] uri=[/example/folder/index.html]}
          

            ${resource:property id=[lastModified] uri=[/example/folder/index.html]}
          

            ${resource:property id=[lastModified] uri-level=[2]}
          

            ${resource:property id=[uri]}
          

            ${resource:property id=[name]}
          

            ${resource:property id=[type]}
          

            ${resource:property id=[lastModified]}
          

            ${resource:property id=[resource:author]}
          

            ${resource:property id=[tags]}
          

            ${resource:property id=[creationTime] format=[short]}
          

            ${resource:property id=[creationTime] format=[short_no]}
          

            ${resource:property id=[creationTime] format=[long]}
          

            ${resource:property id=[creationTime] format=[long_no]}
          

            ${resource:property id=[creationTime] format=[iso-8601]}
          

            ${resource:property id=[creationTime] format=[iso-8601-short]}
          

            ${resource:property id=[creationTime] format=[rfc-822]}
          

            ${resource:property id=[creationTime] format=[yyyy-MM-dd'T'HH:mm:ssZZ]}
          

            ${resource:property id=[owner]}
          

            ${resource:property id=[createdBy]}
          

            ${resource:property id=[contentLastModified]}
          

            ${resource:property id=[contentModifiedBy]}
          

            ${resource:property id=[title]}
          

Description

Inserts share component

Description

Lists the child folders of the current folder

Parameters

authenticated: The default is that only resources readable for everyone is listed. If this is set to 'true', the listing is done as the currently logged in user (if any)

depth: Specifies the number of levels to retrieve subfolders for. The default value is '1'

direction: The sort direction. Legal values are 'asc', 'desc'. The default value is 'asc'

display: Specifies how to display the subfolder-menu. The default is normal lists. 'comma-separated' separates sublist-elements with commas.

display-from-level: Defines the starting URI level for the subfolder-menu

exclude-folders: Commma-separated list with relative paths to folders which should not be displayed in the list

freeze-at-level: At which level the subfolder-listing should freeze and show the same listing further down. The default is none.

group-result-sets-by: The number of results-sets in grouping divs

include-hidden: Specifies whether to display folders that have the 'hide in menus'attribute set. The default is 'false'

limit: The maximum number of folders to display. The default is 1000

max-number-of-children: Defines the maximum number of children displayed for each element

result-sets: The number of result sets to split the result into. The default value is '1'

sort: The name of a property to sort results by. Legal values are ('name', 'title'). The default property is 'title'

title: The menu title

uri: The URI (path) to the selected folder.

Examples

            ${resource:subfolder-menu title=[Subareas] result-sets=[2]}
          

resource:tags

Description

Display the value(s) of a string property, with link(s) to search

Parameters

service-url: Optional reference to service (default is '/?vrtx=tags&tag=%v')

title: Optional title (default is 'Tags')

Examples

            ${resource:tags title=[Tags]}
          

resource:toc

Description

Inserts a table of contents based on h2/h3 in the document

Parameters

h1-6: Optional title (h1-h6) for the table of contents. Overrides 'title'.

title: Optional title for the table of contents.

Examples

            ${resource:toc title=[Table of contents]}
          

            ${resource:toc h2=[Table of contents]}
          

Available decorator components

List of components

include:contact

Description

Parameters

Examples

include:events

Description

Parameters

Examples

include:feed

Description

Parameters

Examples

include:feeds

Description

Parameters

Examples

include:file

Description

Parameters

Examples

include:folder

Description

Parameters

Examples

include:fs-education-plan

Description

Parameters

include:image-listing

Description

Parameters

Examples

include:library-search

Description

include:media-player

Description

Parameters

Examples

include:messages

Description

Parameters

Examples

include:number-of-resources

Description

Parameters

include:person-search-form

Description

Parameters

include:property

Description

Parameters

include:publications

Description

Parameters

Examples

include:recent-comments

Description

Parameters

Examples

include:ref

Description

Parameters

include:resource-list

Description

Parameters

Examples

include:resources

Description

Parameters

include:search-form

Description

include:shared-text

Description

Parameters

Examples

include:tag-cloud

Description

Parameters

Examples