Difference between revisions of "Input Plugin"
(Created page with "This is a special interaction plugin that allows you to handle complex inputs for special use cases (e.g. links, user names, passwords, search queries, etc.). In order to use...") |
|||
| Line 1: | Line 1: | ||
| − | This is a special interaction plugin that allows you to handle complex inputs for special use cases (e.g. | + | This is a special interaction plugin that allows you to handle complex inputs for special use cases (e.g. user names, passwords, search queries, etc.). In order to use this plugin, a corresponding content service must be implemented that processes the submitted input (e.g. by evaluating an <code>input</code> parameter). The plugin can be used with version '''0.1.123''' or higher. |
== Usage == | == Usage == | ||
Revision as of 14:52, 22 February 2024
This is a special interaction plugin that allows you to handle complex inputs for special use cases (e.g. user names, passwords, search queries, etc.). In order to use this plugin, a corresponding content service must be implemented that processes the submitted input (e.g. by evaluating an input parameter). The plugin can be used with version 0.1.123 or higher.
Usage[edit]
The plugin must be loaded with a content service URL that is able to evaluate the input (which can be set as URL parameter). Optionally, a type, a default language, a headline, a background, an extension, and/or a hint can be set. Please see following action syntax examples.
content:request:interaction:{URL}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:{URL}|{TYPE}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}|{HEADLINE}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}|{HEADLINE}|{BACKGROUND}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}|{HEADLINE}|{BACKGROUND}|{EXTENSION}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}|{HEADLINE}|{BACKGROUND}|{EXTENSION}|{HINT}@http://msx.benzac.de/interaction/input.html
The content service URL should contain the keyword {INPUT}, which is replaced with the corresponding value. Please see following action syntax examples.
content:request:interaction:http://link.to.input.handler?input={INPUT}@http://msx.benzac.de/interaction/input.htmlcontent:request:interaction:http://link.to.input.handler?input={INPUT}|search|en|Headline|http://msx.benzac.de/img/bg1.jpg%7CExtension%7CHint text@http://msx.benzac.de/interaction/input.html"
If you would like to use the plugin as reference to implement your own plugin, please have a look at this implementation script: http://msx.benzac.de/interaction/js/input.js.
Note: Currently, the paging plugin cannot be used with panels.
Syntax[edit]
Parameter syntax of content service for input plugin
Parameter
Type
Default Value
Mandatory
Description
inputstring""Yes
The input that should be handled.
Note: For search inputs, the input is automatically submitted.
Example[edit]
Screenshot[edit]
Code[edit]
//TODO
Demo[edit]
See also[edit]