Add documentation for keepproxy feature
This commit is contained in:
		| @@ -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. | ||||
|   | ||||
| @@ -35,6 +35,7 @@ Words in \<angle brackets> are *required parameters*. Words in [square brackets] | ||||
| - `pk;member <name> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs. | ||||
| - `pk;member <name> proxy add [tags]` - Adds a proxy tag pair to a member. | ||||
| - `pk;member <name> proxy remove [tags]` - Removes a proxy tag from a member. | ||||
| - `pk;member <name> keepproxy [on|off]` - Sets whether to include a member's proxy tags in the proxied message. | ||||
| - `pk;member <name> pronouns [pronouns]` - Changes the pronouns of a member. | ||||
| - `pk;member <name> color [color]` - Changes the color of a member. | ||||
| - `pk;member <name> birthdate [birthdate]` - Changes the birthday of a member. | ||||
|   | ||||
| @@ -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 | ||||
|   | ||||
		Reference in New Issue
	
	Block a user