Template:APIQuery categorymembers/doc

Usage

Intended use

• Place this on a category page to generate a link call the Wikipedia API to generate a list of pages in the category, limited to 500 results.

Other uses

• Use this any page to see the number of items in a category of the same name. This is potentially useful on article talk pages which have a category with an identical name.

• Use this with the |CATPAGE= parameter to generate a link for a specific category.

• Use this at Special:ExpandTemplates. Put the category page in the Context title, for Template:APIQuery categorymembers/doc, etc.: line and {{APIQuery categorymembers}} with the appropriate parameters in the Input wikitext: line.

• Use this multiple times with different parameters, to generate a list or table of links.

Parameters

Note: Most of these are named after the parameters in the URL. Not all URL parameters are supported.

• |CATPAGE= - overrides the {{PAGENAME}} magic word.

  Bug: CATPAGE cannot have space. Use underscores ("_").

• |cmprop= - default is |cmprop=title. To add timestamps, use |cmprop=title{{!}}timestamp.
• |cmnamespace= - default is blank. To filter the results by namespace provide the number of the namespace, e.g. 0 (article), 1 (talk), etc. A full list is at Wikipedia:Namespace.
• |format= - Default is xml. Other formats supported by the query API are supported.
• |cmsort= - Default is no sorting. use |cmsort=timestamp to sort by time. See cmprop above.
• |cmdir= - Sorting direction, default is whatever the underlying API default is. |cmsort=desc or |cmsort=asc.

Example usage

• {{APIQuery categorymembers|cmnamespace=1}}

  generates a URL that will list of articles in a category

• {{APIQuery categorymembers|cmnamespace=4|cmsort=timestamp|cmdir=desc|cmprop=title{{!}}timestamp}}

  generates a URL that will list the user talk pages in a category, sorted by date, descending, with dates

• {{APIQuery categorymembers|format=json}}

  generates a URL that will generate JSON-formatted output

• {{APIQuery categorymembers|cmnamespace=0|CATPAGE=Pages where template include size is exceeded}}

  generates an unsorted list of article pages in Category:Pages where template include size is exceeded:

  //en.wikipedia.org/enwiki/w/api.php?action=query&list=categorymembers&cmtitle=Category:Pages_where_template_include_size_is_exceeded&cmprop=title&cmlimit=500&cmnamespace=0&format=xml

Technical details

This template generates a "plain link" URL whose text is the namespace if the |csnamespace= parameter is used.

//en.wikipedia.org/enwiki/w/api.php?action=query&list=categorymembers&cmtitle=Category%3A{{{CATPAGE|{{PAGENAMEE}}}}}&cmprop={{{cmprop|title}}}&cmlimit=500&cmnamespace={{{cmnamespace|}}}&format={{{format|xml}}}{{#if: {{{cmsort|}}}|&cmsort={{{cmsort}}}}}{{#if: {{{cmdir|}}}|&cmdir={{{cmdir}}}

See also

• Special:TrackingCategories - a list of Wikipedia maintenance categories. This template may be useful in some of these categories.
• mw:API:Categorymembers API details (on MediaWiki)