Template:IRC/doc

From Gentoo Wiki
Jump to: navigation, search
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 to specify in-line Freenode IRC channels (such as #gentoo or #gentoo-bugzilla) so they can be rendered in a standard style across the Wiki.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) The name of a Gentoo IRC channel.
mode No (n/a) Alters the mode of the connection. If mode=webchat is specified then the IRC channel will open using Freenode's in-browser WebChat client.

Some Gentoo IRC channels include:

Some Gentoo IRC channels include:

For a full list of channels see the All IRC Channels page on the main site.

Note that this template does not check if the specified Freenode channel is actually valid (existing). For now be careful what is entered. Error checking is a future goal.

Usage

  • {{IRC|channel}}
Where channel is the IRC channel to be marked up (excluding the leading #).

With mode set (currently only supports WebChat):

  • {{IRC|channel|mode=webchat}}
Where channel is the IRC channel to be marked up (excluding the leading #) and mode=webchat.

See the template's testcases:


Parameter: unnamed
Wiki code {{IRC}}

Main version #{{{1}}}
Sandbox version IRC TEMPLATE ERROR: An IRC channel must be specified!
Parameter: gentoo
Wiki code {{IRC|gentoo}}

Main version #gentoo
Sandbox version #gentoo
Parameter: gentoo|mode=webchat
Wiki code {{IRC|gentoo|mode=webchat}}

Main version #gentoo
Sandbox version #gentoo

See also