Template:Forumlink/doc - Revision history

Bobogoobo at 14:05, 10 November 2025

2025-11-10T14:05:23Z

← Older revision		Revision as of 14:05, 10 November 2025
Line 45:		Line 45:

	Other than when "post" is used and requires a topic, parameters for specific pages will take precedence in the order listed above.		Other than when "post" is used and requires a topic, parameters for specific pages will take precedence in the order listed above.

			Due to technical limitations, brackets <code>[]</code> cannot be used in display text in links. They can be replaced with parentheses <code>()</code>.

	==Examples==		==Examples==

Bobogoobo: update, should add more examples, maybe later...

2025-11-10T10:34:51Z

update, should add more examples, maybe later...

← Older revision		Revision as of 10:34, 10 November 2025
Line 6:		Line 6:

	==Available parameters==		==Available parameters==
	*first unnamed parameter: either the name of a shortcut (see below) or the website's host name and domain (e.g. npowned.net or forums.example.com).		*first unnamed parameter: either the name of a shortcut (see below) or the website's host name and domain (e.g. npowned.net or forums.example.com). If not using a shortcut, must also use <code>type</code>.
	*second unnamed parameter: the text to display for the link. This will intelligently default to text based on what is linked to.		*second unnamed parameter: the text to display for the link. This will intelligently default to text based on what is linked to. See also parameter <code>title</code>.
			*Content-specific parameters:
			**'''topic''': used to link to a specific topic on the forum.
			**'''post''': used to link to a specific post in a topic. On most forums, this will also require the topic to be specified. (See below for details; the template will warn you if it needs the topic.)
			**'''profile''': used to link to a forum member's profile.
			**'''forum''': used to link to a particular subforum.
			**'''news''': used to link to a news post (only available on some sites).
			**'''announcement''': used to link to a forum announcement (only available on some sites).
	*'''type''': used to specify the forum software so the template can generate the correct link. Omit this if using a shortcut.		*'''type''': used to specify the forum software so the template can generate the correct link. Omit this if using a shortcut.
	*'''~~topic~~''': ~~used to link to a specific topic on~~ the ~~forum~~.		*'''title''': if the default generated text is desired, but the parsed title is not correct (e.g. capitalization, removed punctuation characters, etc.), use this parameter to specify the title to use.
	*'''post''': used to link to a specific post in a topic. ~~On most forums~~, this ~~will also require the topic~~ to ~~be specified. (See below for details; the template will warn you if it needs~~ the ~~topic.)~~		*'''forumname''': if not using a shortcut, and further not using custom display text (second unnamed parameter), this parameter can be used to change the forum portion of the default display text instead of showing the forum's URL domain.
	*'''profile''': used to ~~link to a forum member's profile~~.
	*'''~~forum~~''': ~~used to link to~~ a ~~particular subforum.~~
	*'''news''': used to link to a news post (~~only available on some sites~~).
	*'''announcement''': used to ~~link to a~~ forum ~~announcement (only available on some sites)~~.
	*'''http''': if the site is available on http only (not https), define this parameter (e.g. {{param\|http\|x}}).		*'''http''': if the site is available on http only (not https), define this parameter (e.g. {{param\|http\|x}}).
	*'''numbered''': define this parameter to format the link as a default numbered link (no link text).		*'''numbered''': define this parameter to format the link as a default numbered link (no link text).

Bobogoobo: create

2020-07-16T03:39:28Z

create

New page

{{documentation subpage}}

This template is used to link to any forum on a website, or a specific page in it. Commonly used sites are available as shortcuts; other sites can specify the software used to automate the correct link.

This template makes use of Lua code at [[Module:Forumlink]]. Please use the template rather than invoking the module directly.

==Available parameters==
*first unnamed parameter: either the name of a shortcut (see below) or the website's host name and domain (e.g. npowned.net or forums.example.com).
*second unnamed parameter: the text to display for the link. This will intelligently default to text based on what is linked to.
*'''type''': used to specify the forum software so the template can generate the correct link. Omit this if using a shortcut.
*'''topic''': used to link to a specific topic on the forum.
*'''post''': used to link to a specific post in a topic. On most forums, this will also require the topic to be specified. (See below for details; the template will warn you if it needs the topic.)
*'''profile''': used to link to a forum member's profile.
*'''forum''': used to link to a particular subforum.
*'''news''': used to link to a news post (only available on some sites).
*'''announcement''': used to link to a forum announcement (only available on some sites).
*'''http''': if the site is available on http only (not https), define this parameter (e.g. {{param|http|x}}).
*'''numbered''': define this parameter to format the link as a default numbered link (no link text).

===Shortcuts===
The following shortcuts are currently available. More can be added as needed. They are not case sensitive, but should be uppercase for propriety.

'''Games''':
*NS: {{forumlink|NS}}
*CN: {{forumlink|CN}}

'''Communities''':
*NPO: {{forumlink|NPO}}
*TSP: {{forumlink|TSP}}
*TSPArchive: {{forumlink|TSPArchive}}

===Types===
The following forum types are currently supported. More can be added as needed. They are not case sensitive.

*<code>Invision</code> - Invision Community. Note: on these forums the page ID and slug (hyphenated phrase) are both required. The slug will be used to generate the default link text.
*<code>MyBB</code> - current(?) MyBB with shorter URLs that all end in .html.
*<code>MyBBold</code> - an older version of MyBB with longer .php and query-based URLs.
*<code>phpBB</code> - good ol' phpBB. Note: to link to a topic, you do ''not'' need to include the f=### part of the URL. Also, you can use {{param|post}} on its own, without a topic. (At least on the version used on the NS forums.)

===Notes===
If no named parameter is specified, the template will link to the forum index (homepage).

Other than when "post" is used and requires a topic, parameters for specific pages will take precedence in the order listed above.

==Examples==
*<code><nowiki>{{forumlink|NPO}}</nowiki></code> produces: {{forumlink|NPO}}
*<code><nowiki>{{forumlink|NPO|forum=1-reception-desk}}</nowiki></code> produces: {{forumlink|NPO|forum=1-reception-desk}}
*<code><nowiki>{{forumlink|NPO|forum=1-reception-desk|Apply here}}</nowiki></code> produces: {{forumlink|NPO|forum=1-reception-desk|Apply here}}
*<code><nowiki>{{forumlink|NPO|numbered=x}}</nowiki></code> produces: {{forumlink|NPO|numbered=x}}
*<code><nowiki>{{forumlink|forum.nationstates.net|type=phpbb|NationStates forums}}</nowiki></code> produces: {{forumlink|forum.nationstates.net|type=phpbb|NationStates forums}}

<includeonly>[[Category:External link templates]]</includeonly>