Template:USE

From Gentoo Wiki
Jump to:navigation Jump to: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.

Present a USE flag with a link to it's description on https://packages.gentoo.org, and a link to the USE flag article.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
USE flag1

USE flag to link to on https://packages.gentoo.org

Example
dbus
Stringrequired
nodeconodeco

Set this to deactivate the 'flag icon', for example if the template is used in a literal list of use flags.

Example
true
Booleanoptional
Note
The USE flags may be preceded with "-" to represent them in a deactivated state (the template strips the minus sign so that the links to p.g.o will still work).

Usage

See the template's testcases:


Correct

One anonymous parameter: USE flag name
Wiki code
{{USE|dbus}}
Main version
Be sure to activate dbus in order to get the...
Sandbox version
Be sure to activate dbus in order to get the...


One anonymous deacivated parameter: USE flag name with preceding "-"
Wiki code
{{USE|-dbus}}
Main version
lorem ipsum Gentoo emerge -dbus dolor...
Sandbox version
lorem ipsum Gentoo emerge -dbus dolor...


One anonymous parameter plus nodeco=true
Wiki code
{{USE|dbus|nodeco=true}}
Main version
Sandbox version


Incorrect

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


See also

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