Difference between revisions of "Paging Plugin"

From MSX - Wiki
Jump to navigation Jump to search
(Created page with "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 <code>template</code> and <...")
 
Line 1: Line 1:
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 <code>template</code> and <code>items</code> property). The plugin can be used with version '''0.1.82''' or higher.
+
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 <code>template</code> and <code>items</code> properties). The plugin can be used with version '''0.1.82''' or higher.
 +
 
 +
== Usage ==
 +
The plugin must be loaded with a content URL. Optionally, the limit can be indicated (by default, the limit se to <code>20</code>). Please see following action syntax examples.
 +
 
 +
* <code>content:request:interaction:{URL}@http://msx.benzac.de/interaction/paging.html</code>
 +
* <code>content:request:interaction:{URL}|{LIMIT}@http://msx.benzac.de/interaction/paging.html</code>
 +
 
 +
The content URL should contain the keywords <code>{OFFSET}</code> and <code>{LIMIT}</code>, which are replaced with the corresponding values. Please see following action syntax examples.
 +
 
 +
* <code>content:request:interaction:http://link.to.content?offset={OFFSET}&limit={LIMIT}@http://msx.benzac.de/interaction/paging.html</code>
 +
* <code>content:request:interaction:http://link.to.content?offset={OFFSET}&limit={LIMIT}|20@http://msx.benzac.de/interaction/paging.html</code>

Revision as of 19:22, 8 February 2024

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). The plugin can be used with version 0.1.82 or higher.

Usage[edit]

The plugin must be loaded with a content URL. Optionally, the limit can be indicated (by default, the limit se to 20). Please see following action syntax examples.

The content URL should contain the keywords {OFFSET} and {LIMIT}, which are replaced with the corresponding values. Please see following action syntax examples.