view mod_adhoc_dataforms_demo/README.markdown @ 5708:37ba9478b387

mod_audit: Fix recording location info The method :query_by_addr only works for IPv4, even if you open the IPv6 database, which is an odd API. It also returns a table, not a string.
author Kim Alvefur <zash@zash.se>
date Mon, 13 Nov 2023 12:14:31 +0100
parents d56cb74a0db8
children
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
    "adhoc_dataforms_demo";
}
```

# 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.