Template:Module rating/doc

From Forsaken Saga Wiki
Revision as of 03:14, 27 June 2024 by Harrigton (talk | contribs) (Created page with "{{Documentation subpage}} <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage. It produces a message informing users about the rating system, and it also places the module into a tracking category. == Usage == Basic usage: {{pre|{{tlx|module rating|''rating''}}}} Without categories: {{pre|{{tlx|module rating|''rating''|3...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage. It produces a message informing users about the rating system, and it also places the module into a tracking category.

Usage[edit source]

Basic usage:

<templatestyles src="Pre/styles.css"/>

Template:Tlx

Without categories:

<templatestyles src="Pre/styles.css"/>

Template:Tlx

If Template:Tlx is used outside the Module namespace, an error message is displayed instead and will be categorized under Category:Pages with templates in the wrong namespace.

If the documentation subpage is also protected:

<templatestyles src="Pre/styles.css"/>

Template:Tlx

The second and third unnamed arguments correspond to reason and action of {{Pp}} which gets included on the documentation subpage if at least the second unnamed argument is present.

Ratings[edit source]

The rating should be placed in the first positional parameter. There are six different ratings: pre-alpha, alpha, beta, release, and protected, and semiprotected. There are also short alias codes for each of the ratings.

Rating Aliases Result
pre-alpha prealpha
pa
alpha a
beta b
release r
general
g
protected protect
p
semiprotected semiprotect
semi
Anything else or if missing

TemplateData[edit source]

Script error: No such module "Format TemplateData".

Categories[edit source]

The template will put modules in one of the following categories, according to the rating specified:

These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code Template:Para.

See also[edit source]