Help:Extension:CommunityRequests
It is still being drafted, or it contains incomplete translation markup which should be fixed before marking for translation.
The CommunityRequests extension is a system for managing a wiki community's requests and suggestions for technical development. It is used by the WMF for the Community Wishlist.
The lifecycle of the Community Wishlist system is generally:
- Users submit wishes using the intake form.
- Community Wishlist managers review wishes, and group them together into focus areas.
- Users vote on wishes and focus areas to help surface the most important needs.
Setting up a new wishlist
[edit ]You'll need three manually created wiki pages for your wishlist.
If you are using Translate , be sure to setup the page for translation and add the <languages />
navigation box at the top.
Wishlist home page
[edit ]Located at [[Community Wishlist]]
.
This is the homepage for the wishlist. It can be designed however you'd like, and usually will display recent wishes and focus areas, and link to the wish intake form.
Example content:
Welcome to the Community Wishlist! '''[[Special:WishlistIntake|Submit a new wish]]''' == Recent focus areas == {{#CommunityRequests:focus-area-index|limit=4}} '''[[Community Wishlist/Focus areas|All focus areas]]''' == Recent wishes == {{#CommunityRequests:wish-index|limit=5}} '''[[Community Wishlist/Wishes|All wishes]]'''
Wish index page
[edit ]This page allows users to browse through all wishes.
Example content:
{{#CommunityRequests:wish-index}} '''[[Special:WishlistIntake|Create a new wish]]'''
Focus area index page
[edit ]This page lists all focus areas.
Example content:
{{#CommunityRequests:focus-area-index}}
Wishes
[edit ]Wishes are technical proposals submitted by members of the community. They can belong to focus areas and can be voted on to gauge public interest.
Intake Form
[edit ]New wishes can be submitted using the intake form which is available at Special:WishlistIntake
.
The intake form has ways to add a title, description, status of a wish, (that is only available to wishlist managers) type, audience, tags and any existing Phab tasks. The wishlist managers also have the option to assign a status and focus area, that allows grouping.
When submitting a wish it automatically gets assigned the "Under Review".
Wish parser function
[edit ]The data for individual wishes are stored using the {{#CommunityRequests: wish}}
parser function.
It takes the following parameters:
|type=
– The type of the wish. The possible values are configured by $wgCommunityRequestsWishTypes .|status=
– The status of the wish. The possible values are configured by $wgCommunityRequestsStatuses .|title=
– The title of the wish|focusarea=
– The slug for the associated focus area such asFA123
.|description=
– The description of the wish. This field may contain wikitext or use of templates.|projects=
– A comma-separated list of the projects the wish benefits, such aswikipedia,commons
. The possible values are configured by $wgCommunityRequestsProjects .|otherproject=
– A free-form field to enter a related project if none of theprojects
apply.|audience=
– Free-form field to describe the group(s) of users the wish would benefit. May contain wikitext.|phabtasks=
– A comma-separated list of the Phabricator task IDs, such asT123,T456
.|proposer=
– The username of the user who submitted the wish.|created=
– The ISO 8601 timestamp of when the wish was created, such as2025年01月23日T12:59:59Z
.|baselang=
– The MediaWiki language code for the base language of the wish, from which translations are made.
Wish index parser function
[edit ]A table of available wishes can be displayed using the {{#CommunityRequests: wish-index}}
parser function.
It takes the following parameters:
Name | Description | Default |
---|---|---|
|lang=
|
The language to fetch wishes in. If wishes are not available in that language, the same wishes are shown in fallback languages where possible. | (the page language) |
|sort=
|
The column to sort by. This should be one of the valid sort values accepted by the list=communityrequests-wishes API.
|
created
|
|dir=
|
The direction to sort by. Should be either ascending or descending .
|
descending
|
|limit= |
The number of results to show per page. | 10 |
|showfilters=
|
Whether to show the wishes filters form. | 0 |
Focus areas
[edit ]Focus areas group together related wishes that share a common theme. Just like wishes, focus areas can be voted on. Stakeholders can treat a focus area's collection of wishes as a long-term project, and offer updates to voters through the Community Wishlist system.
Focus area pages are titled Community Wishlist/Focus areas/FA<number>
, where <number>
is the unique focus area ID. The title prefix is configurable. Editing these pages is only available to users with the manage-wishlist
right and is usually done via the editing form at Special:EditFocusArea.
Each focus area page uses a parser function to store its data, and another parser function is available for displaying an index to all focus areas.
Focus area parser function
[edit ]The data for individual focus areas are stored using the {{#CommunityRequests: focus-area}}
parser function.
It takes the following parameters:
|status=
– The status of the focus area. The possible values are configured by $wgCommunityRequestsStatuses .|title=
– The title of the focus area.|description=
– The description of the focus area. This field may contain wikitext or use of templates.|shortdescription=
– The short description for the focus area; shown on the wishlist homepage and the focus area index page.|owners=
– The organizational teams that own this focus area and are responsible for its management and progress. May contain wikitext.|volunteers=
– Volunteers who are not part of the organization but contributed to the focus area in some way. May contain wikitext.|created=
– The ISO 8601 timestamp of when the focus area was created, such as2025年01月23日T12:59:59Z
.|baselang=
– The MediaWiki language code for the base language of the focus area, from which translations are made.
Focus area index parser function
[edit ]A list of focus area cards can be displayed using the {{#CommunityRequests: focus-area-index}}
parser function.
It takes the following parameters:
Name | Description | Default |
---|---|---|
|lang=
|
The language to fetch focus areas in. If focus areas are not available in that language, the same focus areas are shown in fallback languages where possible. | (the page language) |
|sort=
|
The column to sort by. This should be one of the valid sort values accepted by the list=communityrequests-wishes API.
|
created
|
|dir=
|
The direction to sort by. Should be either ascending or descending .
|
decending
|
Voting
[edit ]Once wishes/focus areas are reviewed and have any other status than "Under Review", "Declined" and "Done" status assigned, they can be voted on. Voting is done by clicking a button and entering an optional comment. Votes are stored on a votes subpage, that people can see on their contributions, that can not be edited.
Machine translation
[edit ]To use machine translation, first ensure you have the "Enable automatic machine translation on applicable pages" preference set in your Internationalisation
preferences.
All Community Wishlist pages offer machine translation.
This will add a banner at the top of any page that has any parts written in languages other than a user's current interface language. The banner contains a toggle switch that can be used to enable the page translation.
The state of the toggle switch is maintained between page loads, as the user navigates around the wiki, so that text in other languages will be translated as soon as a new page is opened.