SOP Wiki Categories
From PTAGISWiki
| Standard Operating Procedure
|
Subject:
| SOP Wiki Categories
|
Author:
| Alan Brower
|
Approved by:
| UNAPPROVED
|
Contents |
Objective
The objective of this document is to provide structure to the wiki through the use of the wiki category tag.
Scope
This document is intended not only to clarify the use of categories on the PTAGIS wiki, but also the conventions to which they should conform.
Responsibilities
This procedure is intended primarily for PTAGIS Field Operations personnel.
How Wiki Categories Work
Background
The wiki has a flat file structure.
There are no folders to group related wiki pages, every page is (virtually) in one big folder.
Wiki "categories" should be thought of as an automated "links page" to group together related wiki pages. Every wiki page, with the syntax implemented as shown below, is automatically included in a "links page".
To view existing categories, click the "Categories" link in the navigation section on the left side of any/every wiki page. This will show you a page with links to all existing category main pages.
There are many pages in the wiki. It can be difficult to find all the information you seek by looking at every page in the wiki. Wiki categories provide a way to narrow the search for information on the wiki. The user simply clicks on a category pertaining to the desired information.
It is up to the page editor to include the wiki page in one or more suitable categories.
In Example
A page belongs to a category if (and only if) it contains a link to the main page of that category. When you click on a category, the page you get can be thought of as a "links page" of related articles. Here is an example of a category main page:
This category provides links to the various Standard Operating Procedures, as well as related documentation such as "SOP - PTAGIS Field Operations Standard Operating Procedure List" and "SOP_Standard_Operating_Procedure_Starter_Page." Those two pages are singled out because they not actually SOPs, but are very closely related - and worthy of inclusion into the SOP category.
More Info
The "category link", within the wiki page, takes you to the "links page" (category main page) that shows related articles.
You can list all wiki pages within a category by clicking on the category main page title.
A list of all categories can be found in the navigation section on the upper left side of all PTAGIS wiki pages. You can also find them on the Special:Categories page.
Procedure
Creating Categories & Adding Your Page to a Category
Assigning a wiki page to a category is accomplished with wiki syntax. To add your page to the "EXAMPLE_1" category you would click on the edit link to enter the article's edit mode and add the following at the end of the document:
[[Category:EXAMPLE_1]]
This would automatically assign the article to the "EXAMPLE_1" category. If the category doesn't exist, the wiki will create it automatically. To include the wiki page in multiple categories just add additional categories like so:
[[Category:EXAMPLE_1]] [[Category:EXAMPLE_2]]
This would assign the article to the "EXAMPLE_1" and "EXAMPLE_2" categories.
You can also create sub-categories. "Category:B2J" is a sub-category of "Category:Site". This was accomplished by editing the wiki page "Category:B2J" and including it into "Category:Site" using the same wiki syntax as shown above.
Choosing Suitable Categories
The purpose of categorizing a wiki page is to make the information easy to find. Some tips about categories:
Category Creation
- Check to see if a suitable category already exists.
- Multiple categories for the same type of information defeats the purpose of wiki categories.
- Keep the category name as short as possible.
- Choose a descriptive category name.
- The category main page can (and should) be edited using the same method as any other wiki page.
- Edit the category main page to include a description of what the category is intended for.
Categorizing a Wiki Page
- Include a page in as many categories as necessary (probably 1-4, maybe more).
- In addition to any relevant categories, categorize every wiki page you create into your personal category.
- Example: this page is in Category:Alan (as well as some others).
Categories Relevant to PTAGIS Field Operations
All categories in the PTAGIS wiki are available for use, and should be used when appropriate. Certain categories are more relevant to PTAGIS Field Operations than others. As of this writing, the following list of categories are common to our tasks (some more common than others):
APTTS
Alan
B2CC
Benchmark
Darren
Documentation
Documents
Don
FAQ
GMC
M4
M4 Testing
Monitoring
Newsletters
O&M
O&M Projects
PIT-Tag Forecast
PLC
PTAGIS
Planning
RequestTracker
SOP
Scott
Scott 07
TDI
Tag Tests
TransceiverDevelopment
Troubleshooting
Troy
Wiki
Wiki Training
References
None.
