mod_adhoc_dataforms_demo/README.markdown
author Kim Alvefur <zash@zash.se>
Tue, 19 Feb 2019 03:15:05 +0100
changeset 3472 228e59bee8ad
parent 3218 453ec2938153
child 3563 d56cb74a0db8
permissions -rw-r--r--
mod_storage_muc_log: Return 'with' property for items (API conformance)
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
---
453ec2938153 mod_adhoc_dataforms_demo/README: Set a summary
Kim Alvefur <zash@zash.se>
parents: 3216
diff changeset
     2
summary: Module for testing dataforms rendering
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
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
This module adds an [Ad-Hoc command][xep0050] with a demo [data
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
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    27
In your Ad-Hoc capable client, look for **Dataforms Demo**, and execute
2969ed764fe8 mod_adhoc_test: A module to test dataforms generation and rendering
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    28
it. You should see a form with various kinds of fields.