Template:InfoBox gitweb

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

Parameters

Parameter name	Required?	Default value	Description
Anonymous parameter `1`	Yes	(n/a)	Path to project at GitWeb.Gentoo.com or other GitWeb 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	`GitWeb`	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 GitWeb page is at Gentoo's GitWeb site, then the value of the required anonymous parameter must match the final portion of the target URL, after proj/. For example, using portage.git will give a link to https://gitweb.gentoo.org/proj/portage.git.

To link to a page at a different GitWeb site, the value of the anonymous parameter must be set to the full raw URL (including the leading 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 GitWeb path)

Wiki code

{{InfoBox stack
| {{InfoBox gitweb|portage.git}}
}}

Main version

GitWeb

Sandbox version

GitWeb

Using header=true

Wiki code

{{InfoBox stack
| {{InfoBox gitweb|portage.git|header=true}}
}}

Main version

Resources

GitWeb

Sandbox version

Resources

GitWeb

Indicating a raw URL using raw

Wiki code

{{InfoBox stack
| {{InfoBox gitweb|https://gitweb.gentoo.org/proj/portage.git|raw=true}}
}}

Main version

GitWeb

Sandbox version

GitWeb

Specifying link text using `text`
Wiki code	`{{InfoBox stack \| {{InfoBox gitweb\|portage.git\|text=Other text}} }}`
Main version	Other text
Sandbox version	Other text

Incorrect

No parameter (error message)

Wiki code

{{InfoBox stack
| {{InfoBox gitweb}}
}}

Main version

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

Sandbox version

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

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

Wiki code

{{InfoBox gitweb|portage.git}}

Main version

GitWeb

Sandbox version

GitWeb

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 gitlab}} – Link to GitLab repository.
{{InfoBox codeberg}} – Link to Codeberg 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.
{{InfoBox wiki}} – Link to an official project wiki.

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)

Note
The above documentation is transcluded from Template:InfoBox gitweb/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.)