Difference between revisions of "Help:Links"

Revision as of 15:05, 3 July 2007

Creating links to other pages is a key part of creating a complete and well-formatted wiki page. A well-linked page permits readers to easily access other topics that they may be interested in learning more about, and encourages readers to continue to explore the site.

General Information

Links are a vital part of the wiki, and are strongly encouraged on all pages in order to refer the reader to other relevant pages (and prevent unnecessary duplication). However, it is also possible to go overboard with links. In general, a link should only be added the first time a topic is mentioned on a page, rather than every time the topic is mentioned.

When creating links on a page, you may want to also check what links to that page. In general, if there is enough overlap for page A to link to page B, then page B should probably also have a link to page A. On the left side of any page, in the toolbox, you can use "What Links Here" to see which pages link to that page. This is one way to check whether a page is fully cross-linked. If you're creating a new page, this is the best way to make sure that people will be able to find your new page.

Link Basics

The bare minimum necessary to create a wiki link is to put two square brackets on either side of a word. So to change UT2004 into a link, just add brackets: [[UT2004]]. When you preview your edit, the word should now be displayed using blue text rather than black text. If, however, your link is in red text then you have tried to create a link to a page that does not exist. You should probably double check whether you have spelled the word correctly.

On the wiki, most links that you add to a page will be transformed by the wiki software after you save the page. So don't be surprised when your links suddenly look a lot more complicated after you have saved. All that has happened is that the wiki software has expanded the links to make them fully match the expected link syntax, as explained in the following section.

Internal Links

Internal links are those created to other pages on the wiki; this is by far the most common type of link. Some examples are:

An internal link always uses two square brackets. Within the brackets, the various parts of the link are:

1. The name of the page that you would like the reader to jump to if they click on the link, for example Oblivion:Places. This can be omitted if you are linking to somewhere else on the same page
2. An anchor, starting with #, if you would like the reader to jump to somewhere in the middle of the page. This can be omitted if you just want to link to the top of a page.
3. A label, starting with |, if you would like to customize the text displayed for the label. This can be omitted (but on the wiki generally is not).

A link to an existing page will always be displayed using blue text. After creating a link, it is recommended to preview the page and double check that the link is indeed blue. If it is red, you have made a typographical error (unless you are intentionally trying to make a link to a page that needs to be created). Sometimes links can show up as black, meaning that the wiki isn't even treating it as a link: check that your link starts with [[ and ends with ]]; see also labels.

Page Names

The wiki will automatically convert a page name into a URL-friendly equivalent. Web page names cannot contain common characters such as spaces or many types of punctuation. However, when creating an internal link you can type the name in whatever way is most convenient for you, and the wiki will take care of the details of the conversion.

Anchors

The pound sign (#, shift+3 on US keyboards) is used if you would like to link to somewhere other than the top of a page. The HTML terminology for the spot you link to is an "anchor". This is very useful if you want to refer the reader directly to the most relevant part of the page, especially for long pages.

Any section title (header) on a page can automatically be used as an anchor. In other words you can use any text that is enclosed in equal signs (=) when you look at the page in the editor. On pages with table of contents, those section titles will all be shown in the table of contents; if you click on one of those entries, the URL including the anchor will be shown in your browser window.

The same convenient URL conversions described under Page Names are also done for anchor names. So section titles or item names can be used exactly as they appear on a page; there is no need to replace spaces with underscores.

Labels

Without a label, the text shown for your link will just be the page name, which in most cases is not the best choice. To create a label, you use the pipe sign (|, shift+\ on US keyboards, often shown as two vertical lines instead of just one).

A pipe all by itself at the end of a link tells the wiki to automatically create a label, by stripping out the namespace and using just the page name. Any parts of the page name in parentheses will also be dropped. For example, [[UT2004 (game)|]] produces the link UT2004. When you save the page, the wiki explicitly fills in the label part of the link, so if you come back and edit this link, it will now read [[UT2004 (game)|UT2004]]. There are some situations, however, where the wiki will not automatically create a label (if the link contains an anchor, for example, or in some templates); in these cases the wiki will not even create a link, but will just add the text to the page unformatted.

Any text entered after the pipe symbol is used as a custom label for the link, i.e., that is the text that will appear to the reader.

Special Cases

There are a few types of links that have a special meaning.

• Links created to image pages will by default insert that image, instead of creating a plain link. If you want to create a plain text link, insert a colon at the start of the link. For example, [[:Image:UT2004.jpg]] creates Image:UT2004.jpg.
• Links created to categories will by default add the page to that category, and will not show any link at that spot in the text. If you want to create a link to a category page, insert a colon at the start of the link. For example, [[:Category:Categories]] creates Category:Categories.
• Very rarely you may need to link to a page on BeyondUnreal that is not part of the wiki, for example, to create a link to the game review. In such cases, you must create an external link. If you want to make the link look like a local link, you can embed the link in a span with the plainlinks class. So <span class=plainlinks>[http://www.beyondunreal.com/content/articles/86_1.php UT2004 review]</span> creates UT2004 review. This should only be used for links to BeyondUnreal, and should not be used to disguise external links.

Redirects

Redirects are a special type of internal link, and are used to make readers completely bypass that page and instead open a different page.

An example of a redirect page is UT2004; if you follow this link you will instead pull up the page Unreal Tournament 2004. A message at the top of the page lets you know that you were "Redirected from UT2004". If you really want to see the "UT2004" page, you can click on the link in the "Redirected" message.

To turn a page into a redirect you would replace the entire page contents with a single line like:
#REDIRECT [[Oblivion:Armor]]
The only other text that can be included on the page are category links. Any permanent redirect pages should be placed into one of the redirect categories, so that other editors know why the redirect page exists.

There is no reason to add a label to the link, since readers will never see it. The link should include an anchor if the redirect should take the readers somewhere other than the top of the page. For example, the redirect page UT2004 Maps contains the redirect link [[Unreal Tournament 2004#Maps]] so that readers who follow the link end up at the most relevant part of the Unreal Tournament 2004 page, instead of just ending up at the top of the page.

Most redirect pages are created automatically. Every time a page is moved, the original page name is turned into a redirect to the new page name. This ensures that any existing links to the page were not broken by the page move. The "What Links Here" feature (lower left corner of any page) can be used to identify internal links; correcting those links to point to the new page is highly recommended. If you wish to get rid of the original page completely, a proposed deletion can be used to request that an administrator delete the page. Before doing so, be sure to fix all internal links to the original page. However, in cases where there are external links to the original page, the deletion request may be denied.

External Links

External links are links made to sites other than the wiki. There is a different syntax for external links. Also, external links have an additional arrow added to the displayed link; this is done to warn readers that following the link will take them to a different site.

See Also

• Wikimedia help page on links
• Wikimedia help page on link labelling
• Wikimedia help page on external links
• Wikimedia help page on redirects
• Style Guide