Template:InfoBox irc

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.

Use this template inside an {{InfoBox stack}} to provide a link to an IRC channel in a right-floated box.

Important
Please go and read the documentation of the {{IRC}} template for full explanation of how to use this template (that template is what this one uses internally).

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) The name of a libera.chat IRC channel, or channel on alternate server when using second parameter. Remember to include the hash (#) if using an alternate server.
Anonymous parameter 2 No (n/a) URL of alternate IRC server. Include scheme (irc:// or ircs://), do not include a trailing slash.
comment No (n/a) Postpends a comment in brackets. Useful for example to signal that a channel might require registration or some other particularity.
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}}.

Usage

This template must be used inside of an {{InfoBox stack}}, as seen in the template's testcases:

Correct

One anonymous parameter (an IRC channel name)
Wiki code
{{InfoBox stack
| {{InfoBox irc|gentoo}}
}}
Main version
Sandbox version


Channel plus optional server
Wiki code
{{InfoBox stack
| {{InfoBox irc|#i3|irc://irc.oftc.net}}
}}
Main version
Sandbox version


Channel plus optional server with comment
Wiki code
{{InfoBox stack
| {{InfoBox irc|#pipewire|irc://irc.oftc.net|comment=Registration required}}
}}
Main version
#pipewire (on irc://irc.oftc.net)(Registration required)
Sandbox version
#pipewire (on irc://irc.oftc.net)(Registration required)


Using header=true
Wiki code
{{InfoBox stack
| {{InfoBox irc|gentoo|header=true}}
}}
Main version
Resources
Sandbox version
Resources


Incorrect

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


Used outside of an {{InfoBox stack}} (wide box, not right-floated)
Wiki code
{{InfoBox irc|gentoo}}
Main version
Sandbox version


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
Article status
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
Babel (spoken-language indicators)
Note
The above documentation is transcluded from Template:InfoBox irc/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.)