Template:Module rating/doc

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:

{{module rating|rating}}

This template implements a version of the functionality provided by the HTML <pre> tag.

Usage
This template supports two parameters

|width= The width of the pre "box" 

|space= The way white space is handled in the pre "box"

Markup	Renders as
{{Pre| This Pre-format can look like this. }}

Main differences include:

• It wraps text that overflows the page.
• It allows mid-line-breaks (but not always consistently).

Main limitations include:

• If the text is a single long word, it won't be wrapped and will still break out to the right hand of the page.
• HTML and wikimarkup aren't disabled as in <pre>...</pre> and are rendered as usual (thus if a parameter contains any wikimarkup, enclose it in <nowiki>...</nowiki>); however, multiple spaces are preserved.

As with <pre> and <code>, {{pre}} displays text in the font specified as the monospace font in the user's browser options, or specified in the user's CSS pages.

Example

Markup

{{Pre|
'''First line, markup working:''' and HTML comment <!--HIDDEN--> hidden.

'''Second line, long text wrapping:''' all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy.

'''Third line with raw | pipe is handled''', but the space before the pipe is lost. Up to raw 20 pipes are handled, else use <nowiki>{{!}}</nowiki> and {{!}} it's {{!}} OK.

'''Fourth      line,     multiple spaces preserved''' unlike in HTML and wikitext.
'''Fifth line, following the previous one'''.


'''Last line''' preceded by two blank lines in markup and in display.
}}

Result

See also

• {{pre2}}, a template with similar functionality but induces optional line wrap and optional scroll bars.
• <syntaxhighlight>
• <pre>

-->

Without categories:

{{module rating|rating|nocat=true}}

This template implements a version of the functionality provided by the HTML <pre> tag.

Usage
This template supports two parameters

|width= The width of the pre "box" 

|space= The way white space is handled in the pre "box"

Markup	Renders as
{{Pre| This Pre-format can look like this. }}

Main differences include:

• It wraps text that overflows the page.
• It allows mid-line-breaks (but not always consistently).

Main limitations include:

• If the text is a single long word, it won't be wrapped and will still break out to the right hand of the page.
• HTML and wikimarkup aren't disabled as in <pre>...</pre> and are rendered as usual (thus if a parameter contains any wikimarkup, enclose it in <nowiki>...</nowiki>); however, multiple spaces are preserved.

As with <pre> and <code>, {{pre}} displays text in the font specified as the monospace font in the user's browser options, or specified in the user's CSS pages.

Example

Markup

{{Pre|
'''First line, markup working:''' and HTML comment <!--HIDDEN--> hidden.

'''Second line, long text wrapping:''' all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy all work and no play make jack a dull boy.

'''Third line with raw | pipe is handled''', but the space before the pipe is lost. Up to raw 20 pipes are handled, else use <nowiki>{{!}}</nowiki> and {{!}} it's {{!}} OK.

'''Fourth      line,     multiple spaces preserved''' unlike in HTML and wikitext.
'''Fifth line, following the previous one'''.


'''Last line''' preceded by two blank lines in markup and in display.
}}

Result

See also

• {{pre2}}, a template with similar functionality but induces optional line wrap and optional scroll bars.
• <syntaxhighlight>
• <pre>

-->

If {{Module rating}} 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.

Ratings

The rating should be placed in the first positional parameter. There are five different ratings: pre-alpha, alpha, beta, release, and protected. 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

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the [https://bambots.brucemyers.com/TemplateParam.php?wiki=enwiki&template=Module+rating monthly error reporHatnotefor this template.

TemplateData for Module rating

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.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Rating	1	One of pre-alpha, alpha, beta or release for quality, or one of protected or semiprotected, or an approved (see full docs) abbreviation for one of these. Example release	String	required
Do not categorize	nocat	Set to true to disable categorization by rating. Normally leave blank. Default Not set.	Boolean	optional
Fake namespace	demospace	Set to module to force template to display outside that namespace. Demonstration purposes only. Default Not set. Example module	String	optional

Categories

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

• Category:Modules in pre-alpha development
• Category:Modules in alpha
• Category:Modules in beta
• Category:Modules for general use
• Category:Modules subject to page protection

These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code |nocat=true.

See also

• {{module-rating categories}}
• Wikipedia:Lua
• Wikipedia:Lua requests
• {{Lua}}