comparison mod_adhoc_dataforms_demo/README.markdown @ 3559:d56cb74a0db8

mod_adhoc_dataforms_demo/README: Describe the new multi-step command
author Kim Alvefur <zash@zash.se>
date Sat, 06 Apr 2019 18:53:19 +0200
parents 453ec2938153
children
comparison
equal deleted inserted replaced
3558:22587eb2d87c 3559:d56cb74a0db8
1 --- 1 ---
2 summary: Module for testing dataforms rendering 2 summary: 'Module for testing ad-hoc commands and dataforms rendering'
3 --- 3 ---
4 4
5 # Introduction 5 # Introduction
6 6
7 This module adds an [Ad-Hoc command][xep0050] with a demo [data 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 8 form][xep0004] that includes all kinds of fields. It's meant to help
9 debug both Prosodys 9 debug both Prosodys
10 [`util.dataforms`][doc:developers:util:dataforms] library and 10 [`util.dataforms`][doc:developers:util:dataforms] library and
11 clients, eg seeing how various field types are rendered. 11 clients, eg seeing how various field types are rendered.
12 12
22 } 22 }
23 ``` 23 ```
24 24
25 # Usage 25 # Usage
26 26
27 In your Ad-Hoc capable client, look for **Dataforms Demo**, and execute 27 In your Ad-Hoc capable client, first look for "Execute command". You
28 it. You should see a form with various kinds of fields. 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.