Archives Manual: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(162 intermediate revisions by one other user not shown)
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"><br/><center>'''As a [[Contributor|contributor]], perhaps you've just logged on to UNB's History at a Glance for the first time.'''
<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 [[Profile Page|customized profile]]. After reading the section entitled [[#Editing_Content|editing content]], consider testing the editing functions on your user page to create a basic profile. Include some information about yourself, your studies, and the areas of the wiki to which you've been asked to contribute. You can edit your user page at any point in the future.
<center>For the purposes of this manual, you will henceforth be referred to as ''the contributor''.</center></div>
<br/>For the purposes of this manual, you will henceforth be referred to as a [[Contributor|contributor]].</center></div>




= Editing Content =
= Editing Content =


There are two simple languages available available to contributors for wiki editing.
Before creating any wiki content read this guide for writing wiki articles provided by Wikipedia, which should prove valuable to both the new and experienced contributor alike:
<center>'''[http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles]'''</center>
<br/>Creating and editing content with MediaWiki is text-based. There are two languages accessible to contributors for [[Editors|wiki editing]].
<p style="text-align: center;">'''<span style="line-height: 1.6;">As a contributor, you will primarily rely on the RichTextEditor when developing entries.</span>'''</p><p style="text-align: center;">'''<span style="line-height: 1.6;">See the&nbsp;</span>'''<span style="line-height: 1.6;">[[Style Guide|Style Guide]]&nbsp;'''for formatting guidelines.'''</span></p>
After modifying an entry—before saving any changes—the contributor should try to use the '''Show preview''' option next to the '''Save Page''' button, which allows the contributor to see the consequences of any changes before saving them.


#RichTextEditor - default editing screen. ''Good for basic content/textual editing''.
#WikiTextEditor - accessed by clicking <u>[Show WikiTextEditor]</u>


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.
<center>[[File:ShowPreview.png|center]]</center>
 
*Note the '''Summary field'''&nbsp;as well - this should be utilized when editing content created by another contributor, justifying any changes that were made.
 
<div style="border:2px solid black; background-color:white"><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></div>
<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.
 
<br/>[[File:ShowPreview.png|720x200px]]
 
*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.




Line 25: Line 20:
== New Entries ==
== 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'':
The simplest way that the contributor can [[Entries and Pages|create a new entry]] is by adding the title of the new entry to the wiki's base URL - inserting the URL below would initiate an effort to create a page entitled ''Example'':
<p style="text-align: center">[http://unbhistory.lib.unb.ca/index.php/Example http://unbhistory.lib.unb.ca/index.php/Example]</p>
*If this title has '''already been&nbsp;used'''&nbsp;to create an entry,&nbsp;the contributor will be directed to the'''''&nbsp;''existing entry'''.
*If this title has not yet been assigned to an entry, the contributor will be directed to a page similar to this:




<div style="border:2px solid black; background-color:white"><center>[http://unbhistory.lib.unb.ca/index.php/ http://unbhistory.lib.unb.ca/index.php/<i>Example</i>]</center></div>
<center>[[File:NewPage.png]]</center><center><br/></center>
*Note the option to <span style="color:#0000FF"><u>Create</u></span> next to the Search Box - clicking this will initiate the creation of a new entry.&nbsp;By selecting the&nbsp;<u style="color: rgb(0, 0, 255)">Create</u> tab, the Contributor will automatically open an&nbsp;[[Editors|editing interface]] and can begin to develop the entry. Upon saving this newly created content, the contributor will have successfully created a new entry!




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


<br/>[[File:NewPage.png|720x200px]]
Another way to create a new entry is to use the [[Search Box|search box]]&nbsp;to search for the prospective page that you would like to create. If there is no entry with the&nbsp;'''exact'''&nbsp;words searched, you will be provided an option to create that page - select the hyperlink provided and follow the corresponding steps mentioned above.


<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!
*Remember that the historical accuracy of your content is very important. In order for the wiki to be an [[Authoritative|authoritative source]], the information included must be relevant and accurate.
**Again, review this article created by Wikipedia includes many tips that make a successful wiki article and contributor:
<p style="text-align: center;">'''[http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles]'''</p>




== Existing Entries ==


= Linking within the Wiki =
As the wiki involves the progressive and perpetual participation of many contributors over time, there will be circumstances in which contributors may be asked to further develop the contents of [[Contributing to an Existing Entry|existing entries]]. Contributing toward and completing existing but incomplete entries is just as important—if not more so—than contributing original content because a fully developed and complete entry is valuable&nbsp;than an incomplete entry.


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.
'''Before contributing to an existing entry''', contributors should review the protocol for&nbsp;[[Contributing to an Existing Entry|adding content]] to existing wiki pages.






== Internal Links ==
== Signature ==


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:
As with any written work, the authors of a given text must be recognized - the wiki entry is no exception! By placing a [[Signature|digital signature]] at the bottom of a finished entry, the contributor has declared that the piece has been completed and claiming ownership for that completion.




<div style="border:2px solid black; background-color:white"><center>&#x5B;&#x5B;Example&#x5D;&#x5D;</center></div>


= Consistency =


*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.
Consistency is an important consideration when creating content for the wiki. Fortunately, MediaWiki facilitates consistency by allowing for customizable default settings that apply throughout the wiki. The default font for this wiki is '''Helvetica''', size 10. If the font, for any reason, has changed, the contributor can enter the [[Editors|WikiTextEditor]] of a given page and observe a string of text indicating change in font:
<p style="text-align: center">&lt;span style="font-family:courier new,courier,monospace;"&gt;<span style="font-family:courier new,courier,monospace">font changed</span>&lt;/span&gt;</p><p style="text-align: center">By deleting the '''&lt;span style&gt;''' commands (the text within &lt; &gt;) any formatting changes they have instigated will be '''undone''', but remember as well to delete the corresponding&nbsp;<nowiki></span></nowiki>, as it will appear as text on the page after the initial command has been removed.</p>
<br/><br/>In circumstances where [[Entries and Pages|entries]] are being added to a greater category with entries that have already been constructed, the contributor should replicate the format consistent in those other entries. '''Some categories of the wiki have template pages that can be copied and pasted into new wiki entries:'''


*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.
*'''Activities:&nbsp;'''[[Activities Template|Activities Template]]
*'''Buildings:&nbsp;'''[[Buildings Template|Buildings Template]]
*'''Departments:&nbsp;'''[[Departments Template|Departments Template]]
*'''Events:&nbsp;'''[[Events Template|Events Template]]
*'''People: '''[[People Template|People Template]]


==  ==


<div style="border:2px solid black; background-color:white"><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></div>
==  ==


== Templates ==


== Linking with Alternate Text ==
Communicating consistent messages on many pages throughout the wiki can be a valuable tool. This is done most effectively using [[Templates|templates]]. A modification to the original template page will result in the modification to this template throughout the wiki, changing the message on every [[Entries and Pages|entry/page]] that the template has been embedded.


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.
See&nbsp;[[Templates|Templates]]&nbsp;for a list of that templates that are most useful to Contributors.
<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.
== Categories ==


[[Categories|Categories]]&nbsp;are used to organize the wiki. Each entry will belong to one or more category. Category tags can be found at the bottom of any&nbsp;[[Entries and Pages|entry/page]].


[[Contributor|Contributors]]&nbsp;will&nbsp;<u>not</u>&nbsp;be responsible for applying category tags.&nbsp;[[Administrator|Administrators]]&nbsp;will assign new entries to categories.
<div><br/></div>
= Linking within the Wiki =


[[Linking|Linking]] is one of the most powerful functions enabled through the MediaWiki software. A well-constructed wiki will provide [[Reader|readers]] the means to browse fluidly from page to entry to entry as—ideally—the essential information will be complimented by [[Linking|hyperlinks]] to all related [[Entries and Pages|entries/pages]]. When an entry is not linked to others, it will be difficult for the reader to find through browsing. Although it will still be possible to discover entries/pages with the [[Search Box]], the increased accessibility attained through appropriate and relevant linking will add value to the wiki and benefit the reader.


A page without links is not nearly as valuable as a page with links. The [[Contributor|contributor]] should always make an effort to embed links when appropriate.


Contributors can also benefit the wiki by developing pages that have no embedded links - called '''Dead-End Pages'''. There exists a [[Special Pages#Dead End Pages|special page]] that lists all of the Dead-End Pages:
<center>[http://unbhistory.lib.unb.ca/index.php/Special:DeadendPages http://unbhistory.lib.unb.ca/index.php/Special:DeadendPages]</center>
The Contributor can [[Linking|link]] to:


*[[Linking#Internal Links|Internal wiki entries/pages]]
*Internal wiki entries/pages that have not yet been created - [[Linking#Lazy Linking|Lazy Linking]]
*[[Linking#Anchors (Link to a Specific Place on a Page)|Anchors]]




<br/><br/><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>
page-url|page-name (systems.lib.unb.ca/wiki/Test|Test)
<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 Edit.</div></li>
<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>
<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>
</ul>
=  =
=  =
= 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>
</div>
[[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]]


= Images =
= Images =
<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.
[[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]]
==  ==
==  ==
== 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;">
<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);">You will see your image listed in the bar.</div></li>
</ul>
</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]]
[[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]]
[[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;">
<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);">The image is uploaded, and the bar turns green.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">To insert the image click on the “Image” icon in the editor.</div></li>
</ul>
<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);">On clicking the image icon, the editor prompts with a dialog box, containing the list of images uploaded in the wiki.</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>
[[File:Screeen.png|border|center|Screeen.png]]


[[File:Screen2.png|border|center|Screen2.png]]
[[Contributor|Contributors]] can enhance the appeal of an entry by embedding appropriate images related to the topic. Many images held within the UNB Archives & Special Collections have been scanned and are searchable in ''The Gateway'' database:
<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>
</ul>


[[File:Screenhome.png|border|center|Screenhome.png]]
[[File:TheGateway.png|center]]
<center>'''Accessible at: [http://lib.unb.ca/archives/ http://lib.unb.ca/archives/]'''</center>
Upon locating a desired image in&nbsp;''The Gateway'', this image can be saved to the computer by right clicking the thumbnail of the image (the small copy portrayed to the right of the search results upon choosing a result) then selecting 'Save Image As'.


[[File:Screenmed.png|border|center|Screenmed.png]]
*Save the image under a simple title related to the topic so that it is easier to find while completing the next steps.
*Also, consider saving the image either to the desktop or a designated folder so that it is easy to locate in case the title is forgotten.


'''Once an appropriate image has been located, it must be''' [[Uploading and Embedding Images|uploaded and embedded]].


== Gallery Display ==


Categories or pages with a significant number of images complimenting entries can be attractively presented as [[Image Gallery|an image gallery]] (see subcategory Residences: [[:Category:Residences|click here]]). This should only be done if the majority of entries have corresponding images, after consulting a member of the wiki [[Administrator|administration]]&nbsp;from the Archives & Special Collections.


<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;">
<br/>--[[User:Markmcumber|MarkMcCumber]] 22 August 2014 (ADT)
<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>
[[Category:Manual Pages|Citation]]<br/>[[Category:Mark's Contributions|Archives]]
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">Click Save page to save your edits.</div></li>
<li><div class="li" style="margin: 0px; padding: 0px; color: rgb(51, 51, 51);">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></li>
</ul>
= =</div></div>&lt;/div&gt;

Latest revision as of 09:04, 3 October 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 your user page to create a basic profile. Include some information about yourself, your studies, and the areas of the wiki to which you've been asked to contribute. You can edit your user page at any point in the future.


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


Editing Content

Before creating any wiki content read this guide for writing wiki articles provided by Wikipedia, which should prove valuable to both the new and experienced contributor alike:

http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles


Creating and editing content with MediaWiki is text-based. There are two languages accessible to contributors for wiki editing.

As a contributor, you will primarily rely on the RichTextEditor when developing entries.

See the Style Guide for formatting guidelines.

After modifying an entry—before saving any changes—the contributor should try to use the Show preview option next to the Save Page button, which allows the contributor to see the consequences of any changes before saving them.


ShowPreview.png
  • Note the Summary field as well - this should be utilized when editing content created by another contributor, justifying any changes that were made.


New Entries

The simplest way that the contributor can create a new entry is by adding the title of the new entry to the wiki's base URL - inserting the URL below would initiate an effort to create a page entitled Example:

http://unbhistory.lib.unb.ca/index.php/Example

  • If this title has already been used to create an entry, the contributor will be directed to the existing entry.
  • If this title has not yet been assigned to an entry, 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. By selecting the Create tab, the Contributor will automatically open an editing interface and can begin to develop the entry. Upon saving this newly created content, the contributor will have successfully created a new entry!


Another way to create a new entry is to use the search box to search for the prospective page that you would like to create. If there is no entry with the exact words searched, you will be provided an option to create that page - select the hyperlink provided and follow the corresponding steps mentioned above.

  • Remember that the historical accuracy of your content is very important. In order for the wiki to be an authoritative source, the information included must be relevant and accurate.
    • Again, review this article created by Wikipedia includes many tips that make a successful wiki article and contributor:

http://en.wikipedia.org/wiki/Wikipedia:Writing_better_articles


Existing Entries

As the wiki involves the progressive and perpetual participation of many contributors over time, there will be circumstances in which contributors may be asked to further develop the contents of existing entries. Contributing toward and completing existing but incomplete entries is just as important—if not more so—than contributing original content because a fully developed and complete entry is valuable than an incomplete entry.

Before contributing to an existing entry, contributors should review the protocol for adding content to existing wiki pages.


Signature

As with any written work, the authors of a given text must be recognized - the wiki entry is no exception! By placing a digital signature at the bottom of a finished entry, the contributor has declared that the piece has been completed and claiming ownership for that completion.


Consistency

Consistency is an important consideration when creating content for the wiki. Fortunately, MediaWiki facilitates consistency by allowing for customizable default settings that apply throughout the wiki. The default font for this wiki is Helvetica, size 10. If the font, for any reason, has changed, the contributor can enter the WikiTextEditor of a given page and observe a string of text indicating change in font:

<span style="font-family:courier new,courier,monospace;">font changed</span>

By deleting the <span style> commands (the text within < >) any formatting changes they have instigated will be undone, but remember as well to delete the corresponding </span>, as it will appear as text on the page after the initial command has been removed.



In circumstances where entries are being added to a greater category with entries that have already been constructed, the contributor should replicate the format consistent in those other entries. Some categories of the wiki have template pages that can be copied and pasted into new wiki entries:

Templates

Communicating consistent messages on many pages throughout the wiki can be a valuable tool. This is done most effectively using templates. A modification to the original template page will result in the modification to this template throughout the wiki, changing the message on every entry/page that the template has been embedded.

See Templates for a list of that templates that are most useful to Contributors.

Categories

Categories are used to organize the wiki. Each entry will belong to one or more category. Category tags can be found at the bottom of any entry/page.

Contributors will not be responsible for applying category tags. Administrators will assign new entries to categories.


Linking within the Wiki

Linking is one of the most powerful functions enabled through the MediaWiki software. A well-constructed wiki will provide readers the means to browse fluidly from page to entry to entry as—ideally—the essential information will be complimented by hyperlinks to all related entries/pages. When an entry is not linked to others, it will be difficult for the reader to find through browsing. Although it will still be possible to discover entries/pages with the Search Box, the increased accessibility attained through appropriate and relevant linking will add value to the wiki and benefit the reader.

A page without links is not nearly as valuable as a page with links. The contributor should always make an effort to embed links when appropriate.

Contributors can also benefit the wiki by developing pages that have no embedded links - called Dead-End Pages. There exists a special page that lists all of the Dead-End Pages:

http://unbhistory.lib.unb.ca/index.php/Special:DeadendPages

The Contributor can link to:


Images

Contributors can enhance the appeal of an entry by embedding appropriate images related to the topic. Many images held within the UNB Archives & Special Collections have been scanned and are searchable in The Gateway database:

TheGateway.png
Accessible at: http://lib.unb.ca/archives/

Upon locating a desired image in The Gateway, this image can be saved to the computer by right clicking the thumbnail of the image (the small copy portrayed to the right of the search results upon choosing a result) then selecting 'Save Image As'.

  • Save the image under a simple title related to the topic so that it is easier to find while completing the next steps.
  • Also, consider saving the image either to the desktop or a designated folder so that it is easy to locate in case the title is forgotten.

Once an appropriate image has been located, it must be uploaded and embedded.

Gallery Display

Categories or pages with a significant number of images complimenting entries can be attractively presented as an image gallery (see subcategory Residences: click here). This should only be done if the majority of entries have corresponding images, after consulting a member of the wiki administration from the Archives & Special Collections.


--MarkMcCumber 22 August 2014 (ADT)

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