Difference between revisions of "SgWiki:Guidebook/Links"
m |
m |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{| style= | {| style='font-family:"Exo 2";width:100%;border-collapse:collapse;white-space:nowrap;' | ||
| | |style="padding:0 0.5em;border-bottom:1px solid #888;"|[[SgWiki:Guidebook|Introductions]] | ||
|style="padding:0 0.5em;border-bottom:1px solid #888;"|[[SgWiki:Guidebook/Editing & Formatting|Editing & Formatting]] | |||
|style="padding:0 0.5em;border:1px solid #888;border-top:3px solid #F00;border-bottom:none;"|[[SgWiki:Guidebook/Links|Links]] | |||
|style="padding:0 0.5em;border-bottom:1px solid #888;"|[[SgWiki:Guidebook/Citation|Citing sources]] | |||
|style="padding:0 0.5em;border-bottom:1px solid #888;"|[[SgWiki:Guidebook/sgWiki Buses|sgWiki Buses]] | |||
|style="padding:0 0.5em;border-bottom:1px solid #888;"|[[SgWiki:Guidebook/sgWiki Rails|sgWiki Rails]] | |||
|style="padding:0 0.5em;border-bottom:1px solid #888;"|[[SgWiki:Guidebook/Ban|Ban & Warning Points]] | |||
|style="width:100%;border-bottom:1px solid #888;"| | |||
|} | |||
<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. | |||
|style=" | |||
===Internal Link=== | ===Internal Link=== | ||
An Internal Link refers to a link that | 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> | ||
{{dottedbox|@=Syntax|#=<nowiki>[[ [article name] # [section name] | [display name] ]]</nowiki>}} | {{dottedbox|@=Syntax|#=<nowiki>[[ [article name] # [section name] | [display name] ]]</nowiki>}} | ||
'''Notes:'''<br> | '''Notes:'''<br> | ||
'''Article Name''' | '''Article Name''' is the article you wish to link to.<br> | ||
'''Section Name''' | '''Section Name''' is header links that we had previously explained. (Optional)<br> | ||
'''Display Name''' | '''Display Name''' is text that you want to display. The default are article name. (Optional) | ||
===External Link=== | ===External Link=== | ||
An External Link refers to a link that | 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] | {{dottedbox|@=Syntax|#=<nowiki>[ [website] [display name] ]</nowiki>}} | ||
'''Notes:'''<br> | '''Notes:'''<br> | ||
'''Website''' | '''Website''' is the url that you wish to link to.<br> | ||
'''Display Name''' | '''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 | 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.<br> | |||
{{dottedbox|@=Template Syntex|#=<nowiki>{{ [template name] | [parameters] }}</nowiki>}} | |||
'''Notes:'''<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 customisation effects. Separate each parameter with a '|' character. (Optional) | |||
===Categories=== | ===Categories=== | ||
Categories are useful if you wish to group | 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 43: | Line 46: | ||
'''Notes:'''<br> | '''Notes:'''<br> | ||
'''Category Name''' | '''Category Name''' is the category you wish to add the article to. | ||
Please ensure that a category | Please ensure that a category consists of 2 or more related articles. | ||
</div> | |||
Latest revision as of 08:22, 7 September 2020
| 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.