User:JL-Bot/Project content/documentation: Difference between revisions

Revision as of 15:34, 1 January 2010

Revision as of 15:40, 2 January 2010

Line 7:

<pre><nowiki>

{{User:JL-Bot/Project content

|project parameter (see below)

|template = Name of project template

|content parameters (see below)

|optional parameters (see below)

}}

</nowiki></pre>

The <code>template</code> 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, [[Wikipedia:WikiProject Physics|WikiProject Physics]] uses the {{tl|physics}} template so the parameter for them would be <code>|template = Physics</code>.

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

Line 26 ⟶ 24:

* <code>Portal:</code>

* <code>Portal talk:</code>

===Project Parameter===

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

*<code>|template = Name of project template</code>

*<code>|category = Name of project category</code>

The <code>template</code> 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, [[Wikipedia:WikiProject Physics|WikiProject Physics]] uses the {{tl|physics}} template so the parameter for them would be <code>|template = Physics</code>.

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

The <code>template</code> parameter will override the <code>category</code> parameter if both are present.

===Content Parameters===

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

*<code>|content-featured-articles</code> -- lists [[:Category:Wikipedia featured articles]] content

Line 41 ⟶ 51:

*<code>|content-featured-portals</code> -- lists [[:Category:Wikipedia featured portals]] content

*<code>|content-former-featured-portals</code> -- lists [[:Category:Wikipedia former featured portals]] content

*<code>|content-featured-article-candidates</code> -- lists [[:Category:Wikipedia featured article candidates]] content

*<code>|content-featured-list-candidates</code> -- lists [[:Category:Wikipedia featured list candidates]] content

*<code>|content-good-article-nominees</code> -- lists [[:Category:Good article nominees]] content

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

Line 59 ⟶ 72:

===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 = <code><nowiki><!-- Start of content generated by JL-Bot --></nowiki></code>

*footer = <code><nowiki><!-- End of content generated by JL-Bot --></nowiki></code>

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.