mod_adhoc_dataforms_demo/README.markdown
author Matthew Wild <mwild1@gmail.com>
Sat, 24 Sep 2022 09:26:26 +0100
changeset 5063 5f1120c284c5
parent 3563 d56cb74a0db8
permissions -rw-r--r--
mod_cloud_notify_extensions: Add note about dependency Noting here because people might not click through to see it on the mod_cloud_notify_encrypted page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3218
453ec2938153 mod_adhoc_dataforms_demo/README: Set a summary
Kim Alvefur <zash@zash.se>
parents: 3216
diff changeset
     1
---
3563
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
     2
summary: 'Module for testing ad-hoc commands and dataforms rendering'
3218
453ec2938153 mod_adhoc_dataforms_demo/README: Set a summary
Kim Alvefur <zash@zash.se>
parents: 3216
diff changeset
     3
---
453ec2938153 mod_adhoc_dataforms_demo/README: Set a summary
Kim Alvefur <zash@zash.se>
parents: 3216
diff changeset
     4
3215
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
# Introduction
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
3563
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
     7
This module provides [Ad-Hoc commands][xep0050] for testing [data
3215
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
form][xep0004] that includes all kinds of fields. It's meant to help
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
debug both Prosodys
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
[`util.dataforms`][doc:developers:util:dataforms] library and
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
clients, eg seeing how various field types are rendered.
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
# Configuration
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
Simply add it to [`modules_enabled`][doc:modules_enabled] like any
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
other module.
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
``` {.lua}
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
modules_enabled = {
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
    -- All your other modules etc
3216
69b6910f3bfc mod_adhoc_test -> mod_adhoc_dataforms_demo
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
    21
    "adhoc_dataforms_demo";
3215
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
}
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
```
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
# Usage
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
3563
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    27
In your Ad-Hoc capable client, first look for "Execute command". You
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    28
should see a form with various kinds of fields.
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    29
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    30
Dataforms Demo
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    31
:   A simple command that provides a dataform with every possible field
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    32
    type, suitable for testing rending of dataforms.
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    33
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    34
Multi-step command demo
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    35
:   A command that has multiple steps, suitable for testing back and
d56cb74a0db8 mod_adhoc_dataforms_demo/README: Describe the new multi-step command
Kim Alvefur <zash@zash.se>
parents: 3218
diff changeset
    36
    forwards navigation.