SgWiki:Guidebook/Links

From SgWiki
< SgWiki:Guidebook
Revision as of 08:22, 7 September 2020 by Supernutorcrazy (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Introductions Editing & Formatting Links Citing sources sgWiki Buses sgWiki Rails 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.