diff mod_adhoc_dataforms_demo/README.markdown @ 3212:69b6910f3bfc

mod_adhoc_test -> mod_adhoc_dataforms_demo
author Kim Alvefur <zash@zash.se>
date Fri, 03 Aug 2018 19:40:24 +0200
parents mod_adhoc_test/README.markdown@2969ed764fe8
children 453ec2938153
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_adhoc_dataforms_demo/README.markdown	Fri Aug 03 19:40:24 2018 +0200
@@ -0,0 +1,24 @@
+# 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.