Jump to content

Global reminder bot/Proposal

From Meta, a Wikimedia project coordination wiki

This page details how the messages delivered can be translated. There are two way this can be done:

Creating a custom configuration file

[edit]

Examples of what I'm looking for can be seen in Global reminder bot/enwiki and Global reminder bot/frwiki:

  • any specific rights you do not want the bot to run on. Currently the bot does not work on bot, confirmed and flooder rights. This may require some community discussion. If you don't want to run the bot at all, please let me know.
  • the specific messages you want the bot to deliver to the users (there's a general default for all rights and you can create additional fields if you want a custom message for a certain right, such as IP-block exempt).
  • The $1 (database name of user right), $2 (wiki name of user right) and $3 (user expiry date) fields must transfer over to the new message (the bot will fill them automatically). $2 in particular will almost always be in the target wiki's language - the bot handles this automatically.
  • If desired, the date and time of expiry can be in a custom format (for example, if the wiki wants it to be spelled out in their language). This can be done using the parameters date_format (note that this uses Babel formatting, not strptime) and date_locale (again watch out for the format - see this page). Ask me if you're unsure. If these parameters are missing, it will default to what's specified under Global_reminder_bot/global.
  • Also,
    • if you are a Meta admin, steward or otherwise privileged global user (your rights on the local wiki don't count), use metawiki:Special:ChangeContentModel to change the content model of the configuration file page to JSON.
    • otherwise, you will be unable to add the signature part of the message, as MediaWiki will automatically parse and sign the page as yourself instead. This is OK; just do what you can and let me know - I'll do the rest. The alternate option is to let me know before starting, so that I can create the page in the right format before you start translating.

Also supported are cases where you want to have a custom date format but are OK with the generic message - in other words there is no requirement that any particular parameter exists in the custom file. What is not supported at this time however are custom timezones - the system only returns UTC at this time and you should not print a different timezone as a result.

You may see that the default message on Global reminder bot/global has a <div> segment. This does not need to be copied over, and is present to improve compatibility with RTL (right-to-left) wikis such as Arabic and Hebrew.

Translating the default message

[edit]

The other option if the community prefers it is to translate the generic message (i.e, the message delivered when a local version does not exist) on Global reminder bot/global using Global reminder bot/Messages/default. In that case, the message will be in English with a link to view the message translated into various languages. This is most useful for smaller wikis, and is a useful step even if you choose option 1, because this will help smaller wikis that do not have the manpower to translate it themselves. Note that $2 (the human-readable name of the user right) will normally be in the language of the wiki - this is automatic.

Unless the community requires it, a bot flag itself is not needed on this wiki. Note that it is very much likely that the bot will almost never send messages to the users; however, this is a pre-requisite before the bot can run at all on this wiki. Please ping me in a reply, and you are welcome to respond in any language. Thanks in advance.