view mod_swedishchef/README.markdown @ 5907: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
parents 4d73a1a6ba68
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: 'Silly little module to convert your conversations to "swedish"'
...

Introduction
============

This module does some conversions on message bodys passed through it
causing them to look like our beloved swedish chef had typed them.

Details
=======

To load this on a MUC component do

    Component "funconference.example.com" "muc"
        modules_enabled = { "swedishchef" }
        swedishchef_trigger = "!chef"; -- optional, converts only when the message starts with "!chef"

In theory this also works for whole servers, but that is untested and
not recommended ;)

Compatibility
=============

  ----- -------
  0.6   Works
  0.5   Works
  ----- -------

Todo
====

-   Possibly add xhtml-im (XEP-0071) support