Paging Plugin
This is a special interaction plugin that allows you to integrate paging into templated content items (i.e. a Content Root Object that uses the template
and items
properties). In order to use this plugin, a corresponding content service must be implemented that processes the requested items (i.e. by evaluating the offset
and limit
parameters). The plugin can be used with version 0.1.82 or higher.
Usage[edit]
The plugin must be loaded with a content service URL that is able to evaluate the offset
and limit
parameters. Optionally, the requested limit can be indicated (by default, it is set to 20
). Please see following action syntax examples.
content:request:interaction:{URL}@http://msx.benzac.de/interaction/paging.html
content:request:interaction:{URL}|{LIMIT}@http://msx.benzac.de/interaction/paging.html
The content service URL should contain the keywords {OFFSET}
and {LIMIT}
, which are replaced with the corresponding offset and limit values. Please see following action syntax examples.
content:request:interaction:http://link.to.content?offset={OFFSET}&limit={LIMIT}@http://msx.benzac.de/interaction/paging.html
content:request:interaction:http://link.to.content?offset={OFFSET}&limit={LIMIT}|40@http://msx.benzac.de/interaction/paging.html
Syntax[edit]
Parameter | Type | Default Value | Mandatory | Description |
---|---|---|---|---|
offset |
number |
0 |
No |
The offset that specifies from which offset the items should start. Note: The initial request from the pagaing plugin will always have the offset |
limit |
number |
20 |
No |
The limit that specifies how many items should be returned. Note: If the content service returns less or more items then indicated, no additional items will be requested. |