User:JoeNMLC/sandbox/Help Popular pages

See Second iteration section below for the condensed version.

Sandbox test

The following message boxes clarify instructions for the "Popular pages" bot configuration Talk page. The first at the top is for "malfunctions or problems" (most important). The second is an example of "Protected edit request". The last box contains "Special instructions" for "Name" field. It is cloned (somewhat) from the json Config instructions and contains an example for sub-project configuration.

Notes: Each of these boxes is constructed seperately for easier reading. If these are too much & clutter the Talk page, maybe place onto a subpage? Move boxes 2 and 3 to subpage, leaving box 1 in place; add a plain wikilink at bottom of box 1 pointing to box 2 and 3 contents.

Popular pages bot configuration - Talk

If you encounter any malfunctions or problems with the bot, please first review the troubleshooting tips. If you are unable to fix the issue, you can report it on the talk page on Meta-Wiki.

To request changes to the configuration, please make a protected edit request.

Here is an example of the correct "json" file syntax for a request.

"Wikipedia:WikiProject Australian music": {
    "Report": "Wikipedia:WikiProject Australian music/Popular pages",
    "Limit": 1000,
    "Name": "Australia/WikiProject Australian music"
},

For all WikiProject edit requests, whether new or changes, it is best to use this format. Start the request with <syntaxhighlight> on the first line, and close with </syntaxhighlight> on the last line.

Special instructions for "Name" field.

The Name field must match the PROJECT parameter used in your project's banner template. A full list of valid project names can be found atMediaWiki project list.

You can also refer to Special:PageAssessments If you don't see your project, it's probably because the WikiProject template isn't using the {{WPBannerMeta}} template as it should be.

Or, the WikiProject might actually be setup as a "sub-project". For example,
Wikipedia:WikiProject Mauritius
Report "Wikipedia:WikiProject Mauritius/Popular pages"
Limit "500"
Name "Africa/WikiProject Mauritius"
(Note that WP Africa is the Parent wikiproject, and Mauritius is the sub-project).

Iteration

If you encounter any malfunctions or problems with the bot, please first review the troubleshooting tips. If you are unable to fix the issue, you can report it on the talk page on Meta-Wiki.

To request changes to the configuration, please make a protected edit request using the following example format. Start the entry with <syntaxhighlight> on the first line, and close with </syntaxhighlight> on the last line.

"Wikipedia:WikiProject Australian music": {
    "Report": "Wikipedia:WikiProject Australian music/Popular pages",
    "Limit": 1000,
    "Name": "Australia/WikiProject Australian music"
},

The "Name" field must match the PROJECT parameter used in your project's banner template. Click here for a list of valid names. You can also check the name by putting it in the "Project" field at Special:PageAssessments.

If you don't see your project, the WikiProject template might be using the {{WPBannerMeta}} template incorrectly. Or, the WikiProject might actually be set up as a sub-project. In the above example, WikiProject Australia is the parent project, and WikiProject Australian music is the sub-project.

Before making a configuration request, please ensure the WikiProject is active and that the popular pages reports will be read. Note for WikiProjects with less than 20,000 members, you can use the Massviews tool to get the same information in real-time. To use Massviews, enter the URL of the relevant category for the WikiProject, with the "Use subject page instead of talk page" option set. For example, this link should show the most-viewed pages for the previous month for WikiProject Algae.

Second iteration

If you encounter any malfunctions or problems with the bot, please first review the troubleshooting tips. If you are unable to fix the issue, you can report it on the talk page on Meta-Wiki.

First: before making a configuration request, please ensure the WikiProject is active and that the popular pages reports will be read. Note for WikiProjects with less than 20,000 members, you can use the Massviews tool to get the same information in real-time. To use Massviews, enter the URL of the relevant category for the WikiProject, with the "Use subject page instead of talk page" option set. For example, this link should show the most-viewed pages for the previous month for WikiProject Algae.

To request changes to the configuration, please make a protected edit request using the following example format. Start the entry with <syntaxhighlight> on the first line, and close with </syntaxhighlight> on the last line.

"Wikipedia:WikiProject Australian music": {
    "Report": "Wikipedia:WikiProject Australian music/Popular pages",
    "Limit": 1000,
    "Name": "Australia/WikiProject Australian music"
},

The "Name" field must match the PROJECT parameter used in your project's banner template. Click here for a list of valid names. You can also check the name by putting it in the "Project" field at Special:PageAssessments.

If you don't see your project, the WikiProject template might be using the {{WPBannerMeta}} template incorrectly. Or, the WikiProject might actually be set up as a sub-project. In the above example, WikiProject Australia is the parent project, and WikiProject Australian music is the sub-project.

Update

Done - posted to Popular pages config, Talk page. JoeNMLC (talk) 21:27, 14 June 2023 (UTC)