Template:Keyword

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 for keywords (such as amd64 or ~x86) so they can be rendered in a standard style across the Wiki. This template can easily be inserted into paragraphs.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) The name of a Gentoo keyword.

Current Gentoo keywords include:

  • alpha
  • ~alpha
  • amd64
  • ~amd64
  • arm
  • ~arm
  • arm64
  • ~arm64
  • hppa
  • ~hppa
  • ia64
  • ~ia64
  • m68k
  • ~m68k
  • mips
  • ~mips
  • ppc
  • ~ppc
  • ppc64
  • ~ppc64
  • s390
  • ~s390
  • sparc
  • ~sparc
  • x86
  • ~x86

However, note that this template does not check that the specified keyword is a valid one.

Usage

{{Keyword|name}}

where name is the keyword to be marked up

See also the template's testcases:

Correct

One unnamed parameter
Wiki code {{Keyword|~amd64}}

Main version ~amd64
Sandbox version ~amd64

Incorrect

No parameter (exposes raw wikicode)
Wiki code {{Keyword}}

Main version {{{1}}}
Sandbox version {{{1}}}
Note
The above documentation is transcluded from Template:Keyword/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.)