Template:Article description/doc
From Gentoo Wiki
Jump to:navigation
Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
Use this template to display an article's description. This template is similar to the {{See also}} template, but does not include the preceding link. It is useful when trying to reference the Article description only. It is important to note that only articles that set the SMW Article description property somewhere in the body will work for this template.
Warning
This template uses an expensive function (as noted on wikipedia). Over use on a single page will have some results ignored. Try to limit its use.
This template uses an expensive function (as noted on wikipedia). Over use on a single page will have some results ignored. Try to limit its use.
Parameters
Use this template to display an article's description. Only articles that set the SMW 'Article description' property somewhere in the body will work for this template.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | Add the name of the wiki article/page | String | required |
Usage
See the template's testcases:
Correct
One anonymous parameter of a valid article name.
Wiki code
{{Article description|Main Page}}
Main version
Larry the Cow beckons you to explore the Gentoo wiki!
Sandbox version
Larry the Cow beckons you to explore the Gentoo wiki!
Incorrect
No parameter passed. (Exposes wikicode.)
Wiki code
{{Article description}}
Main version
{{See also template error}}
Parameter Anonymous parameter not defined. For correct usage see See also template's documentation on the
Anonymous parameter parameter.Sandbox version
{{See also template error}}
Parameter Anonymous parameter not defined. For correct usage see See also template's documentation on the
Anonymous parameter parameter.
See also
- Gentoo Wiki:Guidelines#Article description property — how to add the article description;
- Article description (Property)
- {{See also}}