Difference between revisions of "Help:Links"

Latest revision as of 09:18, 28 June 2017

	Stub
	The following page or section is still a stub and is incomplete.

This page provides guidelines and guidance where links should be used within an article, which types of links are possible with the Wiki syntax and how these can look.

Links in the SureAI Wiki

Most links in the SureAI Wiki have a peculiarity in contrast to other links used in other wikis in which the linked article names are simply placed between two square brackets: the Namespace.

There are already five different projects from SureAI. Many terms are used in several of these projects (eg "skills", "creatures", "alchemy", "goblin" etc.), but they have quite different characteristics and meanings in the individual projects. Therefore every article needs an additional name space with a double point, which shows the project for the respective article:

• Myar:
• Arktwend:
• Nehrim:
• Enderal:
• Cube:

As in every wiki, there are also other, fixed namespaces, for example, all help articles are located in the namespace Help: or every image in the namespace File:.

There is also the main namespace in which every project lays, the namespace without any prefix. There are only nine articles - the portal sites towards the repsective the projects. No other articles should be added to this main namespace. So if you want to include a link to an article, you always have to prepend the correct namespace. A link towards an article about the NPC "Finn Dalires" should not look like this: [[Finn]], but like this: [[Enderal:Finn|]]. Important is the vertical line after the article name (|), which is meant to seperate the readable text from the actual link, so the link will be displayed without the namespace prefix. The | should only be used if the link shown should be different from the actual article name because of grammar or formulation, otherwise this will be done by the Wiki software automatically.

If you leave out the vertical line, the namespace will be displayed within the link which which is bad for readability in articles.

Some simple examples:

The Breadcrumb navigation

Every article in the SureAI Wiki should get a linking path in the upper left corner, which shows how it is arranged in the systematics of the wiki: a so-called Breadcrumb navigation.

At the moment there are many different methods of navigations links in the Wiki, especially links like "back to ..." (e.g. at the End of a Enderal quest article "back to [[Enderal:Quests|Quests]"). Those links should be replaced by Breadcrumbs. You never know how a user gets to the article. There are many links within the wiki and you can also easily come across a search engine for the article, so the phrase "back to" is unfitting.

To make it easier to use breadcrumb navigation we've already have a template Breadcrumb which should be used on every site. If the formatting of the navigation should be changed at one point, this can be achieved by simply changing the template on all pages.

The Breadcrumb of all articles shall eventually point towards the big portal sites of the individual SureAI projects (Enderal, Nehrim, Arktwend, Myar Aranath, Cube Experimental).

If an article is located directly "under" a portal page in the system, it is easy to install the {{breadcrumb}} template at the top of the article. The portal page of the respective name space is automatically recognized and displayed:

If you want to inlcude a Breadcrumb in an article which is "under" these just mentioned articles, you only have to add the link to the parent page, separated by a vertical line (|), the so-called "pipe":

If you want to go a level deeper, simply expand the Breadcrumb accordingly. You have to insert the < character yourself:

Directives

• If a term is used more than once in a text, it should be linked at the first occurrence only. For longer texts (e.g. All the Dead Souls), which are not necessarily meant to be read from top to bottom, each section should be readable and understandable. That means each section should contain all necessary links.
• When writing a new article, it is recommended to link it to as many other articles as possible, so that it can also be found by interested users
• If an article is not linked internally, it will be included in the Dead-End pages
• Internal links to non-existent articles can be created as a precaution if one considers that this term deserves its own article (non-existent link destinations are displayed red instead of white)
• If it is not possible to include an important term in the text as a link, it should be referred to at the end of the article
• Between headings should not contain links
• Links to paragraphs in another article, thus to the between headings, are also possible. E.g. a link to a between heading on the main page Character; Looking like this [[Enderal#Character|Character]]

Internal Links (Wikilinks)

Words which link to internal Wiki pages are so called "Internal Links". They can be used with two square bracket [[]] surrounding the address.

• The address of the linked article does not have to match the wording of the link! Simply put a vertical line | after the link address and write an additional text between the vertical line and the closing square brackts. This way the additional text will be displayed instead of the actual link.

External Links

It is possible to link to external page. Like internal links, they can be used differently.

• You can simply put a normal URL from your browser into an article
• The adress can be surrounded by a single pair of square brackts [] to shorten the link to a thumbnail
• The thumbnail can be customized by putting a space behind the link and then write the description/thumbnail of the link yourself.