prosody-modules
fe081789f7b5
mod_adhoc_dataforms_demo/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_adhoc_dataforms_demo/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 3559:mod_adhoc_dataforms_demo/README.markdown@d56cb74a0db8
comparison
equal deleted inserted replaced
6002:5a65a632d5b9 6003:fe081789f7b5
1 ---
2 summary: 'Module for testing ad-hoc commands and dataforms rendering'
3 ---
4
5 # Introduction
6
7 This module provides [Ad-Hoc commands][xep0050] for testing [data
8 form][xep0004] that includes all kinds of fields. It's meant to help
9 debug both Prosodys
10 [`util.dataforms`][doc:developers:util:dataforms] library and
11 clients, eg seeing how various field types are rendered.
12
13 # Configuration
14
15 Simply add it to [`modules_enabled`][doc:modules_enabled] like any
16 other module.
17
18 ``` {.lua}
19 modules_enabled = {
20 -- All your other modules etc
21 "adhoc_dataforms_demo";
22 }
23 ```
24
25 # Usage
26
27 In your Ad-Hoc capable client, first look for "Execute command". You
28 should see a form with various kinds of fields.
29
30 Dataforms Demo
31 : A simple command that provides a dataform with every possible field
32 type, suitable for testing rending of dataforms.
33
34 Multi-step command demo
35 : A command that has multiple steps, suitable for testing back and
36 forwards navigation.