Skip to content

Commit

Permalink
Document tags for the opertype message.
Browse files Browse the repository at this point in the history
  • Loading branch information
SadieCat committed Jun 23, 2024
1 parent 4dd8194 commit e699c8f
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
15 changes: 15 additions & 0 deletions docs/server/messages/opertype.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
name: OPERTYPE
source: uid
tags:
~automatic: |-
[**1206+**] If present then the source user was automatically logged into their server operator account.
~name: |-
[**1206+**] The name of the operator account the source user logged into.
~chanmodes: |-
[**1206+**] The server operator-only channel modes that the source user has access to (including modes that may not currently exist).
~usermodes: |-
[**1206+**] The server operator-only user modes that the source user has access to (including modes that may not currently exist).
~commands: |-
[**1206+**] A token list of the server operator-only commands that the source user has access to.
~privileges: |-
[**1206+**] A token list of the server operator-only privileges that the source user has.
~snomasks: |-
[**1206+**] The server notice masks that the source user has access to (including snomasks that may not currently exist).
syntax:
fields:
type: The new server operator type of the source user.
Expand Down
28 changes: 26 additions & 2 deletions mkdocs_inspircd/templates/servermsg.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,15 @@ Fully connected | {% if "connected" in phase %}✔️{% else %}❌{% end

### Syntax

{% set prefix = "" %}
{% if tags is defined %}
{% set prefix = "[@<tags>] " %}
{% endif %}

{% if source is defined %}
{% set prefix = ":<" ~ source ~ ">" %}
{% set prefix = prefix ~ ":<" ~ source ~ ">" %}
{% else %}
{% set prefix = "[:<sid>]" %}
{% set prefix = prefix ~ "[:<sid>]" %}
{% endif %}

{% if syntax is not defined %}
Expand Down Expand Up @@ -72,6 +77,25 @@ Fully connected | {% if "connected" in phase %}✔️{% else %}❌{% end
{% endfor %}
</tbody>
</table>
{% endif %}

{% if tags is defined %}
<table markdown="1">
<thead>
<tr>
<th>Tag</th>
<th>Description</th>
</tr>
</thead>
<tbody markdown="1">
{% for tag_name, tag_data in tags.items() -%}
<tr markdown="1">
<td markdown="1">`{{ tag_name }}`</td>
<td markdown="1">{{ tag_data }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}

{% if extra is defined %}
Expand Down

0 comments on commit e699c8f

Please sign in to comment.