prosody-modules
d194d1012fd3
mod_adhoc_dataforms_demo/README.markdown
Software / code / prosody-modules
File
mod_adhoc_dataforms_demo/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 3559:d56cb74a0db8 |
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.
