From 5a6e5bb3c7cca1a9a6dae215de5f2bfc844bf6bb Mon Sep 17 00:00:00 2001 From: Ben <@webmaster:fiftyfiftyonearizona.org> Date: Thu, 19 Jun 2025 15:27:22 -0700 Subject: [PATCH] Terminology changes --- readme.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index 84e34b3..b731f12 100644 --- a/readme.md +++ b/readme.md @@ -17,16 +17,16 @@ Every event is a text message (`m.text`). This is done so that real people can c Every message has a format similar to that of a typical UNIX-style command-line program: ``` -!report human readable message +!report human readable message ``` The bang (exclamation mark) at the beginning of the message is there so the system works with Maubot. The human readable message can be anything. Such as "ICE Spotted at 500 E Fake St." -The state/territory field is a single token (no spaces in it) which designates the state or territory that the report is for. This is a required field. This requirement and its granularity have undergone quite a bit of scrutiny. Its purpose is to allow for consumers of this information to filter by their general location without being too granular. The specific choice of state came down to most 50501 groups being organized around each state. +The region field is a single token (no spaces in it) which designates the state or territory that the report is for. This is a required field. This requirement and its granularity have undergone quite a bit of scrutiny. Its purpose is to allow for consumers of this information to filter by their general location without being too granular. The specific choice of state came down to most 50501 groups being organized around each state. -This is **not case sensitive**, but again it must be a single word/token. Just concatenate the words for state or territory names with multiple words. Like NorthDakota or puertoRico. +This is **not case sensitive**, but again it must be a single word/token. Just concatenate the words for state or territory names with multiple words. Like NorthDakota or puertoRico or NATIONAL. A more complete example might be: @@ -36,16 +36,16 @@ A more complete example might be: ## Input-Output & Authentication -This system is intended to be used in a Matrix room where different Matrix accounts are adding and consuming information. For simplicity, I will stick to the adders and consumers terminoligy. The adders can be bots or people, whereas the consumers are intended to be bots only. +This system is intended to be used in a Matrix room where different Matrix accounts are adding and consuming information. For simplicity, I will stick to the adders and consumers terminology. The adders can be bots or people, whereas the consumers are intended to be bots only. -Additionally, consumer bots would probably want to only pay attention to certain state/territory designations. Additionally, consumer bots may only want to pay attention to certain users. All Maubot plugins that FiftyFiftyOne +Additionally, consumer bots would probably want to only pay attention to certain region designations. Additionally, consumer bots may only want to pay attention to certain users. All Maubot plugins that FiftyFiftyOne As an example, a person could be the only adder, with two consumers—say a bot that forwards it to NTFY, and another one which forwards it to Signal. When the person enters in `!report arizona Some Report` the two consumer bots should process it as follows: -1. Split the message into the state/territory designator `arizona`, and the string after it. -2. If the bot is set to only pay attention to specific state/territory designators, check that `arizona` is in that set. Silently ignore the message if it isn't. -3. If the bot is set to only pay attention to specific users for the state/territory designator `arizona`, check if the sending user is in that set. Silently ignore the message if it isn't. +1. Split the message into the region designator `arizona`, and the string after it. +2. If the bot is set to only pay attention to specific region designators, check that `arizona` is in that set. Silently ignore the message if it isn't. +3. If the bot is set to only pay attention to specific users for the region designator `arizona`, check if the sending user is in that set. Silently ignore the message if it isn't. 4. Run through its own code to process the message as it sees fit. 5. Optionally reply to the message saying that it was processed. \ No newline at end of file