Archives Manual: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
<br/>Notice that your username appears as a hyperlink at the top of this and every page within the wiki. This link will transport you to your very own ''user page'' that you can use to create a customized profile. After reading the section entitled '''Editing Content''', consider testing the editing functions on this page and create a basic profile. Include some information about yourself, your studies, and the areas of the wiki to which you will contribute. You can edit it again in the future.
<br/>Notice that your username appears as a hyperlink at the top of this and every page within the wiki. This link will transport you to your very own ''user page'' that you can use to create a customized profile. After reading the section entitled '''Editing Content''', consider testing the editing functions on this page and create a basic profile. Include some information about yourself, your studies, and the areas of the wiki to which you will contribute. You can edit it again in the future.
<center>For the purposes of this manual, you will henceforth be referred to as ''the contributor''.</center><br/></div>
<center>For the purposes of this manual, you will henceforth be referred to as ''the contributor''.</center><br/></div>
<br/>
 
 
----
----
<br/>
 
 
 
----
----
<br/>
 
 
 
= Editing Content =
= Editing Content =


Line 28: Line 33:


*Note the option to <u>Create</u> next to the Search Box - clicking this will initiate the creation of a new entry. Upon saving the content of this entry, the contributor will have successfully created a new entry!
*Note the option to <u>Create</u> next to the Search Box - clicking this will initiate the creation of a new entry. Upon saving the content of this entry, the contributor will have successfully created a new entry!
<br/>
 
 
 
----
----
<br/>
 
 
 
----
----
<br/>
 
 
 
= Linking within the Wiki =
= Linking within the Wiki =


Line 53: Line 64:
<br/>The insertion of this text in the WikiTextEditor will result in a hyperlinked&nbsp;&nbsp;followed by the rest of the text.&lt;/center&gt;
<br/>The insertion of this text in the WikiTextEditor will result in a hyperlinked&nbsp;&nbsp;followed by the rest of the text.&lt;/center&gt;
<center>'''The pipe is not a capitalized '''i,&nbsp;'''but a character to the far right of the keyboard - a capitalized foreward slash \'''</center></div>
<center>'''The pipe is not a capitalized '''i,&nbsp;'''but a character to the far right of the keyboard - a capitalized foreward slash \'''</center></div>
<br/>
 
 
----
----
<br/>
 
 
 
----
----
<br/>
 
 
 
= Images =
= Images =


Line 67: Line 83:
<center>[[File:DropFilesHere.png]]</center>
<center>[[File:DropFilesHere.png]]</center>
After dragging the image file into the "Drop files here" box, select "<u>Click here to upload this file</u>" to load the image to the wiki. Once uploaded, the image can be inserted into any relevant entry in the future.
After dragging the image file into the "Drop files here" box, select "<u>Click here to upload this file</u>" to load the image to the wiki. Once uploaded, the image can be inserted into any relevant entry in the future.
<center>[[File:UploadthisFile.png]]</center>
<center>[[File:UploadthisFile.png|720x140px]]</center>

Revision as of 09:23, 12 June 2014

As a contributor, perhaps you've just logged on to UNB's History at a Glance for the first time.


Notice that your username appears as a hyperlink at the top of this and every page within the wiki. This link will transport you to your very own user page that you can use to create a customized profile. After reading the section entitled Editing Content, consider testing the editing functions on this page and create a basic profile. Include some information about yourself, your studies, and the areas of the wiki to which you will contribute. You can edit it again in the future.

For the purposes of this manual, you will henceforth be referred to as the contributor.






Editing Content

There are two simple languages available available to contributors for wiki editing.

  1. RichTextEditor - default editing screen. Good for basic content/textual editing.
  2. WikiTextEditor - accessed by clicking [Show WikiTextEditor]. Necessary for more advanced functions.

The RichTextEditor menu bar may appear familiar as it contains some functions similar to a word processor, but it can be tricky. The safest and most effective way to edit content is by using the WikiTextEditor, as an understanding of this language will make the editing of existing content much easier. For basic editing, the RichTextEditor should suffice.

Click here for a basic guide to the formatting that can be applied using the WikiTextEditor.


After modifying an entry—before saving any changes—the contributor should strongly consider making use of the Show preview option next to the Save Page button - this allows the contributor to see the consequences of the changes made and modify any errors prior to saving them to the wiki.

ShowPreview.png
  • Note the option to provide a summary as well - this should be utilized when editing the content created by another, justifying why any changes were made.

New Entries

The simplest way that a contributor can create a new entry is by adding the title of the prospective entry to the wiki's URL - below we've added Example:

http://unbhistory.lib.unb.ca/index.php/Example
  • If this title has already been assigned to an entry, the contributor will be directed to the existing entry.
  • If this title has not yet been assigned, the contributor will be directed to a page similar to this:
NewPage.png


  • Note the option to Create next to the Search Box - clicking this will initiate the creation of a new entry. Upon saving the content of this entry, the contributor will have successfully created a new entry!






Linking within the Wiki

One of the most powerful and important components of the Wiki is the interconnectivity of its entries. When an entry is not linked to other entries it will be difficult for the user to find via browsing. While it will still be possible to locate the page with the search function, the increased visibility attained through appropriate and relevant linking will add value to your wiki entry. There are several ways to link your entry to the established body of information.

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 connect entries and are an indispensable component of user navigability through the wiki.
To create an internal link, enclose the title of the destination entry with double square brackets on either side:

[[Example]]
  • If the destination entry exists and has been entered correctly (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), an operational link will be created.
  • 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 is called lazy linking - this can be an effective way to communicate to other contributors the pages that need to be created in the future.
A listing of all the links to non-existent entries can be found here:
http://unbhistory.lib.unb.ca/index.php/Special:WantedPages


Linking with Alternate Text

Sometimes the exact title of a page is not ideal to insert into a sentence as a hyperlink. Instead, the ideal practice is to represent the hyperlink as text that flows within the entry.

Consider this sentence:
Debating has long been a popular extracurricular activity at UNB.
It is in the wiki's interest to provide a link to the Literary and Debating Society page, but inserting this title would obstruct the flow of the sentence. To create a link using alternate text, we must use what is called a pipe— | — to indicate that the text following the pipe will serve as the hyperlink instead of the title of the destination page:</span>
[[Literary and Debating Society|Debating]] has long been a popular extracurricular activity at UNB.


The insertion of this text in the WikiTextEditor will result in a hyperlinked  followed by the rest of the text.</center>

The pipe is not a capitalized i, but a character to the far right of the keyboard - a capitalized foreward slash \






Images

The contributor may consider adding an image to an entry. Images can effectively enhance future readers' experience and engagement.

Uploading an Image

To upload an image, either the RichTextEditor or the WikiTextEditor can be used - though more advanced image functions can only be attain using the latter.
Upon selecting the Edit tab, the contributor will notice the long, horizontal box on top of both editors that says "Drop files here," into which image files are simply dragged to upload an image:

DropFilesHere.png

After dragging the image file into the "Drop files here" box, select "Click here to upload this file" to load the image to the wiki. Once uploaded, the image can be inserted into any relevant entry in the future.

UploadthisFile.png