Difference between revisions of "Template:IRC NQNS long/doc"

From blackwiki
Jump to navigation Jump to search
imported>Tothwolf
m (removed stray whitespace)
imported>RogueScholar
(Update documentation to reflect template changes and add TemplateData)
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
{{tl|IRC NQNS long}} is a template for [[Internet Relay Chat]] articles that provides a search links to [http://irc.netsplit.de/ irc.netsplit.de] to allow for [[IRC network]] information queries.
+
{{Tlb|IRC NQNS long}} is a template for [[Internet Relay Chat]] articles that provides several links to [https://netsplit.de/ netsplit.de] to allow for [[IRC network]] information queries.
  
==Mnemonic==
+
== Mnemonic ==
 
'''''IRC''' '''N'''etwork '''Q'''uery '''N'''et'''S'''plit.de '''long'''''
 
'''''IRC''' '''N'''etwork '''Q'''uery '''N'''et'''S'''plit.de '''long'''''
  
==Blank template==
+
== Blank template ==
 
{| style="background: transparent;"
 
{| style="background: transparent;"
 
|<pre>
 
|<pre>
Line 12: Line 12:
 
|}
 
|}
  
==Usage==
+
== Usage ==
 
This template accepts two arguments. The first argument is required and is the name of the IRC network.  The second argument is optional and if provided will be used as the link text.  If a second argument is not provided, the first argument will be used for the link text.
 
This template accepts two arguments. The first argument is required and is the name of the IRC network.  The second argument is optional and if provided will be used as the link text.  If a second argument is not provided, the first argument will be used for the link text.
  
==Examples==
+
== Examples ==
 
The following are examples of how the IRC NQNS long template is used (using [[EFnet]] as an example):
 
The following are examples of how the IRC NQNS long template is used (using [[EFnet]] as an example):
  
Line 27: Line 27:
 
{| style="background: transparent;"
 
{| style="background: transparent;"
 
|<pre>
 
|<pre>
{{IRC NQNS long|EFnet|network stats}}
+
{{IRC NQNS long|EFnet|EFnet details}}
 
</pre>
 
</pre>
{{IRC NQNS long|EFnet|network stats}}
+
{{IRC NQNS long|EFnet|EFnet details}}
|}<includeonly>
+
|}
 +
 
 +
== TemplateData ==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
"params": {
 +
"1": {
 +
"label": "IRC network name",
 +
"description": "The network name as shown by netsplit.de, used to create the URL in the form of https://netsplit.de/networks/<value>/",
 +
"example": "DALnet",
 +
"type": "string",
 +
"required": true
 +
},
 +
"2": {
 +
"label": "Link text",
 +
"description": "The linked text to be shown, if empty the network name will be used",
 +
"example": "DALnet details",
 +
"type": "string"
 +
}
 +
},
 +
"description": "Produces a series of links to pages about various IRC network details provided by netsplit.de",
 +
"format": "inline"
 +
}
 +
</templatedata><includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Internet Relay Chat external link templates]]
 
[[Category:Internet Relay Chat external link templates]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
</includeonly>
 
</includeonly>

Revision as of 13:54, 15 October 2019

{{IRC NQNS long}} is a template for Internet Relay Chat articles that provides several links to netsplit.de to allow for IRC network information queries.

Mnemonic

IRC Network Query NetSplit.de long

Blank template

{{IRC NQNS long | IRC network | link text}}

Usage

This template accepts two arguments. The first argument is required and is the name of the IRC network. The second argument is optional and if provided will be used as the link text. If a second argument is not provided, the first argument will be used for the link text.

Examples

The following are examples of how the IRC NQNS long template is used (using EFnet as an example):

{{IRC NQNS long|EFnet}}

EFnet (about⧼dot-separator⧽statistics⧼dot-separator⧽channels⧼dot-separator⧽servers⧼dot-separator⧽status⧼dot-separator⧽webchat)

{{IRC NQNS long|EFnet|EFnet details}}

EFnet details (about⧼dot-separator⧽statistics⧼dot-separator⧽channels⧼dot-separator⧽servers⧼dot-separator⧽status⧼dot-separator⧽webchat)

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for IRC NQNS long

Produces a series of links to pages about various IRC network details provided by netsplit.de

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
IRC network name1

The network name as shown by netsplit.de, used to create the URL in the form of https://netsplit.de/networks/<value>/

Example
DALnet
Stringrequired
Link text2

The linked text to be shown, if empty the network name will be used

Example
DALnet details
Stringoptional