view mod_adhoc_dataforms_demo/README.markdown @ 3214:453ec2938153

mod_adhoc_dataforms_demo/README: Set a summary
author Kim Alvefur <zash@zash.se>
date Fri, 03 Aug 2018 20:23:03 +0200
parents 69b6910f3bfc
children d56cb74a0db8
line wrap: on
line source

---
summary: Module for testing dataforms rendering
---

# Introduction

This module adds an [Ad-Hoc command][xep0050] with a demo [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, look for **Dataforms Demo**, and execute
it. You should see a form with various kinds of fields.