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 14:55, 28 December 2009 (add). 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 a Project's recognized content.

Usage

Place the template where you want the content displayed: 

{{User:JL-Bot/Project content
|template = Name of project template
|content parameters (see below)
|optional parameters (see below)
}}

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 {{physics}} template so the parameter for them would be |template = Template:Physics.

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:

Content Parameters

The following content parameters are supported:

These parameters are used to define the content to be listed. The content will be listed in the order the parameters appear in the template.

Optional Parameters

The following optional parameters are supported:

  • |compact -- specifies compact layout instead of column layout (ex: article1 · article2)
  • |columns = # -- defines the # of columns to be displayed in default column layout
  • |icons -- specifies the use of content type icons

The compact option overrides the columns and iconsoptions.

Pictures always use the <gallery></gallery> syntax.

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=334547460"