Difference between revisions of "Thread/doc"

Revision as of 08:17, 21 June 2021

Documentation Sub-page for Template:Thread

Scope of Use

Purpose

This template creates a direct link to a specific thread in the RR forums area

Directly Invoked By

Any time a discussion can be linked to a topic for better clarity and to provide a place for discussion
The wiki talk pages should not be used for this purpose, as not everyone is aware that they exist

Parameters

There are 3 parameters, two of which are pulled directly from the URL of the discussion thread

The name of the forum
The message number and identifier
You can then supply a more meaningful English name for the thread. You should use the actual name of the thread here

Examples

The horizontal lines below separate examples for clarity and do not appear when template is invoked.

How to invoke this template

If you wish to point to this thread using this template, follow the steps outlined below

https://forums.radioreference.com/threads/sds200-hum-reports.383938/

Note: Each parameter for the template is separated by a pipe symbol (|). This can be found as the shift of the backslash character ( \ )

First, type 2 curly brackets ( {{ }. This is the shift of the left square bracket ( [ ). Then insert the name of the template.
Next, the forum name is required. If you are using a thread in a sub-forum, use the highest level (the parent) for that forum. The thread above comes from the Tech Support sub forum of the Uniden Scanners forum, so we must use that forum's identifier. Thus the forum name is shown below, along with a numeric identifier

https://forums.radioreference.com/forums/uniden-forums.82/

The last token of the URL has the data required for the next portion.
- Take the number found at the very end of the URL and place it in front, followed with a dash.
- Take the rest of the token and place it after the dash you just entered
- Put the identifier '.html' at the very end.
The last part of the template is a free forum area for a description. Note that the template will hard code 'Thread' at the very end.
Terminate it with 2 curly brackets ( }} ). This is the shift of the right square bracket ( ] ).

{{Thread|uniden-scanners|383938-sds200-hum-reports.html|SDS200 Hum Reports}}

Result

SDS200 Hum Reports Thread

Return to: Template:Thread

@@ Line 20: / Line 20: @@
 *The horizontal lines below separate examples for clarity and do not appear when template is invoked.
 ----
+====How to invoke this template====
+If you wish to point to this thread using this template, follow the steps outlined below
 <nowiki>
-*{{Thread|uniden-scanners|383938-sds200-hum-reports.html|SDS200 Hum Reports}}
+https://forums.radioreference.com/threads/sds200-hum-reports.383938/
 </nowiki>
-----
-This was derived from the following URL;
+'''Note:''' Each parameter for the template is separated by a pipe symbol (|). This can be found as the shift of the backslash character ( \ )
+* First, type 2 curly brackets ( {{ }.  This is the shift of the left square bracket ( [ ). Then insert the name of the template.
+* Next, the forum name is required. If you are using a thread in a sub-forum, use the highest level (the parent) for that forum. The thread above comes from the Tech Support sub forum of the Uniden Scanners forum, so we must use that forum's identifier. Thus the forum name is shown below, along with a numeric identifier
 <nowiki>
-https://forums.radioreference.com/threads/sds200-hum-reports.383938/
+https://forums.radioreference.com/forums/uniden-forums.82/
 </nowiki>
-====How to invoke this template====
+* The last token of the URL has the data required for the next portion.
-In the above example, each parameter for the template is separated by a pipe symbol (|).
+**Take the number found at the very end of the URL and place it in front, followed with a dash.
-* First, the name of the template
+**Take the rest of the token and place it after the dash you just entered
-* Next, the forum name is required. As it is no longer shown on the URL, you must get it from the forums display area. Note that if you are using a thread in a sub-forum, use the highest level (the parent) for that forum. The thread above comes from the Tech Support section of the Uniden Scanners forum.
-* The last token of the URL has the data required for the next portion. Follow these steps to reformat it;
-**Take the number at the very end and place it in front, followed with a dash.
 **Put the identifier <nowiki>'.html'</nowiki> at the very end.
-* The last part of the template is a free forum area for a description. Note that the template will hard code <nowiki>'Thread'</nowiki> at the very end.
+*The last part of the template is a free forum area for a description. Note that the template will hard code <nowiki>'Thread'</nowiki> at the very end.
+*Terminate it with 2 curly brackets ( }} ).  This is the shift of the right square bracket ( ] ).
+<nowiki>
+{{Thread|uniden-scanners|383938-sds200-hum-reports.html|SDS200 Hum Reports}}
+</nowiki>
 ====Result====
 *{{Thread|uniden-scanners|383938-sds200-hum-reports.html|SDS200 Hum Reports}}

Template