Template:Forum link/doc
This is a documentation subpage for Template:Forum link. It contains usage information, categories and other content that is not part of the original template page. |
This template simplifies links to Financial Wisdom Forum (FWF) topics or posts in a wiki article. The template is preferable to normal external links because:
- It gives a consistent format for links to the Financial Wisdom Forum
- If the forum URL changes, the template can change to match
These FWF links can be used in either citations or by our wiki convention in the Further reading section.
Placing an FWF link within an article is generally not recommended per Wikipedia's guidance to avoid embedded links.
Usage
{{forum link|t= |p= |title= |date= |author= |quote= }}
.
Parameters are:
- t: The topic ID. Each topic has a unique identifier. This is the numeric value in the URL after the
t=
. Generally, you should link to the topic unless you want to specify a specific reply further down into the topic, in which case you can provide the post ID (p) parameter value. - p: The post ID. Each post within a topic has a unique identifier which is obtained by clicking on the post's title. This is the link in the top-left corner of every post. It is the numeric value in the URL after the
p=
. - title: The link text to display. Typically this will be the discussion topic title.
- date: (optional) The date of the topic or post. Please add the date, as many financial topics are date sensitive and the reader may wish to know if the post is many years old. Suggested format is
(D)D Month YYYY
(for example 7 July 2012) but any format will be output as entered. - author: (optional). The author of the topic or post.
- quote: (optional). Any relevant quote from the topic or post. Do not include quotation marks as these are included automatically.
Use only the topic ID or post ID, but not both. Link to the topic when you want to emphasize the overall topics. Link to the post when you want to focus on a particular reply within the overall topic.
Examples
To create a link to forum topic https://www.financialwisdomforum.org/forum/viewtopic.php?f=8&t=13
, the topic_id is 13. Therefore to use this template, you would code as follows:
{{forum link|t=13|title=Introduce Yourself}}
Results in:
- Financial Wisdom Forum topic: "Introduce Yourself"
To create a link to forum post https://www.financialwisdomforum.org/forum/viewtopic.php?p=526308#p526308
, the post_id is p526308. Therefore to use this template, you would code as follows:
{{forum link|p=526308|title=Introduce Yourself, Norbert Schlenker}}
Results in:
- Financial Wisdom Forum post: "Introduce Yourself, Norbert Schlenker"
Ideally, include the date of the original topic if you use the t parameter, or of the specific post if you use the p parameter. For example:
{{forum link|p=526308|title=Introduce Yourself, Norbert Schlenker|date=29 May 2014}}
Results in:
- Financial Wisdom Forum post: "Introduce Yourself, Norbert Schlenker". 29 May 2014
In most cases, you'll link to a forum post using the reference <ref></ref>
tags. For example:
I look forward to your contributions.<ref>{{forum link|p=526308|title=Introduce Yourself, Norbert Schlenker|date=29 May 2014}}</ref>
The wiki text above results in the following, with a footnote after the sentence with the footnote reference in the bottom of the page in the References section:
- I look forward to your contributions.[1]
To use the author and quote parameters:
I look forward to your contributions.<ref>{{forum link|p=526308|title=Introduce Yourself|author= Norbert Schlenker|date=29 May 2014 | quote=The forum is about making money, certainly, but not about making money off the backs of our fellow members by charging them or distracting them with shiny things. We began with that philosophy 9 1/2 years ago and it is baked in.}}</ref>
The wiki text above results in the following, with a footnote after the sentence with the footnote reference in the bottom of the page in the References section:
- I look forward to your contributions.[2]
References
- ^ Financial Wisdom Forum post: "Introduce Yourself, Norbert Schlenker". 29 May 2014
- ^ Financial Wisdom Forum post: "Introduce Yourself", Norbert Schlenker. 29 May 2014. "The forum is about making money, certainly, but not about making money off the backs of our fellow members by charging them or distracting them with shiny things. We began with that philosophy 9 1/2 years ago and it is baked in."
TemplateData
TemplateData for Forum link
Simplifies links to Financial Wisdom Forum (FWF) topics or posts in an article.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Topic ID | t | Each topic has a unique identifier. This is the numeric value in the URL after the t=. Generally, you should link to the topic unless you want to specify a specific reply further down into the topic, in which case you can provide the post ID (p) parameter value. | Number | suggested |
Title | title | The link text to display. Typically this will be the discussion topic title. | String | required |
Post ID | p | Each post within a topic has a unique identifier which is obtained by clicking on the post's title. This is the link in the top-left corner of every post. It is the numeric value in the URL after the p= | Number | optional |
Author | author | (optional). The author of the topic or post. | String | optional |
Date | date | (optional) The date of the topic or post. Please add the date, as many financial topics are date sensitive and the reader may wish to know if the post is many years old. Suggested format is (D)D Month YYYY (for example 7 July 2012) but any format will be output as entered. | String | optional |
Quote | quote | (optional). Any relevant quote from the topic or post. Do not include quotation marks as these are included automatically. | String | optional |