Categories: Difference between revisions

From UNB Archives and Special Collections
Jump to navigation Jump to search
No edit summary
No edit summary
 
(33 intermediate revisions by the same user not shown)
Line 2: Line 2:


'''Categories''' are used to organize related [[Entries and Pages|entries]] dispersed throughout the wiki. Categories can be further divided into [[#Creating_Subcategories|subcategories]], which will provide for the gradual development of a hierarchical organization of pages within the wiki. This organization will facilitate future readers' browsing of the wiki.
'''Categories''' are used to organize related [[Entries and Pages|entries]] dispersed throughout the wiki. Categories can be further divided into [[#Creating_Subcategories|subcategories]], which will provide for the gradual development of a hierarchical organization of pages within the wiki. This organization will facilitate future readers' browsing of the wiki.
'''Categories are to be assigned by '''[[Administrator|administrators]].


= Creating a New Category =
= Creating a New Category =


Creating a new category is similar to creating a [[Archives Manual#New Entries|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.
Creating a new category is similar to creating a [[Archives Manual#New Entries|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.
*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).
<br/><center>'''Example:''' [http://unbhistory.lib.unb.ca/index.php/Category:Example http://unbhistory.lib.unb.ca/index.php/Category:Example]</center>
<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]]
<br/>[[File:NewCategory.png|center|800x200px]]
Line 15: Line 19:
Once a category page has been created, entries can be added to that category by applying '''category tags'''. Category tags appear at the bottom of an entry and any number of category tags can be assigned to a given entry.
Once a category page has been created, entries can be added to that category by applying '''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 ==


<br/>Select the Category icon on the toolbar:
 
== RichTextEditor (Recommended) ==
 
Select the Category icon on the toolbar:


[[File:CategorySymbol.png|center|20x20px]]
[[File:CategorySymbol.png|center|20x20px]]


*Enter the title of the category into the first field.
*Enter the title of the category into the first field.
*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.'''
*The second field—Sortkey within category—allows for the organization of entries within the category page. Items will be sorted on the Category Page by the title entered into this field.
 
[[File:CategorySortkey.png|center]]
 
<br/>Use '''Sortkey within category''' to easily avoid [[#Issues|a tedious issue]] - within this field enter the '''modified title'''&nbsp;of the entry/page that you are assigning to&nbsp;the Category Page. If the title is not effectively modified the function will work initially but become undone upon future edits. To effectively '''modify the title''', simply remove the last letter or word from the official title of the [[Entries and Pages|entry/page]].
 
 


== WikiTextEditor ==
== WikiTextEditor ==


<br/>Similar to creating a [[Archives Manual#Linking within the wiki|link]], the title of the Category must be enclosed in double square brackets at the bottom of the entry. To establish a Sortkey (as described in the RichTextEditor section above), use a [[Mark-up Language|pipe]] ( | ) to separate the title of the applied Category from the '''modified title''' (the title by which the page will be sorted by on the Category page) of the entry:
Similar to creating a [[Archives Manual#Linking within the wiki|link]], the title of the Category must be enclosed in double square brackets at the bottom of the entry.
<br/><center>'''Example:''' adding ''The Great Gatsby'' to the Example category (sort by ''Great'' instead of ''The'')<br/><nowiki>[[Category:Example|Great Gatsby]]</nowiki> [[File:CategoryTag.png|center]]<br/></center><div style="border:2px solid black; background-color:white"><br/><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:#FF0000;"><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.<br/></center><br/></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).


*'''Remember: All titles in MediaWiki are case-sensitive. '''Always check the title of the source page if a link does not function.


[[File:CategoryTag.png|center]]<br/><br/><div style="border:2px solid black; background-color:white"><br/><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:#FF0000;"><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.<br/></center><br/></div>
===  ===
=== Manually Establishing a Sortkey ===
To manually establish a Sortkey (as described in the [[Editors|RichTextEditor]] section just above), use a [[Mark-up Language|pipe]] ( | ) to separate the title of the Category from the '''modified title''' (the title by which the entry will be sorted by on the Category page) of the entry:
<br/><center>'''Example:''' adding ''The Great Gatsby'' to the Example category (sort by ''Great'' instead of ''The'')<br/><nowiki>[[Category:Example|Great Gatsby]]</nowiki></center>
= Creating Subcategories =
= Creating Subcategories =
Subcategories can be created to help a broader themed category. These relationships can grow infinitely in either direction. Any category can belong to several broader categories, depending on the desired organizational structure.<br/>To create a subcategory, simple attach the category tag of the broader category to the subcategory.<center>'''Example:''' ''Fredericton'' and ''Saint John'' are desired subcategories of the '''Buildings''' category. To establish this, attach the '''Buildings''' category tag to the category page of the desired subcategories.</center>
= '''Issues''' =
<div style="border:2px solid black; background-color:white"><br/><center><u>Prior administering Category Tags</u>, '''the Administrator should be aware of several issues that result from tagging:'''</center><br/></div>
<br/>'''Issue 1:''' Once an entry has been tagged with 3 or more Category Tags, unwanted automatic spacing will appear at the bottom of the page for no apparent reason '''every time that the entry is saved''' — ''including the editing of a page that did not have this spacing just moments before.''
*To eliminate this spacing, open the [[Editors|WikiTextEditor]] and scroll to the bottom of the editing box - there, numerous <nowiki><br/></nowiki> will be visible both (lined up) after the [[Templates#Copyright|Copyright template code]] and between all of the Category tags. Delete '''all''' of these <nowiki><br/></nowiki>.
<br/>'''Issue 2:''' <u>Avoid</u> using special characters (&, #, @, $, *, etc...) in '''category titles''' because they will cause problems when tagging.


Subcategories can be created to help a broader themed category. These relationships can grow infinitely in either direction. Any category can belong to several broader categories, depending on the desired organizational structure.<br/>To create a subcategory, simple attach the category tag of the broader category to the subcategory.
<br/>'''Issue 3:''' Many Categories have titles of two words or more, <u>which causes a problem in the organization of entries</u> on Category Pages.
<center>'''Example:''' ''Fredericton'' and ''Saint John'' are desired subcategories of the '''Buildings''' category. To establish this, attach the '''Buildings''' category tag to the category page of the desired subcategories.


= Known Issues =
*To solve this problem, '''Sortkeys''' must be utilized on '''all''' category tags with titles of two words or more.


<div style="border:2px solid black; background-color:white"><br/><center>Before administering Category Tags, '''it will be advantageous to the Administrator to be aware of several issues <u>before</u> beginning the process''' — fixing these issues afterward will prove very tedious.</center>
<br/>--[[User:Markmcumber|MarkMcCumber]] ([[User talk:Markmcumber|talk]]) 1 July 2014 (ADT)
<br/>'''Issue 1:''' Once an entry has been tagged with 3 or more Category Tags, unwanted automatic spacing will appear at the bottom of the page for no apparent reason '''every time that the entry is saved - including the editing of a page that did not have this spacing just moments before.'''
[[Category:Mark's Contributions|Category]]<br/>[[Category:Manual Pages|Category]]
<br/><center><u>To eliminate this spacing</u>:<br/>Open the [[Editors|WikiTextEditor]] and scroll to the bottom of the editing box - there, numerous <nowiki><br/></nowiki> will be visible both (lined up) after the Copyright template code and between all of the Category tags. '''Delete all of these <nowiki><br/></nowiki>.'''</center>
<br/>'''Issue 2:''' '''Avoid''' using special characters (&, #, @, $,&nbsp;%, *, etc...) in '''category titles''' because they will cause problems when tagging.
<br/>'''Issue 3:''' Many [[Categories]] have titles of two words or more, which causes a problem in the organization of entries on Category Pages. To solve this problem, '''Sortkeys''' must be utilized on '''all''' category tags with titles of two words or more.<br/></center></div>

Latest revision as of 09:07, 17 July 2014

Return to Student Manual.
Return to Administrator Manual.

Categories are used to organize related entries dispersed throughout the wiki. Categories can be further divided into subcategories, which will provide for the gradual development of a hierarchical organization of pages within the wiki. This organization will facilitate future readers' browsing of the wiki.

Categories are to be assigned by administrators.

Creating a New Category

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.

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


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


NewCategory.png

Using Category Tags

Once a category page has been created, entries can be added to that category by applying 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 (Recommended)

Select the Category icon on the toolbar:

CategorySymbol.png
  • Enter the title of the category into the first field.
  • The second field—Sortkey within category—allows for the organization of entries within the category page. Items will be sorted on the Category Page by the title entered into this field.
CategorySortkey.png


Use Sortkey within category to easily avoid a tedious issue - within this field enter the modified title of the entry/page that you are assigning to the Category Page. If the title is not effectively modified the function will work initially but become undone upon future edits. To effectively modify the title, simply remove the last letter or word from the official title of the entry/page.


WikiTextEditor

Similar to creating a link, the title of the Category must be enclosed in double square brackets at the bottom of the entry.

  • Remember: All titles in MediaWiki are case-sensitive. Always check the title of the source page if a link does not function.


CategoryTag.png




If the category exists and has been entered correctly it will appear as a blue hyperlink (Buildings); if it does not yet exist, the hyperlink will be red (Example). If the link is red, the administrator can quickly create a new category with this title by clicking that red link.


Manually Establishing a Sortkey

To manually establish a Sortkey (as described in the RichTextEditor section just above), use a pipe ( | ) to separate the title of the Category from the modified title (the title by which the entry will be sorted by on the Category page) of the entry:


Example: adding The Great Gatsby to the Example category (sort by Great instead of The)
[[Category:Example|Great Gatsby]]

Creating Subcategories

Subcategories can be created to help a broader themed category. These relationships can grow infinitely in either direction. Any category can belong to several broader categories, depending on the desired organizational structure.
To create a subcategory, simple attach the category tag of the broader category to the subcategory.

Example: Fredericton and Saint John are desired subcategories of the Buildings category. To establish this, attach the Buildings category tag to the category page of the desired subcategories.


Issues


Prior administering Category Tags, the Administrator should be aware of several issues that result from tagging:


Issue 1: Once an entry has been tagged with 3 or more Category Tags, unwanted automatic spacing will appear at the bottom of the page for no apparent reason every time that the entry is savedincluding the editing of a page that did not have this spacing just moments before.

  • To eliminate this spacing, open the WikiTextEditor and scroll to the bottom of the editing box - there, numerous <br/> will be visible both (lined up) after the Copyright template code and between all of the Category tags. Delete all of these <br/>.


Issue 2: Avoid using special characters (&, #, @, $, *, etc...) in category titles because they will cause problems when tagging.


Issue 3: Many Categories have titles of two words or more, which causes a problem in the organization of entries on Category Pages.

  • To solve this problem, Sortkeys must be utilized on all category tags with titles of two words or more.


--MarkMcCumber (talk) 1 July 2014 (ADT)