Template:InfoBox manpage

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 a man page in a right-floated box.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) Path to manpage at Man7.org or other manpage site (see below).
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 Man page Can be used to change the link text.
raw No (n/a) If present, the anonymous parameter value is interpreted as a raw URL (see below).

If the man page is at Man7.org (see this list), then the value of the required anonymous parameter must match the portion of the target URL, between man-pages/ and .html. For example, using man1/cat.1 will give a link to http://man7.org/linux/man-pages/man1/cat.1.html.

To link to a page at a different website (e.g., Kernel.org) the value of the anonymous parameter must be set to the full raw URL (including the leading http://, https:// or just //), and raw must be set to any value (yes or true are good choices).

Usage

This template must be used inside of an {{InfoBox stack}}, as seen in the template's testcases:

Correct

One anonymous parameter (a Man7.org path)
Wiki code
{{InfoBox stack
| {{InfoBox manpage|man1/cat.1}}
}}
Main version
Sandbox version


Using header=true
Wiki code
{{InfoBox stack
| {{InfoBox manpage|man1/cat.1|header=true}}
}}
Main version
Resources
Sandbox version
Resources


Indicating a raw URL using raw
Wiki code
{{InfoBox stack
| {{InfoBox manpage|http://man7.org/linux/man-pages/man1/cat.1|raw=true}}
}}
Main version
Sandbox version


Specifying link text using text
Wiki code
{{InfoBox stack
| {{InfoBox manpage|man1/cat.1|text=Other text}}
}}
Main version
Sandbox version


Incorrect

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


Used outside of an {{InfoBox stack}} (wide box, not right-floated)
Wiki code
{{InfoBox manpage|man1/cat.1}}
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 manpage/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.)