Template:ForumLink/doc View history

Latest revision as of 06:31, 7 June 2016

This is a documentation subpage for Template:ForumLink.
It contains usage information, categories and other content that is not part of the original template page.

This template provides a box displaying a link to the Wiki forum. It is designed to go on the bottom of pages (or top of talk pages) with an expectation of a high number of user questions.

Usage

Place {{ForumLink}} on a page where this message box is desired. The template is designed to automatically decode as many of the parameters as possible, but a few require being named in the template. The default condition with no parameters will send the user to the general forum on Wiki updates.

Any of the following (simplified syntax):

{{ForumLink | search-linktext }}

{{ForumLink | topicid-wikiforum }}

{{ForumLink | link-text | topicid-wikiforum }}

{{ForumLink | forumid=nnn | search-linktext | topicid }}

{{ForumLink | lang=aa | forumid=nnn | linktext | topicid }}

{{ForumLink | forum=url }}

{{ForumLink | forum=url | linktext}}

Parameters

forum

Optional parameter. The value is a URL to the Waze forum topic thread that covers a discussion of the wiki page that uses this template.

forumid

Optional parameter. If the target Waze forum is not the Wiki forum, the forumid value can be entered. This also requires a |topicid= value.

text

Optional parameter. If the target is using the |forum= or |topicid= parameters, this will modify the link text. otherwise this will used as a forum search query text.

section

Optional parameter. If |section=yes is used it will the displayed text from saying "this page", to say "this section" instead.

community

Optional parameter. If |community=USA (or other community name after being built into the template) is used, the link generated when a forumid or full URL is not specified will point to the local wiki forum for that specific community.

Examples

{{ForumLink|forum=http://www.waze.com/forum/viewtopic.php?f=276&t=98195}}

will generate the following:

Bring up comments or questions on this page in this forum

.

{{ForumLink}}

will generate the following:

Comments or questions on any Wiki page can be brought up in the Wiki updates forum topic.

{{ForumLink|New Page - WME Chat|89344}}</wikilink>

generates:

You can bring up comments or questions about this in

New Page - WME Chat forum topic.

{{ForumLink|Go to the first topic in New Jersey's forum, guys!|forumid=249}}

generates:

You can bring up comments or questions about this in

Go to the first topic in New Jersey's forum, guys! forum topic.

Category added

No category is added to pages with this template.

@@ Line 1: / Line 1: @@
-This template provides a box displaying a link to a forum. It is designed to go on the bottom of pages (or top of talk pages) with an expectation of a high number of user questions.
+{{doc subpage}}
+This template provides a box displaying a link to the Wiki forum. It is designed to go on the bottom of pages (or top of talk pages) with an expectation of a high number of user questions.
 == Usage ==
-Place {{tl|ForumLink}} on a page where this message box is desired. Generally an editor will include a specific forum link passed as a parameter, but it will also work without that parameter and send the user to the [http://www.waze.com/forum/viewforum.php?f=276 general forum on Wiki updates].
+Place {{tl|ForumLink}} on a page where this message box is desired. The template is designed to automatically decode as many of the parameters as possible, but a few require being named in the template. The default condition with no parameters will send the user to the [http://www.waze.com/forum/viewforum.php?f=276 general forum on Wiki updates].
+Any of the following (simplified syntax):
 <pre>
-{{ForumLink
+{{ForumLink | search-linktext }}
-| forum  = URL of the forum link; do not include the "s" of "https:"
-}}
+{{ForumLink | topicid-wikiforum }}
+{{ForumLink | link-text | topicid-wikiforum }}
+{{ForumLink | forumid=nnn | search-linktext | topicid }}
+{{ForumLink | lang=aa | forumid=nnn | linktext | topicid }}
+{{ForumLink | forum=url }}
+{{ForumLink | forum=url | linktext}}
 </pre>
@@ Line 13: / Line 26: @@
 '''forum'''
-:Optional parameter with the link to the specific forum thread that covers the topic of the page on which the template is added.
+:Optional parameter. The value is a URL to the Waze forum topic thread that covers a discussion of the wiki page that uses this template.
+'''forumid'''
+:Optional parameter. If the target Waze forum is not the Wiki forum, the forumid value can be entered. This also requires a {{para|topicid}} value.
+'''text'''
+:Optional parameter. If the target is using the {{para|forum}} or {{para|topicid}} parameters, this will modify the link text. otherwise this will used as a forum search query text.
+'''section'''
+:Optional parameter. If {{para|section|yes}} is used it will the displayed text from saying "this page", to say "this section" instead.
+'''community'''
+:Optional parameter. If {{para|community|USA}} (or other community name after being built into the template) is used, the link generated when a forumid or full URL is not specified will point to the local wiki forum for that specific community.
 == Examples ==
-<pre>{{ForumLink|forum=http://www.waze.com/forum/viewforum.php?f=276}}</pre> will generate the following:
+{{pre2|<nowiki>{{ForumLink|forum=http://www.waze.com/forum/viewtopic.php?f=276&t=98195}}</nowiki>}} will generate the following:
-{{ForumLink|forum=http://www.waze.com/forum/viewforum.php?f=276}}
+{{ForumLink|forum=http://www.waze.com/forum/viewtopic.php?f=276&t=98195}}
 <pre>{{ForumLink}}</pre> will generate the following:
 {{ForumLink}}
+{{pre2|<nowiki>{{ForumLink|New Page - WME Chat|89344}}</wikilink></nowiki>}} generates:
+{{ForumLink|New Page - WME Chat|89344}}
+{{pre2|<nowiki>{{ForumLink|Go to the first topic in New Jersey's forum, guys!|forumid=249}}</nowiki>}} generates:
+{{ForumLink|Go to the first topic in New Jersey's forum, guys!|69883|forumid=249}}
 == Category added ==
@@ Line 31: / Line 62: @@
 <includeonly>
 <!-- ADD CATEGORIES BELOW THIS LINE -->
-[[Category:Mbox Templates]]
+[[Category:Mbox templates]]
 <!-- ADD INTERWIKIS BELOW THIS LINE -->
 </includeonly>

Search