view mod_adhoc_dataforms_demo/README.markdown @ 3559:d56cb74a0db8

mod_adhoc_dataforms_demo/README: Describe the new multi-step command
author Kim Alvefur <>
date Sat, 06 Apr 2019 18:53:19 +0200
parents 453ec2938153
line wrap: on
line source

summary: 'Module for testing ad-hoc commands and dataforms rendering'

# Introduction

This module provides [Ad-Hoc commands][xep0050] for testing [data
form][xep0004] that includes all kinds of fields. It's meant to help
debug both Prosodys
[`util.dataforms`][doc:developers:util:dataforms] library and
clients, eg seeing how various field types are rendered.

# Configuration

Simply add it to [`modules_enabled`][doc:modules_enabled] like any
other module.

``` {.lua}
modules_enabled = {
    -- All your other modules etc

# Usage

In your Ad-Hoc capable client, first look for "Execute command". You
should see a form with various kinds of fields.

Dataforms Demo
:   A simple command that provides a dataform with every possible field
    type, suitable for testing rending of dataforms.

Multi-step command demo
:   A command that has multiple steps, suitable for testing back and
    forwards navigation.