Help:Link: Difference between revisions

57 bytes removed ,  15 November 2024
m
Text replacement - "Saintapedia" to "USApedia"
m (Text replacement - "Saintapedia" to "USApedia")
m (Text replacement - "Saintapedia" to "USApedia")
 
Line 2: Line 2:
{{TOC right|clear=right|limit=3}}{{Clear left}}
{{TOC right|clear=right|limit=3}}{{Clear left}}
{{Help Box}}
{{Help Box}}
'''Linking''' (making [[hyperlink]]s) is an key aspect of [[USApedia]], especially links other Saintapedia pages. Those internal links bind the project together into an interconnected whole. Appropriate links provide instant pathways to locations within and outside the project that are likely to increase readers' understanding of the topic at hand. When writing or editing an article, it is important to consider not only what to put in the article, but what links to include to help the reader find related information, as well as which other pages should carry links ''to'' the article. Care should be taken to avoid both [[#Underlinking|underlinking]] and [[#Overlinking|overlinking]].  {{Comment|{{#lst:Help:Link|linking}}}}<section begin="linking" /><section end="linking" />This page provides guidelines as to when links should and should not be used, and how to format links, as well as detailed information about the syntax used to create links.  When adding links, there are differents methods depending on the [[Saintapedia editor]] that you use.
'''Linking''' (making [[hyperlink]]s) is an key aspect of [[USApedia]], especially links other USApedia pages. Those internal links bind the project together into an interconnected whole. Appropriate links provide instant pathways to locations within and outside the project that are likely to increase readers' understanding of the topic at hand. When writing or editing an article, it is important to consider not only what to put in the article, but what links to include to help the reader find related information, as well as which other pages should carry links ''to'' the article. Care should be taken to avoid both [[#Underlinking|underlinking]] and [[#Overlinking|overlinking]].  {{Comment|{{#lst:Help:Link|linking}}}}<section begin="linking" /><section end="linking" />This page provides guidelines as to when links should and should not be used, and how to format links, as well as detailed information about the syntax used to create links.  When adding links, there are differents methods depending on the [[USApedia editor]] that you use.
* See [[#New editor]] for information about using [[VisualEditor]]
* See [[#New editor]] for information about using [[VisualEditor]]
* The [[enhanced editor]] makes adding a link even easier.  See the [[#Insert link feature|insert link feature]] section below for more details.
* The [[enhanced editor]] makes adding a link even easier.  See the [[#Insert link feature|insert link feature]] section below for more details.
Line 8: Line 8:


==Types of links==
==Types of links==
* [[Help:Link#Internal links|Internal links]] lead to other Saintapedia pages.
* [[Help:Link#Internal links|Internal links]] lead to other USApedia pages.
* [[Help:Link#External links|External links]] can lead to any website or other web resource with a URL.
* [[Help:Link#External links|External links]] can lead to any website or other web resource with a URL.
* [[Help:Link#File links|File links]] allow you to link to files uploaded to [[file pages]].
* [[Help:Link#File links|File links]] allow you to link to files uploaded to [[file pages]].
* [[Help:Link#Email links|Email links]] open a new email message to the email address.
* [[Help:Link#Email links|Email links]] open a new email message to the email address.
* [[Help:Link#Links to categories|Category links]] lead to Saintapedia [[Help:Category|categories]], which group related pages and files together.
* [[Help:Link#Links to categories|Category links]] lead to USApedia [[Help:Category|categories]], which group related pages and files together.
* [[Help:Link#Template links|Template links]] are used to display a template name as a link surrounded by braces.
* [[Help:Link#Template links|Template links]] are used to display a template name as a link surrounded by braces.
* [[Help:Link#Reference links|Reference links]] cite the [[Help:Reference|sources]] of information (like footnotes in a book).
* [[Help:Link#Reference links|Reference links]] cite the [[Help:Reference|sources]] of information (like footnotes in a book).
Line 19: Line 19:


== Principles ==
== Principles ==
Saintapedia is based on hypertext, and aims to "build the web" to enable readers to easily access relevant information on other pages. The page from which the hyperlink is activated is called the anchor; the page the link points to is called the target.
USApedia is based on hypertext, and aims to "build the web" to enable readers to easily access relevant information on other pages. The page from which the hyperlink is activated is called the anchor; the page the link points to is called the target.


In adding or removing links, consider an article's place in the {{W|tree structure|knowledge tree}}. Internal links can add to the cohesion and utility of Saintapedia, allowing readers to deepen their understanding of a topic by conveniently accessing other articles. Ask yourself, ''"How likely is it that the reader will also want to read that other article?"'' Consider including links where readers might want to use them; for example, in article leads, the openings of new sections, [[Help:table|table]] cells, and [[image caption]]s. As a rule of thumb, only the first occurrence of a term should be linked.
In adding or removing links, consider an article's place in the {{W|tree structure|knowledge tree}}. Internal links can add to the cohesion and utility of USApedia, allowing readers to deepen their understanding of a topic by conveniently accessing other articles. Ask yourself, ''"How likely is it that the reader will also want to read that other article?"'' Consider including links where readers might want to use them; for example, in article leads, the openings of new sections, [[Help:table|table]] cells, and [[image caption]]s. As a rule of thumb, only the first occurrence of a term should be linked.


=== General points on linking style ===
=== General points on linking style ===
Line 73: Line 73:


==Internal links==
==Internal links==
'''Internal links''' create links to other Saintapedia pages. Internal links are an essential means to connect related information in Saintapedia together (see [[Wikify]]).  
'''Internal links''' create links to other USApedia pages. Internal links are an essential means to connect related information in USApedia together (see [[Wikify]]).  


The easiest way to learn when to link is to look at Saintapedia articles for examples. If you're trying to decide whether to make a link or not, think: ''"If someone unfamiliar with the subject was reading the article, would a link to more information on a noun help them better understand the article?"''
The easiest way to learn when to link is to look at USApedia articles for examples. If you're trying to decide whether to make a link or not, think: ''"If someone unfamiliar with the subject was reading the article, would a link to more information on a noun help them better understand the article?"''


[[Lead section]]s often have more links than other sections of articles.
[[Lead section]]s often have more links than other sections of articles.
Line 89: Line 89:
=== Redirects ===
=== Redirects ===
{{main|Help:Redirect}}  
{{main|Help:Redirect}}  
Let's assume for example you needed a link "poodle", and there was no article for poodles yet. You might want to create a redirect from "poodle" to "dog" as follows: Write the link in the text as if the "poodle" article existed: {{code|She owned a [<nowiki/>[poodle]]}}. When you save or preview this, you will see: {{xt|She owned a {{red link|poodle}}}}. You would then click on the red link to create the redirect page, enter the target article name (in our case, {{xt|Dog}}), select that text, and click the [[File:Saintapedia advanced toolbar redirect icon.png|25x25px]] button. This would create the following text: {{code|#redirect [<nowiki/>[Dog]]}}.  
Let's assume for example you needed a link "poodle", and there was no article for poodles yet. You might want to create a redirect from "poodle" to "dog" as follows: Write the link in the text as if the "poodle" article existed: {{code|She owned a [<nowiki/>[poodle]]}}. When you save or preview this, you will see: {{xt|She owned a {{red link|poodle}}}}. You would then click on the red link to create the redirect page, enter the target article name (in our case, {{xt|Dog}}), select that text, and click the [[File:USApedia advanced toolbar redirect icon.png|25x25px]] button. This would create the following text: {{code|#redirect [<nowiki/>[Dog]]}}.  


The advantage of redirects over [[#Piped links|piped links]] is that they allow us to determine which pages link to the given topic using [[Special:Whatlinkshere]], which in turn allows us to
The advantage of redirects over [[#Piped links|piped links]] is that they allow us to determine which pages link to the given topic using [[Special:Whatlinkshere]], which in turn allows us to
Line 101: Line 101:


* '''Plurals and other derived names.''' When a link is plural but the article name is singular, rather than a piped link, you can put the final "s" outside the {{code|<nowiki>]]</nowiki>}}: {{code|<nowiki>[[conference room]]s</nowiki>}} results in {{xt|[[conference room]]s}}, which is easier to type and clearer to read in the source text than {{code|<nowiki>[[conference room|conference rooms]]</nowiki>}}. This works not just for "s", but for any words that consist of an article name and some additional letters.  
* '''Plurals and other derived names.''' When a link is plural but the article name is singular, rather than a piped link, you can put the final "s" outside the {{code|<nowiki>]]</nowiki>}}: {{code|<nowiki>[[conference room]]s</nowiki>}} results in {{xt|[[conference room]]s}}, which is easier to type and clearer to read in the source text than {{code|<nowiki>[[conference room|conference rooms]]</nowiki>}}. This works not just for "s", but for any words that consist of an article name and some additional letters.  
* '''Case sensitivity.''' The capitalization of the first letter in a link doesn't matter, so there is no need to use piping where the only difference between the text and the target is the case of the initial letter (Saintapedia article titles almost always begin with a capital, whereas the linked words in context often do not). However, links are case-sensitive for all but the initial character.
* '''Case sensitivity.''' The capitalization of the first letter in a link doesn't matter, so there is no need to use piping where the only difference between the text and the target is the case of the initial letter (USApedia article titles almost always begin with a capital, whereas the linked words in context often do not). However, links are case-sensitive for all but the initial character.
* {{anchor|Egg}}'''Intuitiveness.''' Keep piped links as intuitive as possible. Per the {{w|principle of least astonishment}}, make sure that the reader knows what to expect when clicking on a link. Example: if you use a link such as {{code|<nowiki>[[Archery at the 2008 Summer Olympics|archery]]</nowiki>}} (which displays as {{xt|[[Archery at the 2008 Summer Olympics|Archery]]}}), a reader would expect the link to go to a general article on archery, rather than {{xt|[[Archery at the 2008 Summer Olympics]]}}. You should plan your page structure and links so that everything appears reasonable and makes sense. If a link takes readers to somewhere other than where they thought it would, it should at least take them somewhere that makes sense.  
* {{anchor|Egg}}'''Intuitiveness.''' Keep piped links as intuitive as possible. Per the {{w|principle of least astonishment}}, make sure that the reader knows what to expect when clicking on a link. Example: if you use a link such as {{code|<nowiki>[[Archery at the 2008 Summer Olympics|archery]]</nowiki>}} (which displays as {{xt|[[Archery at the 2008 Summer Olympics|Archery]]}}), a reader would expect the link to go to a general article on archery, rather than {{xt|[[Archery at the 2008 Summer Olympics]]}}. You should plan your page structure and links so that everything appears reasonable and makes sense. If a link takes readers to somewhere other than where they thought it would, it should at least take them somewhere that makes sense.  


Line 108: Line 108:


===Links to categories===
===Links to categories===
Saintapedia has categories of articles like {{code|[<nowiki/>[Category:Portraits]]}}; adding this to an article puts it into that category. You can link to a category without putting the article into the category by putting a colon in front.
USApedia has categories of articles like {{code|[<nowiki/>[Category:Portraits]]}}; adding this to an article puts it into that category. You can link to a category without putting the article into the category by putting a colon in front.


For example {{code|[<nowiki/>[:Category:Portraits]]}} links to [[:Category:Portraits]], and piping can be used: {{code|<nowiki>[[:Category:Portraits|portraits]]</nowiki>}} results in [[:Category:Portraits|portraits]].
For example {{code|[<nowiki/>[:Category:Portraits]]}} links to [[:Category:Portraits]], and piping can be used: {{code|<nowiki>[[:Category:Portraits|portraits]]</nowiki>}} results in [[:Category:Portraits|portraits]].
Line 135: Line 135:
One of the most common errors in linking occurs when editors do not check to see whether a link they have created goes to the intended location. The text of links needs to be exact. To avoid such problems, it is a good practice to test links in the preview window prior to saving changes.
One of the most common errors in linking occurs when editors do not check to see whether a link they have created goes to the intended location. The text of links needs to be exact. To avoid such problems, it is a good practice to test links in the preview window prior to saving changes.


By following [[Saintapedia:Naming conventions|naming conventions]], an internal link will be much more likely to lead to an existing article. When there is not yet an article about the subject, a good link will make the creation of a correctly named article much easier for subsequent writers.
By following [[USApedia:Naming conventions|naming conventions]], an internal link will be much more likely to lead to an existing article. When there is not yet an article about the subject, a good link will make the creation of a correctly named article much easier for subsequent writers.


==Interwiki links==
==Interwiki links==
Line 145: Line 145:


==External links==
==External links==
'''External links''' are links to websites outside of Saintapedia, and can take several forms:  
'''External links''' are links to websites outside of USApedia, and can take several forms:  
* Raw link - {{code|http<nowiki/>://www.google.com}} results in {{xt|http://www.google.com}}.
* Raw link - {{code|http<nowiki/>://www.google.com}} results in {{xt|http://www.google.com}}.
* Numbered links - {{code|[http<nowiki/>://www.bing.com]}} gives you {{xt|[http://www.bing.com]}}
* Numbered links - {{code|[http<nowiki/>://www.bing.com]}} gives you {{xt|[http://www.bing.com]}}
Line 169: Line 169:
* #filelinks - File usage
* #filelinks - File usage


For more information about displaying images on Saintapedia articles see [[Help:Images]].  See the [[Help:Images#Link]] section if you wish to link an image.
For more information about displaying images on USApedia articles see [[Help:Images]].  See the [[Help:Images#Link]] section if you wish to link an image.


== Template links ==
== Template links ==
Line 206: Line 206:
To link to the File history section use <nowiki>#filehistory</nowiki>.  Remember to add ":" in front of files, especially images, so the wiki knows to link to the file page and not display the image instead.
To link to the File history section use <nowiki>#filehistory</nowiki>.  Remember to add ":" in front of files, especially images, so the wiki knows to link to the file page and not display the image instead.


For example [[:File:Saintapedia test.pdf#filehistory]] will be entered as <nowiki>[[:File:Saintapedia test.pdf#filehistory]]</nowiki>.
For example [[:File:USApedia test.pdf#filehistory]] will be entered as <nowiki>[[:File:USApedia test.pdf#filehistory]]</nowiki>.


The same apples to the File links section (<nowiki>#filelinks</nowiki>) and Meta data (<nowiki>#metadata</nowiki>).
The same apples to the File links section (<nowiki>#filelinks</nowiki>) and Meta data (<nowiki>#metadata</nowiki>).
Line 219: Line 219:
{{reflist}}
{{reflist}}


{{Saintapedia}}
{{USApedia}}
{{Purge button}}
{{Purge button}}


[[Category:Help]]
[[Category:Help]]
[[Category:Saintapedia]]
[[Category:USApedia]]