Skip to content

Commit 6c80f53

Browse files
committed
make clean extract
1 parent 028a911 commit 6c80f53

File tree

3 files changed

+49
-6
lines changed

3 files changed

+49
-6
lines changed

content/CONTAINER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@ Let's summarize the differences between both container images. Legend:
926926
| Generated by | [container.yml](https://github.com/processone/ejabberd/blob/master/.github/workflows/container.yml) | [tests.yml](https://github.com/processone/docker-ejabberd/blob/master/.github/workflows/tests.yml) |
927927
| Built for | stable releases <br /> `master` branch | stable releases <br /> [`master` branch zip](https://github.com/processone/docker-ejabberd/actions/workflows/tests.yml) |
928928
| Architectures | `linux/amd64` <br /> `linux/arm64` | `linux/amd64` |
929-
| Software | Erlang/OTP 27.3.2-alpine <br /> Elixir 1.18.3 | Alpine 3.19 <br /> Erlang/OTP 26.2 <br /> Elixir 1.15.7 |
929+
| Software | Erlang/OTP 27.3.3-alpine <br /> Elixir 1.18.3 | Alpine 3.19 <br /> Erlang/OTP 26.2 <br /> Elixir 1.15.7 |
930930
| Published in | [ghcr.io/processone/ejabberd](https://github.com/processone/ejabberd/pkgs/container/ejabberd) | [docker.io/ejabberd/ecs](https://hub.docker.com/r/ejabberd/ecs/) <br /> [ghcr.io/processone/ecs](https://github.com/processone/docker-ejabberd/pkgs/container/ecs) |
931931
| :black_square_button: **Additional content** |
932932
| [ejabberd-contrib](https://docs.ejabberd.im/admin/guide/modules/#ejabberd-contrib) | included | not included |

content/README-DOCS.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ _`bookmarks_to_pep`_ API
103103
_`default_db`_
104104
_`basic.md#captcha|CAPTCHA`_
105105
https://xmpp.org/extensions/xep-0045.html[XEP-0045]
106+
(def:c2s)
106107
```
107108

108109
gets converted into this markdown:
@@ -113,6 +114,45 @@ gets converted into this markdown:
113114
[default_db](toplevel.md#default_db)
114115
[CAPTCHA](basic.md#captcha)
115116
[XEP-0045](https://xmpp.org/extensions/xep-0045.html)
117+
[](def:c2s)
116118
```
117119

118120
There are example usage of those shorthands in ejabberd, for example in `mod_muc.erl`.
121+
122+
## Glossary
123+
124+
### Directly in markdown file
125+
126+
To define a new term, write in markdown:
127+
128+
``` markdown
129+
def:c2s
130+
: Client to Server connection in XMPP.
131+
```
132+
133+
To link to that term, write in markdown:
134+
135+
``` markdown
136+
Most connections in XMPP are [](def:c2s).
137+
```
138+
139+
Glossary terms can be defined as singular nouns (`connection`, `port`), and later you can link to that term in plural noun (`connections`, `ports`).
140+
141+
### In ejabberd source code
142+
143+
Term definition is done as expected; example usage:
144+
``` erlang
145+
mod_doc() ->
146+
#{desc =>
147+
[?T("def:ad-hoc command"), "",
148+
?T(": Command that can be executed by an XMPP client using XEP-0050."), "",
149+
?T("This module implements XEP-0050.")]
150+
```
151+
152+
In order to link to a term definition, please write simply `(def:c2s)` because `[]` becomes escaped and wouldn't work. Later `make extract` will add the `[]` automatically. Example usage:
153+
```erl
154+
mod_doc() ->
155+
#{desc =>
156+
?T("This module implements some (def:ad-hoc commands) for adminitration.")
157+
```
158+

content/admin/configuration/modules.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ search:
1414
mod\_adhoc
1515
----------
1616

17+
def:ad-hoc command
18+
19+
: Command that can be executed by an XMPP client using XEP-0050.
20+
1721
This module implements [XEP-0050: Ad-Hoc
1822
Commands](https://xmpp.org/extensions/xep-0050.html). It’s an auxiliary
1923
module and is only needed by some of the other modules.
@@ -30,8 +34,7 @@ mod\_adhoc\_api 🟤
3034
<!-- md:version added in [25.03](../../archive/25.03/index.md) -->
3135

3236

33-
Execute [API Commands](https://docs.ejabberd.im/developer/ejabberd-api/)
34-
in a XMPP client using [XEP-0050: Ad-Hoc
37+
Execute [](def:API commands) in a XMPP client using [XEP-0050: Ad-Hoc
3538
Commands](https://xmpp.org/extensions/xep-0050.html). This module
3639
requires [mod_adhoc](#mod_adhoc) (to execute the commands), and recommends
3740
[mod_disco](#mod_disco) (to discover the commands).
@@ -40,9 +43,9 @@ __Available options:__
4043

4144
- **default\_version**: `integer() | string()`
4245
What API version to use. If setting an ejabberd version, it will use the
43-
latest API version that was available in that ejabberd version. For
44-
example, setting `"24.06"` in this option implies `2`. The default value
45-
is the latest version.
46+
latest API version that was available in that [](def:c2s) ejabberd
47+
version. For example, setting `"24.06"` in this option implies `2`. The
48+
default value is the latest version.
4649

4750
__**Example**:__
4851

0 commit comments

Comments
 (0)