Difference between revisions of "SgWiki:Guidebook/Links"

From SgWiki
Jump to navigation Jump to search
m
Line 27: Line 27:


===External Link===
===External Link===
An External Link refers to a link that directs to another website not within sgWiki. To add an External Link, simply add "<nowiki>[</nowiki>" before the link and "<nowiki>]</nowiki>" after the link.<br>
An External Link refers to a link that directs to another website outside sgWiki. To add an External Link, simply add "<nowiki>[</nowiki>" before the link and "<nowiki>]</nowiki>" after the link.<br>
{{dottedbox|@=Syntax|#=<nowiki>[ [website] [display name] ]</nowiki>}}
{{dottedbox|@=Syntax|#=<nowiki>[ [website] [display name] ]</nowiki>}}
'''Notes:'''<br>
'''Notes:'''<br>
'''Website''' is the url that you wish to link to.<br>
'''Website''' is the url that you wish to link to.<br>
'''Display Name''' is the text that you want to display. The default are the url address. (Optional)
'''Display Name''' is the text that you want to display. The default is the url address. (Optional)


===When to link===
===When to link===
Adding links to an article makes it more useful, but too many links can be distracting. To avoid over-linking, you should normally create a link in an article only at the first occurrence of a word or phrase within an article or a section. You should not link common words such as "station" and "bus", even when sgWiki has articles for those words, unless these are words that are keywords in the article.
Adding links to an article makes it more useful, but too many links can be distracting. To avoid over-linking, you should create a link in an article only at the first occurrence of a word or phrase within an article or a section. You should not link common words such as "station" and "bus", even if sgWiki has articles for those words; unless those are keywords in the article.


===Template===
===Template===
Using Templates helps to synchronize information across multiple page easier. It does not reduce page size as the template will be embedded into the final page before displaying to you. The page size that shrink was only indicative of the page size stored into the server and not through your screen.<br>
Using Templates help to synchronise information across multiple pages easily. It does not reduce page size as the template will be embedded into the final page before it is displayed to you. The page size that shrinks is only indicative of the page size stored into the server and not through your screen.<br>
{{dottedbox|@=Template Syntex|#=<nowiki>{{ [template name] | [parameters] }}</nowiki>}}
{{dottedbox|@=Template Syntex|#=<nowiki>{{ [template name] | [parameters] }}</nowiki>}}
'''Notes:'''<br>
'''Notes:'''<br>
'''Template Name''' is the template that you wish to add to.<br>
'''Template Name''' is the template that you wish to add to.<br>
'''Parameters''' is the data that will be pass to the template for customization effects. Separate each parameters with a '|' character. (Optional)
'''Parameters''' is the data that will be pass to the template for customisation effects. Separate each parameter with a '|' character. (Optional)


===Categories===
===Categories===
Categories are useful if you wish to group a article with others in a related topic. Categories are found at the bottom of the article.
Categories are useful if you wish to group an article with other articles to a related topic. Categories are found at the bottom of the article.


To add a category, simply add "<nowiki>[[Category:</nowiki>" before the name of the category and "<nowiki>]]</nowiki>" after the name of the category at the bottom of the article.<br>
To add a category, simply add "<nowiki>[[Category:</nowiki>" before the name of the category and "<nowiki>]]</nowiki>" after the name of the category at the bottom of the article.<br>
Line 50: Line 50:


'''Notes:'''<br>
'''Notes:'''<br>
'''Category Name''' is the category you wish the article to belong to.
'''Category Name''' is the category you wish to add the article to.


Please ensure that a category must consist of 2 or more related articles.
Please ensure that a category consists of 2 or more related articles.
|}
|}

Revision as of 14:06, 26 December 2019

Introductions Editing & Formatting Links Citing sources sgWiki Buses sgWiki Trains Ban & Warning Points
Linking articles together is very important. These easily created links allow users to jump to information related to the article they are reading, greatly adding to an article usefulness.

Internal Link

An Internal Link refers to a link that directs to a page or a section within sgWiki. To add an Internal Link, simply add "[[" before the link and "]]" after the link.
Syntax

[[ [article name] # [section name] | [display name] ]]

Notes:
Article Name is the article you wish to link to.
Section Name is header links that we had previously explained. (Optional)
Display Name is text that you want to display. The default are article name. (Optional)

External Link

An External Link refers to a link that directs to another website outside sgWiki. To add an External Link, simply add "[" before the link and "]" after the link.
Syntax

[ [website] [display name] ]

Notes:
Website is the url that you wish to link to.
Display Name is the text that you want to display. The default is the url address. (Optional)

When to link

Adding links to an article makes it more useful, but too many links can be distracting. To avoid over-linking, you should create a link in an article only at the first occurrence of a word or phrase within an article or a section. You should not link common words such as "station" and "bus", even if sgWiki has articles for those words; unless those are keywords in the article.

Template

Using Templates help to synchronise information across multiple pages easily. It does not reduce page size as the template will be embedded into the final page before it is displayed to you. The page size that shrinks is only indicative of the page size stored into the server and not through your screen.
Template Syntex

{{ [template name] | [parameters] }}

Notes:
Template Name is the template that you wish to add to.
Parameters is the data that will be pass to the template for customisation effects. Separate each parameter with a '|' character. (Optional)

Categories

Categories are useful if you wish to group an article with other articles to a related topic. Categories are found at the bottom of the article.

To add a category, simply add "[[Category:" before the name of the category and "]]" after the name of the category at the bottom of the article.
Syntax

[[Category: [category name] ]]

Notes:
Category Name is the category you wish to add the article to.

Please ensure that a category consists of 2 or more related articles.