SgWiki:Guidebook/Links: Difference between revisions

From SgWiki
Jump to navigation Jump to search
Supernutorcrazy (talk | contribs)
mNo edit summary
No edit summary
Line 11: Line 11:


<div style='font-family:"Exo 2" !important;'>
<div style='font-family:"Exo 2" !important;'>
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.
Linking articles together is essential. Links allow users to jump to related information quickly, improving article usefulness.


===Internal Link===
===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 "<nowiki>[[</nowiki>" before the link and "<nowiki>]]</nowiki>" after the link.<br>
An internal link directs to a page or section within sgWiki.
{{dottedbox|@=Syntax|#=<nowiki>[[ [article name] # [section name] | [display name] ]]</nowiki>}}


'''Notes:'''<br>
{{dottedbox|@=Syntax|#=<nowiki>[[ [Article Name] # [Section Name] | [Display Name] ]]</nowiki>}}
'''Article Name''' is the article you wish to link to.<br>
* '''Article Name''' is the page you wish to link.  
'''Section Name''' is header links that we had previously explained. (Optional)<br>
* '''Section Name''' is the header within that page (optional).
'''Display Name''' is text that you want to display. The default are article name. (Optional)
* '''Display Name''' is the text shown; defaults to article name (optional).


===External Link===
===External Link===
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>
An external link directs to a website outside sgWiki.
{{dottedbox|@=Syntax|#=<nowiki>[ [website] [display name] ]</nowiki>}}
 
'''Notes:'''<br>
{{dottedbox|@=Syntax|#=<nowiki>[ [Website] [Display Name] ]</nowiki>}}
'''Website''' is the url that you wish to link to.<br>
* '''Website''' is the URL.
'''Display Name''' is the text that you want to display. The default is the url address. (Optional)
* '''Display Name''' is the text shown; defaults to the URL (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 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.
Links add value but must be used carefully.
* Link only at the first occurrence of a word or phrase in an article or section.
* Do not over‑link common words such as "station" or "bus" unless they are keywords central to the article.


===Template===
===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.<br>
Templates standardise information across multiple pages. They are embedded into the final page when displayed.
{{dottedbox|@=Template Syntex|#=<nowiki>{{ [template name] | [parameters] }}</nowiki>}}
 
'''Notes:'''<br>
{{dottedbox|@=Template Syntex|#=<nowiki>{{ [Template Name] | [Parameters] }}</nowiki>}}
'''Template Name''' is the template that you wish to add to.<br>
* '''Template Name''' is the template to use.
'''Parameters''' is the data that will be pass to the template for customisation effects. Separate each parameter with a '|' character. (Optional)
* '''Parameters''' is values passed to customise output. Separate each with " | " (optional).


===Categories===
===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.
Categories group articles by topic. They appear at the bottom of a page.


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>
{{dottedbox|@=Syntax|#=<nowiki>[[Category: [category name] ]]</nowiki>}}
{{dottedbox|@=Syntax|#=<nowiki>[[Category: [category name] ]]</nowiki>}}
 
* '''Category Name''' is the category to add the article to.
'''Notes:'''<br>
* Each category must contain at least two related articles.
'''Category Name''' is the category you wish to add the article to.
 
Please ensure that a category consists of 2 or more related articles.
</div>
</div>

Revision as of 00:18, 8 July 2026

Introductions Editing & Formatting Links Citing sources sgWiki Buses sgWiki Rails Ban & Warning Points

Linking articles together is essential. Links allow users to jump to related information quickly, improving article usefulness.

Internal Link

An internal link directs to a page or section within sgWiki.

Syntax

[[ [Article Name] # [Section Name] | [Display Name] ]]
  • Article Name is the page you wish to link.
  • Section Name is the header within that page (optional).
  • Display Name is the text shown; defaults to article name (optional).

External Link

An external link directs to a website outside sgWiki.

Syntax

[ [Website] [Display Name] ]
  • Website is the URL.
  • Display Name is the text shown; defaults to the URL (optional).

When to link

Links add value but must be used carefully.

  • Link only at the first occurrence of a word or phrase in an article or section.
  • Do not over‑link common words such as "station" or "bus" unless they are keywords central to the article.

Template

Templates standardise information across multiple pages. They are embedded into the final page when displayed.

Template Syntex

{{ [Template Name] | [Parameters] }}
  • Template Name is the template to use.
  • Parameters is values passed to customise output. Separate each with " | " (optional).

Categories

Categories group articles by topic. They appear at the bottom of a page.

Syntax

[[Category: [category name] ]]
  • Category Name is the category to add the article to.
  • Each category must contain at least two related articles.