Input Plugin - Revision history

Benzac: /* Code */

2024-10-01T09:55:17Z

Code

Benzac at 12:42, 22 April 2024

2024-04-22T12:42:41Z

Benzac at 15:45, 23 March 2024

2024-03-23T15:45:45Z

Benzac: /* Usage */

2024-03-20T08:40:47Z

Usage

Benzac: /* Usage */

2024-03-20T08:40:29Z

Usage

Benzac: /* Syntax */

2024-03-17T11:02:41Z

Syntax

Benzac: /* Syntax */

2024-03-17T09:32:45Z

Syntax

Benzac: /* Syntax */

2024-03-17T09:29:13Z

Syntax

Benzac: /* Syntax */

2024-03-17T09:28:36Z

Syntax

Benzac: /* Syntax */

2024-03-17T09:28:07Z

Syntax

@@ Line 160: / Line 160: @@
              "label": "Login",
              "action": "execute:fetch:http://msx.benzac.de/services/input.php?type=login"
          }]
+}

@@ Line 13: / Line 13: @@
 * <code>content:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}|{HEADLINE}|{BACKGROUND}|{EXTENSION}|{HINT}|{PLACEHOLDER}@http://msx.benzac.de/interaction/input.html</code>
 * <code>content:request:interaction:{URL}|{TYPE}|{DEFAULT_LANG}|{HEADLINE}|{BACKGROUND}|{EXTENSION}|{HINT}|{PLACEHOLDER}|{LIMIT}@http://msx.benzac.de/interaction/input.html</code>
 The <code>{TYPE}</code> part can be set to one of the following values.

@@ Line 76: / Line 76: @@
+}
 </syntaxhighlight>
-Please note that for responses that contain a <code>template</code> and <code>items</code> property, the properties <code>headline</code>, <code>extension</code>, <code>background</code>, and <code>hint</code> will also be used (and will replace potential initial values). Please also note that the root content is compressed (i.e. the layout grid size is 16x8). Therefore, for uncompressed content, the <code>decompress</code> property in the <code>template</code> object is set to <code>true</code>. However, the decompression feature is only available in version '''0.1.155''' or higher. If you want to display compressed content, please ensure the <code>compress</code> property is set to <code>true</code> in your response data.
+Please note that for responses that contain a <code>template</code> and <code>items</code> property, the properties <code>headline</code>, <code>extension</code>, <code>background</code>, and <code>hint</code> will also be used (and will replace potential initial values). Additionally, the properties <code>preload</code>, <code>footer</code>, and <code>inserts</code> will be taken over. Please note that the root content is compressed (i.e. the layout grid size is 16x8). Therefore, for uncompressed content, the <code>decompress</code> property in the <code>template</code> object is set to <code>true</code>. If you want to display compressed content, please ensure the <code>compress</code> property is set to <code>true</code> in your response data.
 Similar to the [[Paging Plugin]], the input plugin supports paging if the content service URL contains the keywords <code>{OFFSET}</code> and <code>{LIMIT}</code> and a limit is indicated (e.g. <code>content:request:interaction:http<span>://</span>link.to.input.handler?input={INPUT}&offset={OFFSET}&limit={LIMIT}||||||||20@http://msx.benzac.de/interaction/input.html</code>).

@@ Line 2: / Line 2: @@
 == Usage ==
-The plugin must be loaded with a content service URL that is able to process the input (which is generally set as <code>input</code> URL parameter). Optionally, a type, a default language, a headline, a background, an extension, a hint, placeholder, and/or limit (for paging) can be set. Please see following action syntax examples.
+The plugin must be loaded with a content service URL that is able to process the input (which is generally set as <code>input</code> URL parameter). Optionally, a type, a default language, a headline, a background, an extension, a hint, a placeholder, and/or a limit (for paging) can be set. Please see following action syntax examples.
 * <code>content:request:interaction:{URL}@http://msx.benzac.de/interaction/input.html</code>

@@ Line 2: / Line 2: @@
 == Usage ==
-The plugin must be loaded with a content service URL that is able to process the input (which is generally set as <code>input</code> URL parameter). Optionally, a type, a default language, a headline, a background, an extension, a hint, and/or placeholder can be set. Please see following action syntax examples.
+The plugin must be loaded with a content service URL that is able to process the input (which is generally set as <code>input</code> URL parameter). Optionally, a type, a default language, a headline, a background, an extension, a hint, placeholder, and/or limit (for paging) can be set. Please see following action syntax examples.
 * <code>content:request:interaction:{URL}@http://msx.benzac.de/interaction/input.html</code>

@@ Line 112: / Line 112: @@
 A keyword that indicates that user credentials (e.g. cookies, authorization headers, etc.) are enabled for content service requests. Technically, this keyword sets the <code>withCredentials</code> flag for the <code>XMLHttpRequest</code> object to <code>true</code>. If the content service uses HTTP sessions and manages them via cookies, you should add this keyword.
 |}
-'''Note: The parameter column shows the recommended parameter names. Generally, the keywords can also be set to other parameter names or integrated into the path of the content service URL.'''
+'''Note: The parameter column shows the recommended parameter names. Generally, each keyword can be set to any parameter name or integrated into the path of the content service URL.'''
 == Example ==

@@ Line 92: / Line 92: @@
 | <code>{ID}</code> || <code>id</code> || <code>string</code> || <code>null</code> || No ||
 An automatically generated unique device ID.
 |-
 | <code>{LANG}</code> || <code>lang</code> || <code>string</code> || <code>"en"</code> || No ||
 The currently used keyboard layout (e.g. for auto-completion of search queries).
 |-
 | <code>{OFFSET}</code> || <code>offset</code> || <code>number</code> || <code>0</code> || No ||

@@ Line 90: / Line 90: @@
 ! Keyword !! Parameter !! Type !! Default Value !! Mandatory !! class="unsortable" | Description
 |-
-| <code>{ID}</code> || <code>id</code> || <code>string</code> || <code>""</code> || No ||
+| <code>{ID}</code> || <code>id</code> || <code>string</code> || <code>null</code> || No ||
 An automatically generated unique device ID.
 |-