Difference between revisions of "Help:Links"
Line 36: | Line 36: | ||
|[[Enderal:Finn|Finn's]] task is to gather herbs at the suncoast. | |[[Enderal:Finn|Finn's]] task is to gather herbs at the suncoast. | ||
|- | |- | ||
− | |<nowiki>If you leave the abandoned tower at the suncoast [[Enderal:Finn|one of the apothecarii]] | + | |<nowiki>If you leave the abandoned tower at the suncoast, [[Enderal:Finn|one of the apothecarii]] wants talk to you.</nowiki> |
− | |If you leave the abandoned tower at the suncoast [[Enderal:Finn|one of the apothecarii]] | + | |If you leave the abandoned tower at the suncoast, [[Enderal:Finn|one of the apothecarii]] wants talk to you. |
|- | |- | ||
|<nowiki>Hey [[User:Tilliboy|]], could you please help my formatting the article of [[Enderal:Finn]]?</nowiki> | |<nowiki>Hey [[User:Tilliboy|]], could you please help my formatting the article of [[Enderal:Finn]]?</nowiki> | ||
Line 52: | Line 52: | ||
The Breadcrumb of all articles shall eventually point towards the big portal sites of the individual SureAI projects ([[Enderal|Enderal]], [[Nehrim|Nehrim]], [[Arktwend|Arktwend]], [[Myar_Aranath:_Relict_of_Kallidar|Myar Aranath]], [[Cube_Experimental|Cube Experimental]]). | The Breadcrumb of all articles shall eventually point towards the big portal sites of the individual SureAI projects ([[Enderal|Enderal]], [[Nehrim|Nehrim]], [[Arktwend|Arktwend]], [[Myar_Aranath:_Relict_of_Kallidar|Myar Aranath]], [[Cube_Experimental|Cube Experimental]]). | ||
− | If an article is located directly "under" a portal page in the system, it is easy to install the <nowiki> {{breadcrumb}} </ nowiki> template at the top of the article. The portal page of the respective name space is automatically recognized and displayed: | + | If an article is located directly "under" a portal page in the system, it is easy to install the <nowiki> {{breadcrumb}} </nowiki> template at the top of the article. The portal page of the respective name space is automatically recognized and displayed: |
{|border="1" cellspacing="1" cellpadding="3" style="border-collapse:collapse; background-color:#FFFFFF; solid;" | {|border="1" cellspacing="1" cellpadding="3" style="border-collapse:collapse; background-color:#FFFFFF; solid;" | ||
− | |<font color=#517488>''' | + | |<font color=#517488>'''Used on these sites for example'''</font> |
− | |<font color=#517488>'''Wiki | + | |<font color=#517488>'''Wiki syntax in the source code'''</font> |
− | |<font color=#517488>''' | + | |<font color=#517488>'''Visible result at the top left of the page'''</font> |
|- | |- | ||
− | |[[ | + | |[[Enderal:NPCs]] |
|<nowiki>{{breadcrumb}}</nowiki> | |<nowiki>{{breadcrumb}}</nowiki> | ||
− | |<font size="1">< [[ | + | |<font size="1">< [[Enderal|Enderal]]</font> |
|- | |- | ||
− | |[[ | + | |[[Enderal:Quests]] |
|<nowiki>{{breadcrumb}}</nowiki> | |<nowiki>{{breadcrumb}}</nowiki> | ||
− | |<font size="1">< [[ | + | |<font size="1">< [[Enderal|Enderal]]</font> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
− | + | If you want to inlcude a Breadcrumb in an article which is "under"r Systematik „unter“ these just mentioned articles, you only have to add the link to the parent page, separated by a vertical line ("|"), the so-called "pipe": | |
{|border="1" cellspacing="1" cellpadding="3" style="border-collapse:collapse; background-color:#FFFFFF; solid;" | {|border="1" cellspacing="1" cellpadding="3" style="border-collapse:collapse; background-color:#FFFFFF; solid;" | ||
− | |<font color=#517488>''' | + | |<font color=#517488>'''Used on these sites for example'''</font> |
− | |<font color=#517488>'''Wiki | + | |<font color=#517488>'''Wiki syntax in the source code'''</font> |
− | |<font color=#517488>''' | + | |<font color=#517488>'''Visible result at the top left of the page'''</font> |
|- | |- | ||
− | |[[ | + | |[[Enderal:Finn]] |
− | |<nowiki>{{breadcrumb|[[ | + | |<nowiki>{{breadcrumb|[[Enderal:NPCs|People]]}}</nowiki> |
− | |<font size="1">< [[ | + | |<font size="1">< [[Enderal|Enderal]] < [[Enderal:NPCs|People]]</font> |
|- | |- | ||
− | |[[ | + | |[[Enderal:Main_Quest]] |
− | |<nowiki>{{breadcrumb|[[ | + | |<nowiki>{{breadcrumb|[[Enderal:Quests|]]}}</nowiki> |
− | |<font size="1">< [[ | + | |<font size="1">< [[Enderal|Enderal]] < [[Enderal|Quests]]</font> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
− | + | If you want to go a level deeper, simply expand the Breadcrumb accordingly. You have to insert the "<" character yourself: | |
{|border="1" cellspacing="1" cellpadding="3" style="border-collapse:collapse; background-color:#FFFFFF; solid;" | {|border="1" cellspacing="1" cellpadding="3" style="border-collapse:collapse; background-color:#FFFFFF; solid;" | ||
− | |<font color=#517488>''' | + | |<font color=#517488>'''Used on these sites for example'''</font> |
− | |<font color=#517488>'''Wiki | + | |<font color=#517488>'''Wiki syntax in the source code'''</font> |
− | |<font color=#517488>''' | + | |<font color=#517488>'''Visible result at the top left of the page'''</font> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
− | |[[ | + | |[[Enderal:A_Nice_Day_in_Summer]] |
− | |<nowiki>{{breadcrumb|[[ | + | |<nowiki>{{breadcrumb|[[Enderal|Quests|]] < [[Enderal:Main_Quest|Main Quest]]}}</nowiki> |
− | |<font size="1">< [[ | + | |<font size="1">< [[Enderal|Enderal]] < [[Enderal|Quests]] < [[Enderal:Main_Quest|Main Quest]]</font> |
|} | |} | ||
− | == | + | ==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. [[Enderal:All_the_Dead_Souls|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 [[Special:DeadendPages|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 | + | *Links to paragraphs in another article, thus to the between headings, are also possible |
− | == | + | ==Internal Links (Wikilinks)== |
Wörter die auf Wiki-interne Seiten verlinken sollen, müssen nur als sog. "Interner Link" mit zwei eckigen Klammern "[[]]" umgeben werden. Dieser Vorgang lässt sich auch vereinfachen, indem man das gewünschte wort mit der Maus markiert und in der Bearbeitungswerkzeugleiste über dem Vorschaufenser die unterstrichene "AB"-Anweisungen anklickt. | Wörter die auf Wiki-interne Seiten verlinken sollen, müssen nur als sog. "Interner Link" mit zwei eckigen Klammern "[[]]" umgeben werden. Dieser Vorgang lässt sich auch vereinfachen, indem man das gewünschte wort mit der Maus markiert und in der Bearbeitungswerkzeugleiste über dem Vorschaufenser die unterstrichene "AB"-Anweisungen anklickt. | ||
*Nicht zwangsläufig muss die Adresse des Artikels auch dem Wortlaut es Links entsprechen! Wenn nach der Linkadresse, mit einem senkrechten Strich "|" getrennt, ein weiterer Text eingegeben wird, so wird dieser im Artikel angezeigt und nicht die Adresse des eigentlichen Linkziels. Dies macht sich besonders gut bei leichen Änderungen an Wörtern, die nicht extra eine [[Hilfe:Begriffsklärung|Begriffsklärung]] benötigen | *Nicht zwangsläufig muss die Adresse des Artikels auch dem Wortlaut es Links entsprechen! Wenn nach der Linkadresse, mit einem senkrechten Strich "|" getrennt, ein weiterer Text eingegeben wird, so wird dieser im Artikel angezeigt und nicht die Adresse des eigentlichen Linkziels. Dies macht sich besonders gut bei leichen Änderungen an Wörtern, die nicht extra eine [[Hilfe:Begriffsklärung|Begriffsklärung]] benötigen | ||
Line 150: | Line 125: | ||
− | == | + | ==External Links== |
Die Syntax bietet Möglichkeiten Links auf externe Seiten verschieden anzeigen zu lassen. | Die Syntax bietet Möglichkeiten Links auf externe Seiten verschieden anzeigen zu lassen. | ||
*Man kann einefach einen rohen Link aus dem Browser in den Artikel kopieren | *Man kann einefach einen rohen Link aus dem Browser in den Artikel kopieren |
Revision as of 04:11, 14 March 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.
Contents
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:
Wiki syntax of the link in the source code | Visible result on the page |
[[Enderal:Finn|]] is gathering herbs at the suncoast. | Finn is gathering herbs at the suncoast. |
[[Enderal:Finn|Finn]] is gathering herbs at the suncoast. | Finn is gathering herbs at the suncoast. |
[[Enderal:Finn|Finn's]] task is to gather herbs at the suncoast. | Finn's task is to gather herbs at the suncoast. |
If you leave the abandoned tower at the suncoast, [[Enderal:Finn|one of the apothecarii]] wants talk to you. | If you leave the abandoned tower at the suncoast, one of the apothecarii wants talk to you. |
Hey [[User:Tilliboy|]], could you please help my formatting the article of [[Enderal:Finn]]? | Hey Tilliboy, could you please help my formatting the article of Enderal:Finn? |
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:
Used on these sites for example | Wiki syntax in the source code | Visible result at the top left of the page |
Enderal:NPCs | {{breadcrumb}} | < Enderal |
Enderal:Quests | {{breadcrumb}} | < Enderal |
If you want to inlcude a Breadcrumb in an article which is "under"r Systematik „unter“ these just mentioned articles, you only have to add the link to the parent page, separated by a vertical line ("|"), the so-called "pipe":
Used on these sites for example | Wiki syntax in the source code | Visible result at the top left of the page |
Enderal:Finn | {{breadcrumb|[[Enderal:NPCs|People]]}} | < Enderal < People |
Enderal:Main_Quest | {{breadcrumb|[[Enderal:Quests|]]}} | < Enderal < Quests |
If you want to go a level deeper, simply expand the Breadcrumb accordingly. You have to insert the "<" character yourself:
Used on these sites for example | Wiki syntax in the source code | Visible result at the top left of the page |
Enderal:A_Nice_Day_in_Summer | {{breadcrumb|[[Enderal|Quests|]] < [[Enderal:Main_Quest|Main Quest]]}} | < Enderal < Quests < Main Quest |
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
Internal Links (Wikilinks)
Wörter die auf Wiki-interne Seiten verlinken sollen, müssen nur als sog. "Interner Link" mit zwei eckigen Klammern "[[]]" umgeben werden. Dieser Vorgang lässt sich auch vereinfachen, indem man das gewünschte wort mit der Maus markiert und in der Bearbeitungswerkzeugleiste über dem Vorschaufenser die unterstrichene "AB"-Anweisungen anklickt.
- Nicht zwangsläufig muss die Adresse des Artikels auch dem Wortlaut es Links entsprechen! Wenn nach der Linkadresse, mit einem senkrechten Strich "|" getrennt, ein weiterer Text eingegeben wird, so wird dieser im Artikel angezeigt und nicht die Adresse des eigentlichen Linkziels. Dies macht sich besonders gut bei leichen Änderungen an Wörtern, die nicht extra eine Begriffsklärung benötigen
Link im Artikel | Link in der Syntax | Ergebniss-Beschreibung |
---|---|---|
Hauptseite | [[Hauptseite]] | Normaler interner Link |
Das Wiki von SureAI | [[Hauptseite|Das Wiki von SureAI]] | Neue Beschreibung des Links mit einem senkrechten Strich "|" getrennt |
External Links
Die Syntax bietet Möglichkeiten Links auf externe Seiten verschieden anzeigen zu lassen.
- Man kann einefach einen rohen Link aus dem Browser in den Artikel kopieren
- Die Linkadresse mit eckigen Klammern "[]" umgeben um besonders lange externe Links auf ein Thumbnail zu verkürzen
- Den gekennzeichneten externen Link benennen, indem man einen Text, durch ein Leerzeichen getrennt von der Linkadresse einfügt
Link im Artikel | Link in der Syntax | Ergebniss-Beschreibung |
---|---|---|
http://www.sureai.de/wiki/index.php/Hauptseite | http://www.sureai.de/wiki/index.php/Hauptseite | Hier wurde der externe Link nur aus dem Browser in den Artikel kopiert |
[1] | [http://www.sureai.de/wiki/index.php/Hauptseite] | Hier ist der externe Link als solcher für die Syntax mit zwei eckigen Klammern "[[]]" gekennzeichnet |
SureAI Hauptseite | [http://www.sureai.de/wiki/index.php/Hauptseite SureAI Hauptseite] | Ein gekennzeichneter externer Link kann auch benannt werden, man muss nur die Benennung, mit einem Leerzeichen getrennt, hinter die Linkadresse setzen |