Archives Manual: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(107 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><br/></div>
<br/>For the purposes of this manual, you will henceforth be referred to as a [[Contributor|contributor]].</center></div>




----
= 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:
<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.
 


<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.




= Editing Content =


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


#RichTextEditor - default editing screen. ''Good for basic content/textual editing''.
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'':
#WikiTextEditor - accessed by clicking <u>[Show WikiTextEditor]</u>. Necessary for more advanced functions.
<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:


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.
<p style="text-align: center;"><span style="line-height: 1.6;">Click </span>[http://www.mediawiki.org/wiki/Help:Formatting here]&nbsp;<span style="line-height: 1.6;">for a basic guide to the formatting that can be applied using the WikiTextEditor.</span></p>
<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.
<center>[[File:ShowPreview.png|center]]</center>
*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.


<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!




== 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'':
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.
<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 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:
<center>[[File:NewPage.png]]</center>


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


*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. Upon saving the content of this entry, the contributor will have successfully created a new entry!


== 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 [[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.


== Using Templates ==
'''Before contributing to an existing entry''', contributors should review the protocol for&nbsp;[[Contributing to an Existing Entry|adding content]] to existing wiki pages.


Templates are an effective way to present a precise body of information across many wiki entries. A change to the content of an original template page will result in corresponding changes across all of the entries upon which the template has been inserted. This allows for the efficient conveyance of a message throughout the relevant pages. Contributors will likely not need to create new templates.


<br/>Inserting a template is very similar to inserting a link (see next section). A template is embedded using WikiTextEditor - enclose the title of the template in double ''braces'' — { } — within an entry in the desired location:
<center>'''Example:'''&nbsp;&#x7B;&#x7B;Example&#x7D;&#x7D;</center>
<br/>'''There are several templates that have been created for the use of the contributor that all should be aware of:'''


*'''Copyright:''' the Copyright template—'''© UNB Archives & Special Collections, 2014'''—has been inserted at the bottom of every entry in this wiki and should be inserted at the bottom of every entry created by the contributor.
== Signature ==
**This is intended to declare ownership and protect the information contained in the wiki pages.
*'''UnderDevelopment:''' the UnderDevelopment template declares to the reader that an entry, though initiated, has not yet been completed. As information for the entry is still being collected and refined, the contents of the page cannot yet be considered authoritative.
**This template should be inserted at the top of an entry that meets this description.


{{UnderDevelopment}}
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.


*'''Stubs:''' the Stub template declares to the reader that, while an entry is not yet completed, the information that it contains is authoritative. This is meant to indicate that the included sections of the entry have been completed, but that the entry still needs to be developed further.
**This template should be inserted at the top of an entry that meets this description.


{{Stub}}


*'''Images:'''
= 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 [[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:'''


*'''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]]


==  ==


= 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.
== Templates ==


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.


See&nbsp;[[Templates|Templates]]&nbsp;for a list of that templates that are most useful to Contributors.


== 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:
==  ==
<center>'''Example:''' &#x5B;&#x5B;Example&#x5D;&#x5D;</center>
*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.
== Categories ==
<br/><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]<br/></center>


[[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]].


== Linking with Alternate Text ==
[[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 =


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.
[[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.
<div style="border:2px solid black; background-color:white"><center>'''Consider this sentence:'''</center><center>Debating has long been a popular extracurricular activity at UNB.</center>
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, 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'':
<center>&#x5B;&#x5B;Literary and Debating Society|Debating&#x5D;&#x5D;&nbsp;has long been a popular extracurricular activity at UNB.</center><center>(Result:)&nbsp;<u><span style="color:#0000FF;">Debating</span></u>&nbsp;has long been a popular&nbsp;<span style="text-align: -webkit-center;">extracurricular activity at UNB.</span></center><center><br/></center><center>'''The pipe is not a capitalized '''i''', but a character to the far right of the keyboard - a capitalized foreward slash \'''</center></div>
----


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:


= Images =
*[[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]]


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




= Images =


== Uploading an Image ==
[[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:


'''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.'''<br/>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:
[[File:TheGateway.png|center]]
<center>[[File:DropFilesHere.png]]</center>
<center>'''Accessible at: [http://lib.unb.ca/archives/ http://lib.unb.ca/archives/]'''</center>
<br/>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.
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'.


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


<center>[[File:UploadthisFile.png|800x150px]]</center>
'''Once an appropriate image has been located, it must be''' [[Uploading and Embedding Images|uploaded and embedded]].


== Gallery Display ==


== Inserting an Image ==
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.


The simplest way to insert an image is by clicking the small image icon on the RichTextEditor menu:
<br/>--[[User:Markmcumber|MarkMcCumber]] 22 August 2014 (ADT)
<center>[[File:ImageIcon.png]]</center>
[[Category:Manual Pages|Citation]]<br/>[[Category:Mark's Contributions|Archives]]
The <u>exact</u> '''Image file name''' must be entered into this first field and, if the image has already been uploaded, it will appear in the search results returned in the box below the field. The contributor will also notice several fields by which the selected image can be manipulated.
<center>[[File:ImageManipulation.png]]<br/></center>
#'''Caption:''' The caption usually includes an explanation of the image and a proper citation.
#*Depending on the '''Special type''' selected for the image, the text inputted to this field will appear as a caption below the image; otherwise the caption will appear as the mouse cursor is placed over the image.
#*'''See the [[Citation Guide]] for the appropriate style and procedure.'''
#'''Special type:''' This field dictates in what format the image will appear within the entry.
#*Thumbnail and Frame formats will display a caption at the bottom of the image.
#*'''Thumbnail is the standard format used within this wiki.'''
#'''Alignment:''' This field dictates the position of the image on the page.
#*'''The standard selection is Right''', but having several images could warrant an alternative selection.
#*''The text will fill the space around the image, so selecting'' '''Center''' ''may be problematic.''
#'''Width''' & '''Height''' are numeric fields.
#*These fields dictate the size of the displayed version of the image.
#*For optimal quality (minimal distortion of the image) the numbers inputted in these fields should be equal in proportion of the original image.
<center>'''Example:''' If the original .jpg file was 1200x900, the modified dimensions should be 600x450 (50%) or 400x300 (33%).</center>

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"