Wikipedia

User:JL-Bot/Project content/documentation

< User:JL-Bot | Project content
This is an old revision of this page, as edited by JLaTondre (talk | contribs) at 12:30, 3 September 2011 (→Optional Parameters: add overflow options). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

This template is used to have the bot generate a listing of recognized content.

For an example, see Wikipedia:WikiProject Physics/Recognized content.

Usage

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)
}}

The bot expects to see a single parameter per line with the closing }} on its own line. Failure to follow that will cause the bot to ignore parameters.

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

It will only work in the following namespaces:

  • User:
  • User talk:
  • Project:
  • Project talk:
  • Portal:
  • Portal talk:

Project Parameter

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 = Physics. If there are redirects to the template (ex. {{WPPhysics}} to {{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), than 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.

Content Parameters

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-a-class-articles parameters can be specified and the bot will list the articles from all the specified categories.

Optional Parameters

The following optional parameters are supported:

  • |compact -- specifies compact layout instead of column layout (ex: article1 · article2)
  • |maximum = # -- specifies the maximum articles to list in compact mode
  • |columns = # -- defines the # of columns to be displayed 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 = # -- defines the heading level (number of "="s) to use; the default is level 2
  • |pictures-list -- specifies pictures should be listed (obeying the columns, icons, and compact options)
  • |dates -- specifies including in the output the date the content was on the Main Page (where applicable)
  • |sorting = <value> -- specifies the sorting to use (see below)
  • |date-order = <value> -- specifies the sorting order for dates (see below)
  • |display-total -- specifies that a count of the number of pages in the content type is displayed
  • |overflow-FA = Name of overflow page -- specifies an overflow page for content-featured-articles when using maximum
  • |overflow-GA = Name of overflow page -- specifies an overflow page for content-good-articles when using maximum
  • |overflow-DYK = Name of overflow page -- specifies an overflow page for content-did-you-know-articles when using maximum

The compact option overrides the columns and icons options.

The maximum option only applies when the compact option is set.

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.

Pictures will use the <gallery></gallery> syntax if the pictures-list option is not set.

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.

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.

The overflow-FA, overflow-GA, and overflow-DYK 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.

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 = <!-- 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.

Retrieved from "https://en.wikipedia.org/w/index.php?title=User:JL-Bot/Project_content/documentation&oldid=448217010"