Skip to content

Commit 3389bb1

Browse files
AP-traibleAP-traible
committed
Added /warn deactivate, added descriptions for all warning commands and better described in which channel edits of warnings are logged.
1 parent 0b0c08a commit 3389bb1

6 files changed

+100
-10
lines changed

‎Writerside/dhub.tree

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<toc-element topic="Role-Management.md"/>
1414
<toc-element topic="Warnings.md"/>
1515
</toc-element>
16+
<toc-element topic="Server-Property.md"/>
1617
<toc-element topic="Commands.md">
1718
<toc-element topic="calc-price.topic"/>
1819
<toc-element topic="leaderboard.topic"/>

‎Writerside/topics/Server-Property.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Server Property ✏️
2+
3+
`Coming soon`

‎Writerside/topics/Warnings.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,38 @@
11
# Warnings
22

3-
Warnings are an easy way to log wrongful behavior of users, together with an automated way of punishing them based on the amount of warnings received.
3+
Warnings are an easy way to log wrongful behavior of users, together with an automated way of punishing them based on
4+
the amount of warnings received.
45

56
## Displaying your warnings
7+
68
To display the active warns you currently have, you can use the command [](warns.topic).
79
> You need to have the `Moderate Members` permission to be able to see warns of other users through this command.
8-
{style="note"}
10+
> {style="note"}
911
10-
To display all warns, even if they [were deactivated](warn-deactivate.topic), you can use the command [](warn-list-all.topic).
12+
To display all warns, even if they [were deactivated](warn-deactivate.topic), you can use the
13+
command [](warn-list-all.topic).
1114

1215
## Managing warnings
13-
It's possible to manage warns using the command [](warn.topic). All warnings that are created have a unique numerical id that is used across all commands. \
14-
When a warning is [given to a server member](warn-add.topic), [punishments](Warning-Punishment.md) can be automatically applied to the user.
15-
> Currently, configuration of punishments is unavailable to server admins. If you wish to use them, please contact [the development team](mailto:[email protected])
16-
{style="warning"}
1716

18-
[Punishments](Warning-Punishment.md) aren't updated/lifted when a warning is [deactivated](warn-deactivate.topic) or updated by an [evidence being added](warn-add-evidence.topic).
17+
It's possible to manage warns using the command [](warn.topic). All warnings that are created have a unique numerical id
18+
that is used across all commands. \
19+
When a warning is [given to a server member](warn-add.topic), [punishments](Warning-Punishment.md) can be automatically
20+
applied to the user.
21+
> Currently, configuration of punishments is unavailable to server admins. If you wish to use them, please
22+
> contact [the development team](mailto:[email protected])
23+
> {style="warning"}
24+
25+
[Punishments](Warning-Punishment.md) aren't updated/lifted when a warning is [deactivated](warn-deactivate.topic) or
26+
updated by an [evidence being added](warn-add-evidence.topic).
27+
28+
When warnings are edited, either by them being created, when an evidence is added or when they are deactivated, the
29+
change is logged in the [respective channel](#log-channel).
30+
31+
## Log-Channel
32+
33+
When warnings are managed successfully, a log message containing the relevant information is sent into the log
34+
channel. \
35+
The log channel depends on the [](Warning-Type.md):
36+
If the [warning type](Warning-Type.md) is either `Serious`, `Major` or `Minor`, the message is sent into the channel of
37+
the [server property `MODERATION_LOGS_CHANNEL`](Server-Property.md), otherwise it's sent into the
38+
[`STRIKES_LOG_CHANNEL`](Server-Property.md).

‎Writerside/topics/warn-add-evidence.topic

+56-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,61 @@
33
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
44
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
55
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
6-
title="/warn add-evidence ✏️" id="warn-add-evidence">
6+
title="/warn add-evidence" id="warn-add-evidence">
77

8-
<code>Coming soon</code>
8+
<tldr>
9+
<p>
10+
<format style="italic">Adds evidence to a warning.</format>
11+
</p>
12+
</tldr>
13+
14+
<chapter title="Examples" id="examples" collapsible="true">
15+
<img alt="warn-add-evidence-1.png" src="warn-add-evidence-1.png" width="325" style="inline"
16+
border-effect="rounded"/>
17+
</chapter>
18+
19+
<chapter title="Description" id="description">
20+
<p>This command adds evidence to a warning.</p>
21+
<p>Please note that you should only supply either an attachment or a text, not both. If you supply both, only
22+
the attachment will be added as an evidence, the text will be ignored.</p>
23+
<p>You can read more about managing warnings <a href="Warnings.md" anchor="managing-warnings">here</a>.</p>
24+
</chapter>
25+
26+
<chapter title="Arguments" id="arguments" collapsible="true">
27+
<table style="header-row">
28+
<tr>
29+
<td>Name</td>
30+
<td>Type</td>
31+
<td>Description</td>
32+
<td>Optional?</td>
33+
<td>Additional</td>
34+
</tr>
35+
36+
<tr>
37+
<td><code>id</code></td>
38+
<td>Number (long)</td>
39+
<td>The id of the warning.</td>
40+
<td>:x: No</td>
41+
<td>
42+
<list>
43+
<li>Min value: 1</li>
44+
</list>
45+
</td>
46+
</tr>
47+
48+
<tr>
49+
<td><code>attachment</code></td>
50+
<td>Attachment</td>
51+
<td>Add an attachment (image or similar) as evidence.</td>
52+
<td>:white_check_mark: Yes</td>
53+
</tr>
54+
55+
<tr>
56+
<td><code>text</code></td>
57+
<td>String</td>
58+
<td>Add a text (or link) as evidence.</td>
59+
<td>:white_check_mark: Yes</td>
60+
</tr>
61+
</table>
62+
</chapter>
963
</topic>

‎Writerside/topics/warn-add.topic

+5
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
<img alt="warn-add-dm.png" src="warn-add-dm.png" width="325" style="inline" border-effect="rounded"/>
1919
</chapter>
2020

21+
<chapter title="Description" id="description">
22+
<p>This command adds a warning to the given user. It also applies all available <a href="Warning-Punishment.md">punishments</a> to the user.</p>
23+
<p>You can read more about managing warnings <a href="Warnings.md" anchor="managing-warnings">here</a>.</p>
24+
</chapter>
25+
2126
<chapter title="Arguments" id="arguments" collapsible="true">
2227
<table style="header-row">
2328
<tr>

‎Writerside/topics/warn-deactivate.topic

+7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@
1818
border-effect="rounded"/>
1919
</chapter>
2020

21+
<chapter title="Description" id="description">
22+
<p>This command deactivates a given warning.</p>
23+
<p>This will mean that the warning will no longer be shown in <a href="warns.topic"/> and will no longer have an
24+
effect when <a href="Warning-Punishment.md">punishments</a> are calculated.</p>
25+
<p>You can read more about managing warnings <a href="Warnings.md" anchor="managing-warnings">here</a>.</p>
26+
</chapter>
27+
2128
<chapter title="Arguments" id="arguments" collapsible="true">
2229
<table style="header-row">
2330
<tr>

0 commit comments

Comments
 (0)