Archives Manual: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<div style="border:2px solid black; background-color:white"><center>'''As a contributor, perhaps you've just logged on to UNB's History at a Glance for the first time.'''</center>
<div style="border:2px solid black; background-color:white"><center><b>As a contributor, perhaps you've just logged on to UNB's History at a Glance for the first time.</b></center>
<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.
<p><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 <i>user page</i> that you can use to create a customized profile. After reading the section entitled <b>Editing Content</b>, 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></div>
</p>
 
<center>For the purposes of this manual, you will henceforth be referred to as <i>the contributor</i>.</center></div>
 
<p><br />
= Editing Content =
</p>
 
<h1> Editing Content </h1>
There are two simple languages available available to contributors for wiki editing.
<p>There are two simple languages available available to contributors for wiki editing.
 
</p>
#RichTextEditor - default editing screen. ''Good for basic content/textual editing''.
<ol>
#WikiTextEditor - accessed by clicking <u>[Show WikiTextEditor]</u>
<li>RichTextEditor - default editing screen. <i>Good for basic content/textual editing</i>.
 
</li>
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.
<li>WikiTextEditor - accessed by clicking <u>[Show WikiTextEditor]</u>
 
</li>
 
</ol>
<center>Click [http://www.mediawiki.org/wiki/Help:Formatting here] for a basic guide to the formatting that can be applied using the WikiTextEditor.</center>
<p>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.
<br/>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.
</p><p><br />
 
</p>
<br/>[[File:ShowPreview.png|720x200px]]
<center>Click <a href="http://www.mediawiki.org/wiki/Help:Formatting">here</a> for a basic guide to the formatting that can be applied using the WikiTextEditor.</center>
 
<p><br />After modifying an entry—before saving any changes—the contributor should strongly consider making use of the <b>Show preview</b> option next to the <b>Save Page</b> button - this allows the contributor to see the consequences of the changes made and modify any errors prior to saving them to the wiki.
*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.
</p><p><br /><img src="/images/9/99/ShowPreview.png" _fck_mw_filename="ShowPreview.png" _fck_mw_width="720" width="720" _fck_mw_height="200" height="200"  alt="" />
 
</p>
 
<ul>
 
<li>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 ==
</li>
 
</ul>
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'':
<p><br />
 
</p>
 
<h2> New Entries </h2>
<center>[http://unbhistory.lib.unb.ca/index.php/ http://unbhistory.lib.unb.ca/index.php/<i>Example</i>]</center>
<p>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 <i>Example</i>:
 
</p><p><br />
 
</p>
*If this title has already been assigned to an entry, the contributor will be directed to the existing entry.
<center><a href="http://unbhistory.lib.unb.ca/index.php/">http://unbhistory.lib.unb.ca/index.php/&lt;i&gt;Example&lt;/i&gt;</a></center>
*If this title has not yet been assigned, the contributor will be directed to a page similar to this:
<p><br />
 
</p>
<br/>[[File:NewPage.png|720x200px]]
<ul>
 
<li>If this title has already been assigned to an entry, the contributor will be directed to the existing entry.
<br/>*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!
</li>
 
<li>If this title has not yet been assigned, the contributor will be directed to a page similar to this:
 
</li>
 
= 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.<br/>To create an ''internal link'', enclose the '''title''' of the destination entry with double square brackets on either side:
 
 
<div style="border:2px solid black; background-color:white"><center>&#x5B;&#x5B;Example&#x5D;&#x5D;</center></div>
 
 
*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.
 
 
<center>A listing of all the links to non-existent entries can be found here:<br/>[http://unbhistory.lib.unb.ca/index.php/Special:WantedPages http://unbhistory.lib.unb.ca/index.php/Special:WantedPages].</center>
 
 
== 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.
<div style="border:2px solid black; background-color:white"><center>'''Consider this sentence:'''</center><p style="text-align: center;">Debating has long been a popular extracurricular activity at UNB.</p>
''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.''&nbsp;To create a link using alternate text,&nbsp;<span style="line-height: 1.6;">we must use what is called a ''pipe&nbsp;''— | — to indicate that the text following the pipe will serve as the hyperlink instead of the title of the destination page:</span>
<center>&#x5B;&#x5B;Literary and Debating Society|Debating&#x5D;&#x5D;&nbsp;has long been a popular extracurricular activity at UNB.</center><center><br/></center><center>The insertion of this text in the WikiTextEditor will result in a hyperlinked&nbsp;&nbsp;followed by the rest of the text.</center><center style="text-align: center;">'''The pipe is not a capitalized '''i,&nbsp;'''but a character to the far right of the keyboard - a capitalized foreward slash '''\&nbsp;</center></div>
 
 
== Assigning Categories ==
 
A categorical hierarchy has been established and should be developed built as needed sections are added to the wiki.
 
 
 
 
 
 
 
 
 
<br/>
 
 
 
Here is how you would create a category like Page Under Development,
<div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><span style="font-size:larger;"><span style="font-family: 'trebuchet ms', helvetica, sans-serif;"><font color="#222222">'''Create page:'''&nbsp;</font></span></span></div><div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><span style="font-size:larger;"><span style="font-family: 'trebuchet ms', helvetica, sans-serif;"><font color="#222222">Category:Page_Under_Development</font></span></span></div><div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><br/></div><div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><span style="font-size:larger;"><span style="font-family: 'trebuchet ms', helvetica, sans-serif;"><font color="#222222">'''Add this line to the end of all pages that you want to put in the above category'''</font></span></span></div><div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><span style="font-size:larger;"><span style="font-family: 'trebuchet ms', helvetica, sans-serif;"><font color="#222222">&#x5B;&#x5B;Category:Page Under Development&#x5D;&#x5D;</font></span></span></div><div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><br/></div><div style="color: rgb(0, 0, 0); line-height: 19.200000762939453px; font-family: 'Times New Roman';"><span style="font-size:larger;"><span style="font-family: 'trebuchet ms', helvetica, sans-serif;"><font color="#222222">Click on category to see all pages linked.</font></span></span></div>
 
 
= Adding Pages to the Sidebar =
<div class="level1" style="margin: 0px; padding: 0px; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
After creating pages, in order to add those pages to the sidebar. Follow the following steps.
 
 
 
[[File:Screen shot 2013-06-07 at 1.44.09 pm.png|border|center|Screen shot 2013-06-07 at 1.44.09 pm.png]]
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside;">
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Go to the address bar. In our case the url is&nbsp;[http://systems.lib.unb.ca/projects/archives/wiki/index.php/Main_Page site-url/Main_Page]</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Replace page name (Main_Page) in above case with “MediaWiki:Sidebar”.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">The new address looks like this,&nbsp;[http://systems.lib.unb.ca/projects/archives/wiki/index.php/MediaWiki:Sidebar site-url/MediaWiki:Sidebar]</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Go the above url and the wiki sidebar will be displayed.</div></li>
</ul>
</ul>
 
<p><br /><img src="/images/0/0c/NewPage.png" _fck_mw_filename="NewPage.png" _fck_mw_width="720" width="720" _fck_mw_height="200" height="200"  alt="" />
page-url|page-name (systems.lib.unb.ca/wiki/Test|Test)
</p><p><br />*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!
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
</p><p><br />
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Click on Edit.</div></li>
</p>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Make changes to the links according to the following rule</div></li>
<h1> Linking within the Wiki </h1>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Click “Save Page” and see changes in the navigation.</div></li>
<p>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.
</p><p><br />
</p>
<h2> Internal Links </h2>
<p>An <i>internal link</i> 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.<br />To create an <i>internal link</i>, enclose the <b>title</b> of the destination entry with double square brackets on either side:
</p><p><br />
</p>
<div style="border:2px solid black; background-color:white"><center>&#x5b;&#x5b;Example&#x5d;&#x5d;</center></div>
<p><br />
</p>
<ul>
<li>If the destination entry <b>exists</b> and has been <b>entered correctly</b> (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.
</li>
</ul>
</ul>
 
<ul>
 
<li>If the destination entry does <b>not exist</b>, 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 <i>lazy linking</i> - this can be an effective way to communicate to other contributors the pages that need to be created in the future.
 
</li>
 
 
=  =
 
=  =
 
= Editing =
<div class="level1" style="margin: 0px; padding: 0px; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;"><ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside;">
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">On clicking “edit this page”, an editor is displayed. This is the&nbsp;<abbr title="What You See Is What You Get" style="cursor: help; border-bottom-width: 1px; border-bottom-style: dotted;">WYSIWYG</abbr>&nbsp;editor.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Start typing in the space below.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">On finishing edits, click the Save Page button to save changes.</div></li>
</ul>
</ul>
</div>
<p><br />
[[File:Screen shot 2013-06-07 at 12.38.06 pm.png|border|center|Screen shot 2013-06-07 at 12.38.06 pm.png]]
</p>
<center>A listing of all the links to non-existent entries can be found here:<br /><a href="http://unbhistory.lib.unb.ca/index.php/Special:WantedPages">http://unbhistory.lib.unb.ca/index.php/Special:WantedPages</a>.</center>
<p><br />
</p>
<h2> Linking with Alternate Text </h2>
<p>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.
</p>
<div style="border:2px solid black; background-color:white"><center><b>Consider this sentence:</b></center><p style="text-align: center;">Debating has long been a popular extracurricular activity at UNB.</p>
<p><i>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.</i>&#160;To create a link using alternate text,&#160;<span style="line-height: 1.6;">we must use what is called a <i>pipe&#160;</i>— | — to indicate that the text following the pipe will serve as the hyperlink instead of the title of the destination page:</span>
</p>
<center>&#x5b;&#x5b;Literary and Debating Society|Debating&#x5d;&#x5d;&#160;has long been a popular extracurricular activity at UNB.</center><center><br /></center><center>The insertion of this text in the WikiTextEditor will result in a hyperlinked&#160;&#160;followed by the rest of the text.</center><center style="text-align: center;"><b>The pipe is not a capitalized </b>i,&#160;<b>but a character to the far right of the keyboard - a capitalized foreward slash </b>\&#160;</center></div>
<p><br />
</p>


= Images =
<h1> Images </h1>
<div class="level1" style="margin: 0px; padding: 0px; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<div class="level1" style="margin: 0px; padding: 0px; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
On clicking “edit this page”, you should notice a blue bar at the top of the editor with the following message “Drop files here”. This bar will be used to insert images in the text.
<p>On clicking “edit this page”, you should notice a blue bar at the top of the editor with the following message “Drop files here”. This bar will be used to insert images in the text.
 
</p><p><img src="/images/b/b3/Screen_shot_2013-06-07_at_1.07.12_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 1.07.12 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 1.07.12 pm.png" class="fck_mw_border fck_mw_center" />
[[File:Screen shot 2013-06-07 at 1.07.12 pm.png|border|center|Screen shot 2013-06-07 at 1.07.12 pm.png]]
</p>
 
<h2> </h2>
== ==
<h2> </h2>
 
<h2> Inserting Images </h2>
== ==
 
== Inserting Images ==
<div class="level2" style="margin: 0px; padding: 0px; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;"><ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside;">
<div class="level2" style="margin: 0px; padding: 0px; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;"><ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside;">
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Drag and drop an image over the blue bar with the message “Drop files here”.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Drag and drop an image over the blue bar with the message “Drop files here”.</div></li>
Line 144: Line 91:
</ul>
</ul>
</div>
</div>
[[File:Screen shot 2013-06-07 at 12.44.44 pm.png|border|center|Screen shot 2013-06-07 at 12.44.44 pm.png]]
<p><img src="/images/f/f2/Screen_shot_2013-06-07_at_12.44.44_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 12.44.44 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 12.44.44 pm.png" class="fck_mw_border fck_mw_center" />
 
</p><p><img src="/images/5/55/Screen_shot_2013-06-07_at_12.46.40_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 12.46.40 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 12.46.40 pm.png" class="fck_mw_border fck_mw_center" />
[[File:Screen shot 2013-06-07 at 12.46.40 pm.png|border|center|Screen shot 2013-06-07 at 12.46.40 pm.png]]
</p><p><br />
 
</p><p><img src="/images/3/39/Screen_shot_2013-06-07_at_2.35.07_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 2.35.07 pm.png" _fck_mw_location="left" alt="Screen shot 2013-06-07 at 2.35.07 pm.png" class="fck_mw_left" />
 
</p>
 
[[File:Screen shot 2013-06-07 at 2.35.07 pm.png|left|Screen shot 2013-06-07 at 2.35.07 pm.png]]
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Click on “Click here to upload this file” to upload the image.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Click on “Click here to upload this file” to upload the image.</div></li>
Line 160: Line 105:
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Choose an image by clicking on it and entering a caption for it in the Caption textbox.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Choose an image by clicking on it and entering a caption for it in the Caption textbox.</div></li>
</ul>
</ul>
 
<p><img src="/images/e/e7/Screeen.png" _fck_mw_filename="Screeen.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screeen.png" class="fck_mw_border fck_mw_center" />
[[File:Screeen.png|border|center|Screeen.png]]
</p><p><br />
 
</p><p><img src="/images/4/41/Screen2.png" _fck_mw_filename="Screen2.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen2.png" class="fck_mw_border fck_mw_center" />
 
</p>
 
[[File:Screen2.png|border|center|Screen2.png]]
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Choose if you want to make it a thumbnail or an image with a border around it from the dropdown “Special type”.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Choose if you want to make it a thumbnail or an image with a border around it from the dropdown “Special type”.</div></li>
</ul>
</ul>
 
<p><img src="/images/6/69/Screenhome.png" _fck_mw_filename="Screenhome.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screenhome.png" class="fck_mw_border fck_mw_center" />
[[File:Screenhome.png|border|center|Screenhome.png]]
</p><p><img src="/images/d/dc/Screenmed.png" _fck_mw_filename="Screenmed.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screenmed.png" class="fck_mw_border fck_mw_center" />
 
</p><p><br />
[[File:Screenmed.png|border|center|Screenmed.png]]
</p><p><br />
 
</p>
 
 
 
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<ul style="margin: 0px 0px 1.4em; padding-right: 0px; padding-left: 1.5em; list-style: square outside; font-family: Arial, sans-serif; font-size: 14px; line-height: 19.600000381469727px;">
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">In this case, I will choose a Frame around the image and click “OK”.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">In this case, I will choose a Frame around the image and click “OK”.</div></li>

Revision as of 07:14, 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]

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 <a href="http://www.mediawiki.org/wiki/Help:Formatting">here</a> 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.


<img src="/images/9/99/ShowPreview.png" _fck_mw_filename="ShowPreview.png" _fck_mw_width="720" width="720" _fck_mw_height="200" height="200" alt="" />

  • 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:


<a href="http://unbhistory.lib.unb.ca/index.php/">http://unbhistory.lib.unb.ca/index.php/<i>Example</i></a>


  • 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:


<img src="/images/0/0c/NewPage.png" _fck_mw_filename="NewPage.png" _fck_mw_width="720" width="720" _fck_mw_height="200" height="200" alt="" />


*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:
<a href="http://unbhistory.lib.unb.ca/index.php/Special:WantedPages">http://unbhistory.lib.unb.ca/index.php/Special:WantedPages</a>.


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:

[[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.
The pipe is not a capitalized i, but a character to the far right of the keyboard - a capitalized foreward slash \ 


Images

On clicking “edit this page”, you should notice a blue bar at the top of the editor with the following message “Drop files here”. This bar will be used to insert images in the text.

<img src="/images/b/b3/Screen_shot_2013-06-07_at_1.07.12_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 1.07.12 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 1.07.12 pm.png" class="fck_mw_border fck_mw_center" />

Inserting Images

  • Drag and drop an image over the blue bar with the message “Drop files here”.
  • You will see your image listed in the bar.

<img src="/images/f/f2/Screen_shot_2013-06-07_at_12.44.44_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 12.44.44 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 12.44.44 pm.png" class="fck_mw_border fck_mw_center" />

<img src="/images/5/55/Screen_shot_2013-06-07_at_12.46.40_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 12.46.40 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 12.46.40 pm.png" class="fck_mw_border fck_mw_center" />


<img src="/images/3/39/Screen_shot_2013-06-07_at_2.35.07_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 2.35.07 pm.png" _fck_mw_location="left" alt="Screen shot 2013-06-07 at 2.35.07 pm.png" class="fck_mw_left" />

  • Click on “Click here to upload this file” to upload the image.
  • The image is uploaded, and the bar turns green.
  • To insert the image click on the “Image” icon in the editor.
  • On clicking the image icon, the editor prompts with a dialog box, containing the list of images uploaded in the wiki.
  • Choose an image by clicking on it and entering a caption for it in the Caption textbox.

<img src="/images/e/e7/Screeen.png" _fck_mw_filename="Screeen.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screeen.png" class="fck_mw_border fck_mw_center" />


<img src="/images/4/41/Screen2.png" _fck_mw_filename="Screen2.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen2.png" class="fck_mw_border fck_mw_center" />

  • Choose if you want to make it a thumbnail or an image with a border around it from the dropdown “Special type”.

<img src="/images/6/69/Screenhome.png" _fck_mw_filename="Screenhome.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screenhome.png" class="fck_mw_border fck_mw_center" />

<img src="/images/d/dc/Screenmed.png" _fck_mw_filename="Screenmed.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screenmed.png" class="fck_mw_border fck_mw_center" />



  • In this case, I will choose a Frame around the image and click “OK”.
  • Click Save page to save your edits.
  • You can put the image in the center of the page using another option in the image dialog box, i.e. if you want to place the image in the center, choose center from the options dropdown.
= =

</div>

Retrieved from "https://unbhistory.lib.unb.ca/index.php?title=Archives_Manual&oldid=3093"