Administrator Manual: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
No edit summary
 
(72 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{StudentManual}}
This will contain a manual for Administrators of the wiki.
This will contain a manual for Administrators of the wiki.
= Adding a New User =
Adding oneself to the wiki is no longer an option - too many spammers registered for the wiki in its early days, and the option has since been removed by IT. 
Registering new users is a quick and easy process as an administrator. Simply go to:
<center>[http://unbhistory.lib.unb.ca/index.php/Special:UserLogin http://unbhistory.lib.unb.ca/index.php/Special:UserLogin]</center>
As you are already logged in, the page that you're directed to will look something like this:
[[File:AlreadyLogged.png|center]]
Select '''Create another account'''; you will need to input a new username, password (which can be changed by the [[Contributor|contributor]] later), and an associated e-mail (optional - can be added at a later time by the contributor).
*Note: Username cannot be changed once it has been created.
= User Rights =
A wiki user's rights depends on the group to which they have been assigned. Only<span style="line-height: 1.6;">&nbsp;</span>[[Administrator|bureaucrats]]&nbsp;are able to move users from one group to another.&nbsp;
<span style="line-height: 1.6;">As a bureaucrat, go to&nbsp;</span>[http://unbhistory.lib.unb.ca/index.php/Special:UserRights http://unbhistory.lib.unb.ca/index.php/Special:UserRights]<span style="line-height: 1.6;">&nbsp;and search the user that you would like to move to another group.</span>
*Arts 3000 students should be placed immediately in the&nbsp;[[Contributor|contributors]]&nbsp;group.
*Upon finishing, they can simply be moved back into the regular users group - their profile will remain but they will no longer have editing privileges.


= Editing Content =
= Editing Content =
To review how to edit content within the wiki, go to the [[Archives Manual#Editing Content|Archives Manual]].
There are some advanced linking functions that may be useful an administrator:
*Linking to an [[Image Pages|Image Page]]
*Linking to a [[Linking to a Category Page|Category Page]]
*Linking to [[External Links]]
==== Changing an Entry/Page Title ====
There may be times when a title is incorrectly entered, or merely improved upon. It is possible to [[Entry/Page Title Change|change the title of an entry/page]].


= Organizing Content =
= Organizing Content =


As the wiki continues to expand, its organization will become increasingly complex and important to manage. These are some internal functions that will help make the organization of the wiki possible.
As the wiki continues to expand, its organization will become increasingly complex and important to manage. These are some internal functions that will help make the organization of the wiki possible.


== Categories ==
== Categories ==


Categories can be used to effectively group related entries. Categories can be further divided into ''subcategories'', which will allow for the gradual establishment of an organizational hierarchy within the wiki. This will facilitate browsing of the wiki by future readers.
[[Categories]] are used to group related entries. Entries are tagged using [[Categories#Using Category Tags|Category Tags]], which will result in the entry's inclusion on the corresponding Category Page. Once tagged, the categories to which an entry has been assigned will be displayed at the bottom of that entry.
 
 


=== Creating a New Category ===
==== Student Contributions Category Page ====


Creating a new category is similar to creating a new entry - at the end of the wiki's URL, insert Category:Category_Title (using _ instead of spacing). If the category already exists, the administrator will be brought to a category page that lists all of the entries already tagged with that category tag; if the category does not exist, the administrator will notice the option to Create the new category page.
Each Arts 3000 student contributor will be associated with a [[Student Contributions Category Page|category page]] documenting their contributions.
<br/><center>'''Example:''' [http://unbhistory.lib.unb.ca/index.php/Category:Example http://unbhistory.lib.unb.ca/index.php/Category:Example]</center>
<br/>[[File:NewCategory.png|center|800x200px]]


=== Using Category Tags ===


After a category page has been created, entries can be added to that category page through the application of ''category tags''. Category tags appear at the bottom of an entry and any number of category tags can be assigned to a given entry.


'''RichTextEditor:&nbsp;'''Select the Category icon on the toolbar:&nbsp;
== Table of Contents ==


[[File:CategorySymbol.png|center|20x20px]]
A '''Table of Contents''' will automatically appear at the top of an [[Entries and Pages|entry/page]] after several headers have been added to that entry/page.


*Enter the title of the category into the first field.  
*There may be some circumstances in which a Table of Contents is not needed but has been generated; it is possible to disable the Table of Contents by adding <nowiki>__NOTOC__</nowiki> (NOTOC flanked by a double [[Mark-up Language|underscore]]) to the [[Editors#WikiTextEditor|WikiTextEditor]]. This can be placed at the top of the page.
*The second field—Sortkey within category—allows for the reorganization of entries within the category page. If several entries assigned to a category begin with the same word, such as ''The'', the administrator should sort by the second word of the entry's title by placing this modified title into this field. '''This refers to the title of the entry being placed within a category, not the category itself.'''
*There may be other circumstances in which you would like the Table of Contents to appear at a specific spot on the entry/page other than the very top. To achieve this, add <nowiki>__FORCETOC__</nowiki> to the desired location with the WikiTextEditor.


'''WikiTextEditor:&nbsp;'''Similar to [[Archives Manual#Linking within the wiki|linking]], categories are enclosed by double square brackets and placed at the bottom of the entry. To establish a Sortkey, use a pipe ( | )&nbsp;
<center>'''Example:'''&nbsp;&#x5B;&#x5B;Category:Example&#x5D;&#x5D;</center>
[[File:CategoryTag.png|center]]
<br/><div style="border:2px solid black; background-color:white"><center>If the category exists and has been entered correctly it will appear as a blue hyperlink (<span style="color:#0000CD;"><u>Buildings</u></span>); if it does not yet exist, the hyperlink will be red (<span style="color:#B22222;"><u>Example</u></span>). If the link is red, the administrator can quickly create a new category with this title by clicking that red link.</center></div>
*'''Remember: All titles in MediaWiki are case-sensitive. Always check the title of the source page if a link does not function.'''
*When creating the category page, spaces '''must''' be replaced by underscores ( _ ) - otherwise your web browser will (likely) treat your effort like a Google search. However, when assigning category tags, spacing can be used. MediaWiki will automatically replace the spacing with underscores (this can be observed by looking at the WikiTextEditor coding after saving a category tag with spacing).




==== Horizontal Table of Contents ====


Some larger pages that list many entries have been listed alphabetically. The automatic Table of Contents generated lists vertically, but it is ideal instead to make this a [[Horizontal Table of Contents|horizontal Table of Contents]].


== Building a Table ==
There will be circumstances in future wiki development where the best way to present the information will be in [[Tables|table format]]. Consider using the table as an alternative to the simple listing of entry titles, especially when complimentary details are of importance and interest.
== Modifying the Sidebar ==
The sidebar is another way to effectively organize the wiki. The sidebar is essentially a list of pages dedicated to '''key topics'''. It is constantly visible to [[Reader|readers]] regardless of the section of the wiki that they are browsing.
As the wiki develops, changes will have to be made to the sidebar to accommodate the development of topics in UNB History. Modifying the sidebar is as easy as editing any other page, though it must be accessed in a particular manner.
<br/><center>The sidebar page can be found at:<br/>[http://unbhistory.lib.unb.ca/index.php/MediaWiki:Sidebar http://unbhistory.lib.unb.ca/index.php/MediaWiki:Sidebar]</center>
*To modify the sidebar simply edit this page, adding, altering, or removing links. To review how to add a new link visit the appropriate section in the [[Archives Manual#Linking within the Wiki|Archives Manual]].




Line 43: Line 97:
== Templates ==
== Templates ==


Here is how you would create a category like Page Under Development,
[[Templates]] are an effective way to communicate a consistent message across multiple wiki [[Entries and Pages|entries/pages]]. Templates are extremely useful because they are malleable - changing the content of the original template page will result in the mass modification of that template on every page that it has been placed.
<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>
 
Several templates have already been created for the use of student contributors, though future wiki initiatives may warrant the creation of new templates.
 
 
 
= Monitoring the Wiki =
 
One of the primary roles of the [[Administrator|administrator]] will be to monitor the wiki. [[MediaWiki]] has provided many tools to make this responsibility easier:


== Wiki Statistics ==


= Modifying the Sidebar =
MediaWiki automatically gathers statistics about usage within the wiki.<br/>Basic high-level statistics such as the number of pages, registered users, page edits, etc. can be found here:
<center>[http://unbhistory.lib.unb.ca/index.php/Special:Statistics http://unbhistory.lib.unb.ca/index.php/Special:Statistics]</center>


'''The sidebar is essentially a list of pages dedicated to key topics.'''<br/>As the wiki develops, changes will have to be made to the sidebar to accommodate subject developments. Changing the sidebar is as easy as modifying any other page, but it must be accessed in a particular manner.
<center>The sidebar page can be found at:<br/>[http://unbhistory.lib.unb.ca/index.php/MediaWiki:Sidebar http://unbhistory.lib.unb.ca/index.php/MediaWiki:Sidebar]</center><br/>
To modify the sidebar, simply edit this page and add or remove the desired links.
<center>''To review how to add a new link visit the appropriate section in the'' [[Archives Manual#Linking within the wiki|Archives Manual]].</center>


== Contributor & User Activity ==


Several [[Special Pages|special pages]] have been created to help monitor contributors' and users' activities on the wiki.


*A list of wiki users:&nbsp;
**[http://unbhistory.lib.unb.ca/index.php/Special:ListUsers http://unbhistory.lib.unb.ca/index.php/Special:ListUsers]


*A list of all the significant activity within the wiki in reverse chronological order:&nbsp;
**[http://unbhistory.lib.unb.ca/index.php/Special:Log http://unbhistory.lib.unb.ca/index.php/Special:Log]


*A list of recent edits to the wiki in reverse chronological order:&nbsp;
**[http://unbhistory.lib.unb.ca/index.php/Special:RecentChanges http://unbhistory.lib.unb.ca/index.php/Special:RecentChanges]


=  =
*A listing of wiki [[Entries and Pages|entries/pages]] from most recently created to oldest:&nbsp;
**[http://unbhistory.lib.unb.ca/index.php/Special:NewPages http://unbhistory.lib.unb.ca/index.php/Special:NewPages]


=  =
*A gallery of the '''most recent images''' (and files) uploaded to the wiki:&nbsp;
**[http://unbhistory.lib.unb.ca/index.php/Special:NewFiles http://unbhistory.lib.unb.ca/index.php/Special:NewFiles]


= Editing =
<br/>--[[User:Markmcumber|MarkMcCumber]] 22 August 2014 (ADT)
<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;">
[[Category:Manual Pages|Citation]][[Category:Mark's Contributions|Admin]]
<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>
&lt;img src="/images/2/2c/Screen_shot_2013-06-07_at_12.38.06_pm.png" _fck_mw_filename="Screen shot 2013-06-07 at 12.38.06 pm.png" _fck_mw_location="center" _fck_mw_type="border" alt="Screen shot 2013-06-07 at 12.38.06 pm.png" class="fck_mw_border fck_mw_center" /&gt; &lt;/div&gt;

Latest revision as of 07:27, 22 August 2014

Return to Student Manual.

This will contain a manual for Administrators of the wiki.

Adding a New User

Adding oneself to the wiki is no longer an option - too many spammers registered for the wiki in its early days, and the option has since been removed by IT. 

Registering new users is a quick and easy process as an administrator. Simply go to:

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

As you are already logged in, the page that you're directed to will look something like this:

AlreadyLogged.png

Select Create another account; you will need to input a new username, password (which can be changed by the contributor later), and an associated e-mail (optional - can be added at a later time by the contributor).

  • Note: Username cannot be changed once it has been created.


User Rights

A wiki user's rights depends on the group to which they have been assigned. Only bureaucrats are able to move users from one group to another. 

As a bureaucrat, go to http://unbhistory.lib.unb.ca/index.php/Special:UserRights and search the user that you would like to move to another group.

  • Arts 3000 students should be placed immediately in the contributors group.
  • Upon finishing, they can simply be moved back into the regular users group - their profile will remain but they will no longer have editing privileges.


Editing Content

To review how to edit content within the wiki, go to the Archives Manual.

There are some advanced linking functions that may be useful an administrator:

Changing an Entry/Page Title

There may be times when a title is incorrectly entered, or merely improved upon. It is possible to change the title of an entry/page.


Organizing Content

As the wiki continues to expand, its organization will become increasingly complex and important to manage. These are some internal functions that will help make the organization of the wiki possible.


Categories

Categories are used to group related entries. Entries are tagged using Category Tags, which will result in the entry's inclusion on the corresponding Category Page. Once tagged, the categories to which an entry has been assigned will be displayed at the bottom of that entry.


Student Contributions Category Page

Each Arts 3000 student contributor will be associated with a category page documenting their contributions.


Table of Contents

A Table of Contents will automatically appear at the top of an entry/page after several headers have been added to that entry/page.

  • There may be some circumstances in which a Table of Contents is not needed but has been generated; it is possible to disable the Table of Contents by adding __NOTOC__ (NOTOC flanked by a double underscore) to the WikiTextEditor. This can be placed at the top of the page.
  • There may be other circumstances in which you would like the Table of Contents to appear at a specific spot on the entry/page other than the very top. To achieve this, add __FORCETOC__ to the desired location with the WikiTextEditor.


Horizontal Table of Contents

Some larger pages that list many entries have been listed alphabetically. The automatic Table of Contents generated lists vertically, but it is ideal instead to make this a horizontal Table of Contents.


Building a Table

There will be circumstances in future wiki development where the best way to present the information will be in table format. Consider using the table as an alternative to the simple listing of entry titles, especially when complimentary details are of importance and interest.


Modifying the Sidebar

The sidebar is another way to effectively organize the wiki. The sidebar is essentially a list of pages dedicated to key topics. It is constantly visible to readers regardless of the section of the wiki that they are browsing.

As the wiki develops, changes will have to be made to the sidebar to accommodate the development of topics in UNB History. Modifying the sidebar is as easy as editing any other page, though it must be accessed in a particular manner.


The sidebar page can be found at:
http://unbhistory.lib.unb.ca/index.php/MediaWiki:Sidebar
  • To modify the sidebar simply edit this page, adding, altering, or removing links. To review how to add a new link visit the appropriate section in the Archives Manual.


Templates

Templates are an effective way to communicate a consistent message across multiple wiki entries/pages. Templates are extremely useful because they are malleable - changing the content of the original template page will result in the mass modification of that template on every page that it has been placed.

Several templates have already been created for the use of student contributors, though future wiki initiatives may warrant the creation of new templates.


Monitoring the Wiki

One of the primary roles of the administrator will be to monitor the wiki. MediaWiki has provided many tools to make this responsibility easier:

Wiki Statistics

MediaWiki automatically gathers statistics about usage within the wiki.
Basic high-level statistics such as the number of pages, registered users, page edits, etc. can be found here:

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


Contributor & User Activity

Several special pages have been created to help monitor contributors' and users' activities on the wiki.


--MarkMcCumber 22 August 2014 (ADT)