Difference between revisions of "Linking"

From UNB Archives and Special Collections
Jump to navigation Jump to search
 
(39 intermediate revisions by the same user not shown)
Line 1: Line 1:
__TOC__
+
{{StudentManual}} {{AdministratorManual}}
  
 +
Every '''appropriate''' link adds value to the wiki. A link is appropriate when an overt reference is made to an ''other'' relevant topic - each topic should have a dedicated entry.<br/>A link is not appropriate when:
 +
 +
*A reference (and corresponding link) has already been made to a particular&nbsp;[[Entries and Pages|entry/page]]&nbsp;within that same paragraph.
 +
*A word corresponds to an entry/page but the context of its use does not directly relate to the content of the entry/page dedicated to the word.
 +
 +
<br/>__TOC__
  
<br/><br/><br/>'''[[Archives Manual#Linking within the Wiki|Return to the Student Manual]]'''
 
  
 
= Internal Links =
 
= Internal Links =
Line 8: Line 13:
 
An '''Internal Link'''''&nbsp;''is&nbsp;used to direct the user to another page within the UNB wiki. These internal links are the most effective way to establish a web of connections throughout the wiki that enhance readers' experience by increasing accessibility of information.
 
An '''Internal Link'''''&nbsp;''is&nbsp;used to direct the user to another page within the UNB wiki. These internal links are the most effective way to establish a web of connections throughout the wiki that enhance readers' experience by increasing accessibility of information.
  
== RichTextEditor ==
+
==== RichTextEditor ====
  
 
Creating an '''Internal Link''' with the [[Editors|RichTextEditor]] is quick and easy, as [[MediaWiki]] provides the [[Contributor]] with a field to search the entire wiki for the desired [[Entries and Pages#Origin versus Destination|destination page/entry]]. To generate this field, click the Link icon:
 
Creating an '''Internal Link''' with the [[Editors|RichTextEditor]] is quick and easy, as [[MediaWiki]] provides the [[Contributor]] with a field to search the entire wiki for the desired [[Entries and Pages#Origin versus Destination|destination page/entry]]. To generate this field, click the Link icon:
Line 16: Line 21:
 
Clicking the '''link''' icon will generate a new box in which existing pages can be searched - '''as long as the contributor knows the title''' of the [[Entries and Pages|destination]] entry/page. Upon inputting the first few characters the desired destination should appear to be selected, establishing a hyperlink on the [[Entries and Pages|origin]] entry/page.
 
Clicking the '''link''' icon will generate a new box in which existing pages can be searched - '''as long as the contributor knows the title''' of the [[Entries and Pages|destination]] entry/page. Upon inputting the first few characters the desired destination should appear to be selected, establishing a hyperlink on the [[Entries and Pages|origin]] entry/page.
  
== WikiTextEditor ==
+
==== WikiTextEditor ====
  
 
To create an ''internal link'', enclose the '''title''' of the destination entry with double square brackets on either side:
 
To create an ''internal link'', enclose the '''title''' of the destination entry with double square brackets on either side:
 
<center>'''Example:''' <nowiki>[[Example]]</nowiki></center>
 
<center>'''Example:''' <nowiki>[[Example]]</nowiki></center>
 +
 +
 
*If the destination entry&nbsp;'''exists'''&nbsp;and has been&nbsp;'''entered correctly'''&nbsp;an operational link will be created.
 
*If the destination entry&nbsp;'''exists'''&nbsp;and has been&nbsp;'''entered correctly'''&nbsp;an operational link will be created.
 
**Remember that [[MediaWiki|Mediawiki]] is case sensitive - the first thing that the contributor should check for if a link does not work is the spelling and capitalization of the destination entry within the WikiTextEditor code.
 
**Remember that [[MediaWiki|Mediawiki]] is case sensitive - the first thing that the contributor should check for if a link does not work is the spelling and capitalization of the destination entry within the WikiTextEditor code.
  
 
*If the destination entry does&nbsp;'''not exist''', the hyperlink created will connect to a new page upon which an entry can be created, either immediately or in the future.
 
*If the destination entry does&nbsp;'''not exist''', the hyperlink created will connect to a new page upon which an entry can be created, either immediately or in the future.
**The practice of creating links to non-existent pages for future creation is called [[#Lazy Linking|lazy linking]], which&nbsp;can be an effective way to communicate to future contributors the pages that need to be created and the future direction of the wiki.
+
**The practice of creating links to non-existent pages for future creation is called [[#Lazy_Linking|lazy linking]], which&nbsp;can be an effective way to communicate to future contributors the pages that need to be created and the future direction of the wiki.
 
<center><br/></center>
 
<center><br/></center>
= Linking via Alternate Text =
 
  
Sometimes the exact title of a page is not ideal to insert into a sentence and an&nbsp;'''alternate text'''&nbsp;would better serve the entry/page. Instead, best practice is to present the hyperlink as text that flows within the entry.
+
 
 +
= Using Alternate Text =
 +
 
 +
Sometimes the exact title of a page is not ideal to use in a sentence and an '''alternate text''' would better compliment the entry/page. Instead, best practice is to present the hyperlink as text that flows within the entry.
 
<div style="border: 2px solid black;"><br/><center>'''Consider this example:'''</center><center>Debating has long been a popular extracurricular activity at UNB.</center><p style="text-align: center;">It is in the wiki's interest to establish a link to the Literary and Debating Society page, but inserting this title would obstruct the flow of the sentence.</p></div><br/>
 
<div style="border: 2px solid black;"><br/><center>'''Consider this example:'''</center><center>Debating has long been a popular extracurricular activity at UNB.</center><p style="text-align: center;">It is in the wiki's interest to establish a link to the Literary and Debating Society page, but inserting this title would obstruct the flow of the sentence.</p></div><br/>
== RichTextEditor ==
+
==== RichTextEditor ====
  
 
Using the [[Editors|RichTextEditor]], simply write the sentence and highlight the text intended to be presented as hyperlink, and complete the process as outlined in the section above by clicking the '''link icon''' and selecting the [[Entries and Pages|destination]] entry/page.
 
Using the [[Editors|RichTextEditor]], simply write the sentence and highlight the text intended to be presented as hyperlink, and complete the process as outlined in the section above by clicking the '''link icon''' and selecting the [[Entries and Pages|destination]] entry/page.
  
== WikiTextEditor ==
+
==== WikiTextEditor ====
  
 
To establish a link using alternate text with the [[Editors|WikiTextEditor]], a [[Mark-up Language|pipe]] (or vertical bar)— | —must be placed after the title of the [[Entries and Pages|destination]] entry/page, followed by the desired alternate text and enclosed between double square brackets:
 
To establish a link using alternate text with the [[Editors|WikiTextEditor]], a [[Mark-up Language|pipe]] (or vertical bar)— | —must be placed after the title of the [[Entries and Pages|destination]] entry/page, followed by the desired alternate text and enclosed between double square brackets:
Line 46: Line 55:
  
  
= External Links =
+
= Anchors (Link to a Specific Place on a Page) =
  
Student contributors will likely not need to link to external sites, but if the rare occasion were to arise there are several ways to create an [[External Link|external link]].
+
When referring to specific information, it may prove useful to know how to link to a specific place on an [[Entries and Pages|entry/page]]. This is achieved by linking to an '''anchor'''.
  
= Linking to Category Pages =
+
*This is particularly relevant for larger pages with a lot of content.
 +
*'''WikiTextEditor''' must be used.
 +
*Remember to verify the capitalization and spelling of the title of the [[Entries and Pages|destination]] when creating links.
  
Linking to a '''category page''' can be useful as well.
 
  
To link to a category page one '''must''' use WikiTextEditor. The RichTextEditor does not appear to allow linking to category pages.
 
  
'''Instead'''—using the [[Editors|WikiTextEditor]]—add a category tag to the desired category page but with a colon preceding '''Category'''.
+
=== Headers as Anchors ===
<center>'''Example:''' <nowiki>[[:Category:Example]]</nowiki></center>
 
*As with any other link, a [[Mark-up Language|pipe]] can be used to represent the link as [[#Linking_via_Alternate_Text|alternate text]].
 
  
 +
Some anchors exist naturally within a page. All [[Headers|headers]] are automatically anchors and can be easily identified by their presence in the Table of Contents at the top of a given page. '''To link to a header:'''
  
 +
#Enter the [[Editors|WikiTextEditor]] and start by creating a [[#Internal_Links|basic link]] to the destination page.
 +
#A [[Mark-up Language|pound]] symbol (#) is used to separate the destination entry/page title from the title of the header on that destination page.
 +
#*A [[Mark-up Language|pipe]] can be used if [[#Using_Alternate_Text|alternate text]] is desired.
 +
<center><br/>'''Example:''' <nowiki>[[Destination title#Header title|alternate text]]</nowiki><br/></center>
  
= Linking to Image Pages =
 
 
Linking to an image page is very similar to linking to a category page, and one must again use the WikiTextEditor.
 
 
To link to an image page from an [[Entries and Pages|origin]] entry/page, ensure that a colon precedes the '''Image''' (or '''File''') segment of the WikiText code
 
 
= Anchors (Linking to a Specific Place on a Page) =
 
 
There may be circumstances in which linking to a the top of a page is ineffective, as the reader will then have to read through a body of text or scroll through the page to locate the reference.&nbsp;'''Linking to a specific place on an entry or page requires the use of an anchor.'''
 
 
*This is particularly relevant for larger pages with a lot of content.
 
*For these functions the&nbsp;'''WikiTextEditor is most effective.'''
 
*Remember to verify capitalization and spelling of titles when creating links.
 
  
<br/>1. Some anchors exist naturally within a page. All of the section&nbsp;''headers''&nbsp;are anchors and can be easily identified by their presence in the Table of Contents at the top of a given page:
+
=== Manually Creating an Anchor ===
<div style="border: 2px solid black;">The first step should be to establish a basic link from the origin page (where the hyperlink is desired) to the destination page. Having successfully saved that change, the contributor will re-enter the Edit section and select the&nbsp;'''WikiTextEditor''', and locate the link that has just been created.
 
<br/>&#x5B;&#x5B;Destination page&#x5D;&#x5D;<br/>&#x5B;&#x5B;Destination page#Header title of Destination page&#x5D;&#x5D;<br/>&#x5B;&#x5B;Destination page#Header title on Destination page|Alternative text&#x5D;&#x5D;<br/>'''Example:'''&nbsp;&#x5B;&#x5B;Mark's Page#Sneaker Collection|Mark loves sneakers&#x5D;&#x5D;
 
The result will be a link that directs the reader to Mark's Page with the specified anchor/header (Sneaker Collection) at the top of the window, with the hyperlinked text&nbsp;<span style="color: rgb(0, 0, 205);"><u>Mark loves sneakers</u></span>&nbsp;will be created&nbsp;on the origin page .&lt;/center&gt;</div>
 
<br/>2. Some entries may not be effectively broken up by headers, while some sections might be too long for linking to the header to be an effective solution - do not fear! There is a way to manually create an anchor on a page, but the&nbsp;'''WikiTextEditor'''&nbsp;must be used:
 
<div style="border: 2px solid black;">&lt;center&gt;First, on the&nbsp;[[Destination]]&nbsp;page, the anchor must be created. The following code must be inserted to create the anchor:
 
&lt;span id="Anchor_name"&gt;Text can be inserted here (although the absence of text will produce an invisible anchor)&lt;span&gt;
 
  
'''Spaces cannot be used in the "Anchor_name", so make use of _'s, and remember to use quotation marks.'''
+
Some entries may not be effectively broken up by headers, and some sections might be too long for linking to the header to be an effective solution - do not fear! There is a way to manually create an anchor within a page. Again, the '''WikiTextEditor must be used'''.
  
Having created this anchor, the next step is to link to it. This process is identical to linking to headers as described above:
+
*First, on the [[Entries and Pages|destination]] page, the anchor must be created. Then, the following code must be inserted to create the anchor:
<center><nowiki>[[Destination page#Anchor_name|Alternative text]]</nowiki></center></div>
+
<center><br/><nowiki><span id="Anchor_name">Text can be placed here (although the absence of text will produce an invisible anchor)</span></nowiki></center><center><br/>'''Spaces cannot be used in the "Anchor_name", so make use of _'s, and remember to use quotation marks.'''</center>
 +
<br/>Having created this anchor, the next step is to link to it. This process is identical to linking to headers as described above:
 +
<center><nowiki>[[Destination page#Anchor_name|Alternate text]]</nowiki></center>
 +
<br/>--[[User:Markmcumber|MarkMcCumber]] ([[User talk:Markmcumber|talk]]) 10:30, 8 July 2014 (ADT)
 +
[[Category:Mark's Contributions|Link]]<br/>[[Category:Manual Pages|Link]]

Latest revision as of 11:09, 9 July 2014

Return to Student Manual.
Return to Administrator Manual.

Every appropriate link adds value to the wiki. A link is appropriate when an overt reference is made to an other relevant topic - each topic should have a dedicated entry.
A link is not appropriate when:

  • A reference (and corresponding link) has already been made to a particular entry/page within that same paragraph.
  • A word corresponds to an entry/page but the context of its use does not directly relate to the content of the entry/page dedicated to the word.



Internal Links

An Internal Link is used to direct the user to another page within the UNB wiki. These internal links are the most effective way to establish a web of connections throughout the wiki that enhance readers' experience by increasing accessibility of information.

RichTextEditor

Creating an Internal Link with the RichTextEditor is quick and easy, as MediaWiki provides the Contributor with a field to search the entire wiki for the desired destination page/entry. To generate this field, click the Link icon:

LinkIcon.png

Clicking the link icon will generate a new box in which existing pages can be searched - as long as the contributor knows the title of the destination entry/page. Upon inputting the first few characters the desired destination should appear to be selected, establishing a hyperlink on the origin entry/page.

WikiTextEditor

To create an internal link, enclose the title of the destination entry with double square brackets on either side:

Example: [[Example]]


  • If the destination entry exists and has been entered correctly an operational link will be created.
    • Remember that Mediawiki is case sensitive - the first thing that the contributor should check for if a link does not work is the spelling and capitalization of the destination entry within the WikiTextEditor code.
  • If the destination entry does not exist, the hyperlink created will connect to a new page upon which an entry can be created, either immediately or in the future.
    • The practice of creating links to non-existent pages for future creation is called lazy linking, which can be an effective way to communicate to future contributors the pages that need to be created and the future direction of the wiki.


Using Alternate Text

Sometimes the exact title of a page is not ideal to use in a sentence and an alternate text would better compliment the entry/page. Instead, best practice is to present the hyperlink as text that flows within the entry.


Consider this example:
Debating has long been a popular extracurricular activity at UNB.

It is in the wiki's interest to establish a link to the Literary and Debating Society page, but inserting this title would obstruct the flow of the sentence.


RichTextEditor

Using the RichTextEditor, simply write the sentence and highlight the text intended to be presented as hyperlink, and complete the process as outlined in the section above by clicking the link icon and selecting the destination entry/page.

WikiTextEditor

To establish a link using alternate text with the WikiTextEditor, a pipe (or vertical bar)— | —must be placed after the title of the destination entry/page, followed by the desired alternate text and enclosed between double square brackets:

[[Literary and Debating Society|Debating]] has long been a popular extracurricular activity at UNB. 

(Result:) Debating has long been a popular extracurricular activity at UNB.


Lazy Linking

Lazy Linking is the process of actively creating links to non-existent entries/pages with the intention of creating them—or having someone else create them—in the future. It is an effective way to map out the future of the wiki's development without deviating from the task at hand to establish a new entry/page (the perpetual nature of this deviation could be infinite and result in an infinite number of unfinished pages - don't mind the dramatics).

Hyperlinks to non-existent entries/pages will appear red - clicking a red hyperlink will allow the contributor to edit this non-existent entry/page.

A list of all the links to non-existent entries can be found here:
http://unbhistory.lib.unb.ca/index.php/Special:WantedPages



Anchors (Link to a Specific Place on a Page)

When referring to specific information, it may prove useful to know how to link to a specific place on an entry/page. This is achieved by linking to an anchor.

  • This is particularly relevant for larger pages with a lot of content.
  • WikiTextEditor must be used.
  • Remember to verify the capitalization and spelling of the title of the destination when creating links.


Headers as Anchors

Some anchors exist naturally within a page. All headers are automatically anchors and can be easily identified by their presence in the Table of Contents at the top of a given page. To link to a header:

  1. Enter the WikiTextEditor and start by creating a basic link to the destination page.
  2. A pound symbol (#) is used to separate the destination entry/page title from the title of the header on that destination page.

Example: [[Destination title#Header title|alternate text]]


Manually Creating an Anchor

Some entries may not be effectively broken up by headers, and some sections might be too long for linking to the header to be an effective solution - do not fear! There is a way to manually create an anchor within a page. Again, the WikiTextEditor must be used.

  • First, on the destination page, the anchor must be created. Then, the following code must be inserted to create the anchor:

<span id="Anchor_name">Text can be placed here (although the absence of text will produce an invisible anchor)</span>

Spaces cannot be used in the "Anchor_name", so make use of _'s, and remember to use quotation marks.


Having created this anchor, the next step is to link to it. This process is identical to linking to headers as described above:

[[Destination page#Anchor_name|Alternate text]]


--MarkMcCumber (talk) 10:30, 8 July 2014 (ADT)