Template:InfoBox odoc/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 inside an {{InfoBox stack}} to provide a link to the official documentation, guide, how-to, tutorial, etc., for the subject of an article.

Parameters

Parameter name	Required?	Default value	Description
Anonymous parameter `1`	Yes	(n/a)	URL of the official documentation for the subject of the article.
`header`	No	(n/a)	Set this to `yes` or `true` to display a Resources heading, but only if the infobox is the first one in an {{InfoBox stack}}.
`text`	No	`Official documentation`	Can be used to change the link text.

Usage

See the template's testcases:

Correct

Collapse

One anonymous parameter (a URL)

Wiki code

{{InfoBox stack
| {{InfoBox odoc|http://nginx.org/en/docs/}}
}}

Main version

Official documentation

Sandbox version

Official documentation

Collapse

Using header=true

Wiki code

{{InfoBox stack
| {{InfoBox odoc|http://nginx.org/en/docs/|header=true}}
}}

Main version

Resources

Official documentation

Sandbox version

Resources

Official documentation

Collapse

Specifying link text using text

Wiki code

{{InfoBox stack
| {{InfoBox odoc|http://nginx.org/en/docs/|text=Other text}}
}}

Main version

Other text

Sandbox version

Other text

Incorrect

Collapse

No parameter (error message)

Wiki code

{{InfoBox stack
| {{InfoBox odoc}}
}}

Main version

Parameter 1 not defined. For correct usage see InfoBox odoc template's documentation on the 1 parameter.

Sandbox version

Parameter unnamed not defined. For correct usage see InfoBox odoc template's documentation on the unnamed parameter.

Collapse

Used outside of an {{InfoBox stack}} (wide box, not right-floated)

Wiki code

{{InfoBox odoc|http://nginx.org/en/docs/}}

Main version

Official documentation

Sandbox version

Official documentation

See also[edit]

The templates below are implemented using {{InfoBox}}. They should also appear in Category:InfoBox templates, which may be more complete than this list.

These templates should be used within an {{InfoBox stack}}. Each should provide its own header parameter, but if necessary {{InfoBox header}} can be used.

Underlined text indicates the default heading provided by header=true for each type of template.

For use in articles

Resources

{{InfoBox homepage}} – Link to the official home page for a piece of software or hardware.
{{InfoBox odoc}} – Link to official documentation, guides, how-tos, tutorials, etc. (not user-provided documentation).
{{InfoBox package}} – Link to package information at Packages.Gentoo.org.
{{InfoBox project}} – Link to the related Gentoo project (on this wiki).
{{InfoBox guide}} – Link to a Gentoo guide (on this wiki).
{{InfoBox wikipedia}} – Link to a Wikipedia article.
{{InfoBox ohloh}} – Link to an Ohloh project.
{{InfoBox github}} – Link to GitHub repository.
{{InfoBox gitweb}} – Link to source code repository.
{{InfoBox manpage}} – Link to a man page.
{{InfoBox irc}} – Link to an IRC channel.
{{InfoBox blog}} – Link to a blog.

Article status

{{InfoBox wikify}} – Article needs additional wiki-formatting.
{{InfoBox todo}} – TODO list for the article.
{{InfoBox dated}} – Article information is out of date.
{{InfoBox delete}} – Article should be deleted. ({{Delete}} is more noticeable.)

For use on talk pages

Talk status

(Note that the simpler {{Talk}} can be used in place of both of these.)

For use on user pages

User info

{{InfoBox user}} – Basic user information. (special heading: username of user page owner)
{{InfoBox user since}} – When user started using Gentoo.
{{InfoBox user dev}} – User is a Gentoo developer.

Babel (spoken-language indicators)