Template:See also/doc

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.

Use this template to display a link to an article along with the article's description, primary used in the "See also" sections of articles, but can also be used other places. Only articles that set the 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 it's use to the "See also" sections of articles.

Parameters

Use this template to display a link to an article along with the article's description. Only articles that set the Article description property somewhere in the body will work for this template.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
1	1	Add the name of the wiki article/page	String	required
Text	text	Display text other than the article name	String	optional

Usage

See the template's testcases:

Correct

One anonymous parameter of a valid article name.

Wiki code

{{See also|Ebuild}}

Main version

Ebuild — a text file, usually stored in a repository, which identifies a specific software package and tells the Gentoo package manager how to handle it.

Sandbox version

Ebuild — a text file, usually stored in a repository, which identifies a specific software package and tells the Gentoo package manager how to handle it.

text parameter to show a text instead of article name.

Wiki code

{{See also|text=The Main Page|Main Page}}

Main version

The Main Page — Larry the cow beckons you to explore the Gentoo wiki!

Sandbox version

The Main Page — Larry the cow beckons you to explore the Gentoo wiki!

Incorrect

No parameter passed. (Exposes wikicode.)

Wiki code

{{See also}}

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 — how to add the article description;
• Article description (Property)
• {{Article description}} (Template)