Template:IrcLink/doc: Difference between revisions

From AniDB
Jump to navigation Jump to search
No edit summary
m (Updated the doc... explicit description of syntax.)
Line 2: Line 2:


==Alternative names==
==Alternative names==
* {{m|irclink}} is the lowercase syntax name
* {{m|irclink}} - The lower-case template alias.
* {{m|IrcLink}} is the full syntax name
* {{m|IrcLink}} - The "proper" template name.


==Syntax==
==Syntax==
The template can have '''1''' or '''2 parameters''':
#{{m|IrcLink|<channel>}} - Name of channel you want to link to.
#{{m|IrcLink|<channel>|<name>}} - Define the link name.
  '''<channel>'''  =  IRC channel name, i.e. <nowiki>'''irc://irc.synirc.net/<channel>'''</nowiki>.
    '''<name>'''  =  Name of the IRC link.
==Examples==
  {{m|IrcLink|anidb}}
  {{m|IrcLink|anidb}}
{{IrcLink|anidb}}
{{IrcLink|anidb}}
Line 11: Line 20:
  {{m|IrcLink|anidb|#anidb}} on SynIRC
  {{m|IrcLink|anidb|#anidb}} on SynIRC
{{IrcLink|anidb|#anidb}} on SynIRC
{{IrcLink|anidb|#anidb}} on SynIRC
{{eyecatch|Note|If you only define one template parameter the IRC URL will be shown. If you define the '''<name>''' parameter that will be shown instead.}}

Revision as of 08:24, 10 May 2009

This template generates a link to an AniDB channel.

Alternative names

  • {{irclink}} - The lower-case template alias.
  • {{IrcLink}} - The "proper" template name.

Syntax

The template can have 1 or 2 parameters:

  1. {{IrcLink|<channel>}} - Name of channel you want to link to.
  2. {{IrcLink|<channel>|<name>}} - Define the link name.
 <channel>  =  IRC channel name, i.e. '''irc://irc.synirc.net/<channel>'''.

    <name>  =  Name of the IRC link.

Examples

{{IrcLink|anidb}}

irc://irc.synirc.net/anidb

{{IrcLink|anidb|#anidb}} on SynIRC

#anidb on SynIRC

Note If you only define one template parameter the IRC URL will be shown. If you define the <name> parameter that will be shown instead.