Difference between revisions of "Input Plugin"

From MSX - Wiki
Jump to navigation Jump to search
Line 15: Line 15:
  
 
* <code>content:request:interaction:http<span>://</span>link.to.input.handler?input={INPUT}@http://msx.benzac.de/interaction/input.html</code>
 
* <code>content:request:interaction:http<span>://</span>link.to.input.handler?input={INPUT}@http://msx.benzac.de/interaction/input.html</code>
* <code>content:request:interaction:http<span>://</span>link.to.input.handler?input={INPUT}|search|en|Headline|http://msx.benzac.de/img/bg1.jpg|Extension|Hint text@http://msx.benzac.de/interaction/input.html"
+
* <code>content:request:interaction:http<span>://</span>link.to.input.handler?input={INPUT}|search|en|Headline|http<span>://</span>link.to.image|Extension|Hint 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.
 
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.

Revision as of 14:54, 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.

The content service URL should contain the keyword {INPUT}, which is replaced with the corresponding value. Please see following action syntax examples.

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
input string "" Yes

The input that should be handled.

Note: For search inputs, the input is automatically submitted.

Example[edit]

Screenshot[edit]

Example Screenshot (Input Plugin)

Code[edit]

//TODO

Demo[edit]

See also[edit]