From 9211ce0e7fa2dae1fc31853d9399bea243f59fa2 Mon Sep 17 00:00:00 2001 From: Ske Date: Wed, 30 Oct 2019 13:59:22 +0100 Subject: [PATCH] Add documentation for keepproxy feature --- docs/1-user-guide.md | 13 ++++++++++++- docs/2-command-list.md | 1 + docs/3-api-documentation.md | 1 + 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/1-user-guide.md b/docs/1-user-guide.md index ecc7c9ce..47950f30 100644 --- a/docs/1-user-guide.md +++ b/docs/1-user-guide.md @@ -266,7 +266,18 @@ To add a proxy tag to a member, use the `pk;member proxy add` command: To remove a proxy tag from a member, use the `pk;member proxy remove` command: pk;member John proxy remove {text} pk;member Craig proxy remove C:text - + +### Keeping your proxy tags +If you'd like your proxied messages to include the proxy tags, you can enable the "keep proxy tags" option for a given member, like so: + + pk;member John keepproxy on + +Turning the option off is similar - replace "on" with "off" in the command. The default value for every member is off. When proxying +a member with multiple proxy tags, the proxy tag used to trigger a given proxy will be included. + +The practical effect of this is: +* **Keep proxy tags on:** `[Message goes here]` -> [Message goes here] +* **Keep proxy tags off:** `[Message goes here]` -> Message goes here ### Querying message information If you want information about a proxied message (eg. for moderation reasons), you can query the message for its sender account, system, member, etc. diff --git a/docs/2-command-list.md b/docs/2-command-list.md index 6d431b22..a7f46175 100644 --- a/docs/2-command-list.md +++ b/docs/2-command-list.md @@ -35,6 +35,7 @@ Words in \ are *required parameters*. Words in [square brackets] - `pk;member proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs. - `pk;member proxy add [tags]` - Adds a proxy tag pair to a member. - `pk;member proxy remove [tags]` - Removes a proxy tag from a member. +- `pk;member keepproxy [on|off]` - Sets whether to include a member's proxy tags in the proxied message. - `pk;member pronouns [pronouns]` - Changes the pronouns of a member. - `pk;member color [color]` - Changes the color of a member. - `pk;member birthdate [birthdate]` - Changes the birthday of a member. diff --git a/docs/3-api-documentation.md b/docs/3-api-documentation.md index b7c606ad..a25a0342 100644 --- a/docs/3-api-documentation.md +++ b/docs/3-api-documentation.md @@ -47,6 +47,7 @@ The following three models (usually represented in JSON format) represent the va |prefix|string?|Yes|Deprecated. Use `proxy_tags` instead.| |suffix|string?|Yes|Deprecated. Use `proxy_tags` instead.| |proxy_tags|ProxyTag[]|Yes (entire array)|An array of ProxyTag (see below) objects, each representing a single prefix/suffix pair.| +|keep_proxy|bool|Yes|Whether to display a member's proxy tags in the proxied message.| |created|datetime|No|| #### ProxyTag object