User:JL-Bot/Project content/documentation

This template is used to have generate a listing of Recognized Content, like featured articles, good articles, articles featured in the Did you know? or In the News section of the main page, and so on. For some examples, see WikiProject Physics/Recognized content or WikiProject Women in Red/Recognized content.

You can also use it to generate lists of Did You Know? blurbs (e.g. WikiProject Physics/Did you know or WikiProject Women in Red/DYK).

For details on what Recognized Content is exactly and how to make the most out of it, see this Signpost article.

Usage
Place the template where you want the content displayed:

To hide the message box at the top, simply use
 * no

The template contains no content so it does not impact the visual appearance of the page which transcludes it.

Only use this in the following namespaces:

While it will technically work in the following namespaces it should normally not be used there (at least on the root of talk pages of Portals and WikiProject).

Project parameter
The project parameter defines how the bot is to identify project content. One of the two following parameters needs to be provided:



The  parameter needs to have the name of the talk page template that is used by the project to identify articles within its scope. For example, WikiProject Physics uses the WikiProject Physics template so the parameter for them would be. If there are redirects to the template (ex. WP Physics → WikiProject Physics), pages tagged with the redirect will still be picked up as they show up in the target's transclusions. However, do not use a redirect as the template name as only pages tagged with the redirect will be picked up.

The  parameter needs to have the name of the category that is used by the project to identify articles within its scope.

If the project's template can be "merged" into another project's template (example), then the  parameter is probably a better option as not all the project's articles will be tagged with the template.

Multiple  and   parameters can be specified and the bot will pick up articles in all the templates and categories specified. This can be useful in cases such as portals with multiple applicable projects.
 * Note: To avoid having the page listed on Category:Pages using duplicate arguments in template calls, the multiple parameters can be numbered. Example:
 * The numbers have no effect on the output and do not need to be sequential.
 * The numbers have no effect on the output and do not need to be sequential.
 * The numbers have no effect on the output and do not need to be sequential.

Content parameters
The content parameters define the content types to be listed. The following types are supported:


 * -- lists Category:Wikipedia featured articles content
 * -- lists Category:Wikipedia former featured articles content
 * -- lists Category:Wikipedia featured lists content
 * -- lists Category:Wikipedia former featured lists content
 * -- lists Category:Wikipedia good articles content
 * -- lists Category:Delisted good articles content
 * -- lists Category:Wikipedia Did you know articles content
 * -- lists Category:Featured pictures content
 * -- lists Category:Wikipedia former featured pictures content
 * -- lists Category:Wikipedia featured portals content
 * -- lists Category:Wikipedia former featured portals content
 * -- lists Category:Wikipedia featured article candidates content
 * -- lists Category:Wikipedia featured list candidates content
 * -- lists Category:Good article nominees content
 * -- lists specified category's content
 * -- lists specified category's content
 * -- lists specified category's content
 * -- lists Category:Wikipedia In the news articles content
 * -- lists Category:Featured articles that have appeared on the main page content
 * -- lists Category:Featured lists that have appeared on the main page content
 * -- lists Template:Picture of the day content
 * -- lists Category:Featured topics & Category:Wikipedia fully featured topics content
 * -- lists Category:Wikipedia former featured topics content
 * -- lists Category:Wikipedia Good topics content
 * -- lists Category:Wikipedia level-1 vital articles content
 * -- lists Category:Wikipedia level-2 vital articles content
 * -- lists Category:Wikipedia level-3 vital articles content
 * -- lists Category:Wikipedia level-4 vital articles content
 * -- lists Category:Wikipedia level-5 vital articles content

The content will be listed in the order the parameters appear in the template.

Multiple  parameters can be specified and the bot will list the articles from all the specified categories.
 * Note: To avoid having the page listed on Category:Pages using duplicate arguments in template calls, the multiple parameters can be numbered. Example:
 * The numbers have no effect on the output and do not need to be sequential.
 * The numbers have no effect on the output and do not need to be sequential.
 * The numbers have no effect on the output and do not need to be sequential.

Optional parameters
The following optional parameters are supported:


 * : specifies compact layout instead of column layout (ex: article1 · article2). The  option overrides the   and   options.
 * number : specifies the maximum articles to list in  mode. The   option only applies when the   option is set.
 * : specifies using a reduced text size in  mode. The   option only applies when the   option is set.
 * #em : specifies column size in default column layout
 * : specifies the use of content type icons before page names
 * : specifies the use of content type icons before the headings
 * number : defines the heading level (number of "="s) to use; the default is level 2. The  option allows for 0 and 2-6. A value of 2-6 defines the heading level (i.e. the number of "="s to use). A value of 0 means to not use a formal heading level, but instead use the ";Title" syntax.
 * : specifies that headings are not to be displayed. The  option overrides the   option.
 * : specifies pictures should be listed (obeying the columns, icons, and compact options). Pictures will use the  syntax if the   option is not set.
 * number : specifies the minimum height (in px) to be used for a picture gallery (see  option at Help:Gallery tag)
 * : specifies including in the output the date the content was on the Main Page (where applicable)
 * : specifies captions should not be added in picture gallery mode. Captions are added by default.
 * value : specifies the sorting to use. The  option may be set to   (sort by DEFAULTSORT key),   (sort alphabetically),   (sort Main Page content by date, remainder by DEFAULTSORT key), and   (sort Main Page content by date, remainder alphabetically). The default is   if not specified.
 * value : specifies the sorting order for dates. The  option may be set to   or  . This option only applies when the   option is set to   or  . The default is   if not specified.
 * : specifies that a count of the number of pages in the content type is displayed
 * page name
 * page name
 * page name
 * page name
 * page name
 * page name
 * page name
 * page name
 * page name
 * page name
 * page name
 * specifies an overflow page for corresponding kind of article when using . These options only apply when the   option is set. They allow a page name to be specified that will be added as a link after the maximum number of articles are outputted. This is designed to allow linking to a page that contains a full listing of the content type. See this page for an usage example.


 * or N : specifies displaying DYK blurbs instead of page names. The  option displays the DYK blurb (if available) instead of the page name. If a number is specified, then the first   blurbs will be displayed normally and the remaining blurbs will be wrapped in  . This can be used to limit the number of blurbs that are transcluded onto another page.
 * : specifies displaying DYK blurbs on subpages by year. This can be useful if the content would otherwise exceed the Wikipedia's maximum page size. The DYK blurbs will be saved to subpages organized by year. The subpages will be transcluded to the project content page with 10 blurbs per subpage. The subpages will follow the blurb formatting and sorting order specified for the main page.
 * Note: These subpages are only for the bot's content. The subpages' content will be completely replaced when the project content is updated by the bot.


 * : specifies displaying italic title in italics. The  option will display pages marked as italic titles in italics. If the page title ends in a parenthesized text, only the part before the parenthesizes will be italicized. However, it does not support the   parameter (allowing a subset of the title to be in italics) or other italic templates that require parsing the page content to determine what portion of the title is to be italicized. This option should only be utilized if those limitations are suitable for the recognized content being displayed.
 * text : replace text "recognized content" with  in the wikitext output.

Output
The results will be written to same page as the template. They will be prefaced by a comment header and followed by a comment footer. This header and footer are not visible on the displayed page, but are needed to allow the bot to identify prior results.


 * header =
 * footer =

If the bot doesn't find a valid header and footer (ex. first run), it will place the results immediately below the template. If it does find a valid header and footer (updates), it will replace the content between the header and footer with the new results.

Tracking category

 * – For standalone/Near-standalone list pages. It will not list WikiProject Physics if  is directly embedded, but will list the standalone WikiProject Physics/Recognized content (and similar lists).