Template:Stub/doc: Difference between revisions

From [N8]
Jump to navigation Jump to search
Created page with "<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -..."
 
No edit summary
 
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
{{documentation}}
    <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
The '''Stub''' template is used to mark short articles for further expansion.  This template adds the article to the [[:Category:Stubs]]. This template '''should not''' be placed on short articles that can't be expanded any further.
'''''Stub''''' can be used to highlight stub articles.


== Usage ==
==Usage==
This table may be added by copy-pasting the template as shown below into an article.
{{t|stub}}


<div style="background:#ddd; border:1px solid black; padding:0.5em 1em 0.5em 1em;">
==Placement==
<pre>
The tag should preferably be placed at the '''bottom''' of the article. This will be done automatically, as {{t|Clear}} is integrated into the template. however, in situations where this is undesirable, the "clear" parameter can be set to false.
{{Stub}}
</pre>
</div>


== Parameters ==
{{t|stub|clear{{=}}false}}
There are none.


== Values ==
<includeonly>[[Category:Maintenance templates|{{PAGENAME}}]]</includeonly>
There are none.


== Effects ==
{{TemplateData|<templatedata>
Puts a table onto the page concerning their length.
{
 
"params": {
== Updating This Template ==
"clear": {
You shouldn't have to.
"label": "Clear",
 
"description": "Prevents tag being placed at the bottom of an article",
== Example ==
"example": "false",
<pre>{{Stub}}</pre>
"type": "string"
 
}
Will display this:
},
 
"description": "The Stub template is used to mark short articles for further expansion. This template adds the article to the Category:Stubs. This template should not be placed on short articles that can't be expanded any further.",
{{Stub|}}
"format": "inline"
}
</templatedata>
}}

Latest revision as of 21:50, 30 May 2020

This is a documentation subpage for Template:Stub.
It contains usage information, categories, and other content that is not part of the original template page.

The Stub template is used to mark short articles for further expansion. This template adds the article to the Category:Stubs. This template should not be placed on short articles that can't be expanded any further.

Usage

{{stub}}

Placement

The tag should preferably be placed at the bottom of the article. This will be done automatically, as {{Clear}} is integrated into the template. however, in situations where this is undesirable, the "clear" parameter can be set to false.

{{stub|clear=false}}


Data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

The Stub template is used to mark short articles for further expansion. This template adds the article to the Category:Stubs. This template should not be placed on short articles that can't be expanded any further.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Clearclear

Prevents tag being placed at the bottom of an article

Example
false
Stringoptional