Template:InfoBox manpage/doc
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
header=true
raw
text{{InfoBox stack
| {{InfoBox manpage|man1/cat.1|text=Other text}}
}}
Incorrect
{{InfoBox stack
| {{InfoBox manpage}}
}}
1 parameter.unnamed parameter.
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 blog}} – Link to a blog.
- {{InfoBox codeberg}} – Link to Codeberg repository.
- {{InfoBox github}} – Link to GitHub repository.
- {{InfoBox gitlab}} – Link to GitLab repository.
- {{InfoBox gitweb}} – Link to source code repository.
- {{InfoBox guide}} – Link to a Gentoo guide (on this wiki).
- {{InfoBox homepage}} – Link to the official home page for a piece of software or hardware.
- {{InfoBox irc}} – Link to an IRC channel.
- {{InfoBox manpage}} – Link to a man page.
- {{InfoBox odoc}} – Link to official documentation, guides, how-tos, tutorials, etc. (not user-provided documentation).
- {{InfoBox ohloh}} – Link to an Ohloh project.
- {{InfoBox package}} – Link to package information at Packages.Gentoo.org.
- {{InfoBox project}} – Link to the related Gentoo project (on this wiki).
- {{InfoBox sourcehut}} - Link to Sourcehut project.
- {{InfoBox wiki}} – Link to an official project wiki.
- {{InfoBox wikipedia}} – Link to a Wikipedia article.
- Article status
- {{InfoBox dated}} – Article information is out of date.
- {{InfoBox delete}} – Article should be deleted. ({{Delete}} is more noticeable.)
- {{InfoBox todo}} – TODO list for the article.
- {{InfoBox wikify}} – Article needs additional wiki-formatting.
- 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 dev}} – User is a Gentoo developer.
- {{InfoBox user since}} – When user started using Gentoo.
- Babel (spoken-language indicators)