Template:InfoBox odoc

From Gentoo Wiki
Jump to: navigation, search
[edit

Documentation

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

One anonymous parameter (a URL)
Wiki code
{{InfoBox stack
| {{InfoBox odoc|http://nginx.org/en/docs/}}
}}
Main version
Sandbox version


Using header=true
Wiki code
{{InfoBox stack
| {{InfoBox odoc|http://nginx.org/en/docs/|header=true}}
}}
Main version
Sandbox version


Specifying link text using text
Wiki code
{{InfoBox stack
| {{InfoBox odoc|http://nginx.org/en/docs/|text=Other text}}
}}
Main version
Sandbox version


Incorrect

No parameter (error message)
Wiki code
{{InfoBox stack
| {{InfoBox odoc}}
}}
Main version
{{InfoBox odoc template error}}
Parameter 1 not defined. For correct usage see InfoBox odoc template's documentation on the 1 parameter.
Sandbox version
{{InfoBox odoc template error}}
Parameter unnamed not defined. For correct usage see InfoBox odoc template's documentation on the unnamed parameter.


Used outside of an {{InfoBox stack}} (wide box, not right-floated)
Wiki code
{{InfoBox odoc|http://nginx.org/en/docs/}}
Main version
Sandbox version


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
Article status
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
Babel (spoken-language indicators)
Note
The above documentation is transcluded from Template:InfoBox odoc/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. (See the subpages of this template.)