Creating a Wiki
From CTSKnowledgeBase
Summary: Steps to create a good and organized Wiki page.
Creating a Page
- Choosing a title for the name of your document try to avoid the phrase 'how to'. The title must contain what it is for and if a specific version if it has one.
Good: Schedule an appointment in Outlook 2003
Bad: How to schedule an appointment in Outlook
- In your url at the end delete until you see http://services.juniata.edu/cts/wiki/index.php/.
- Now, enter the title of your wiki at the end of the URL. If the title contain spaces use _.
- Ex: the title of Schedule an appointment in Outlook 2003 would look like this at the end of the URL Schedule_an_appointment_in_Outlook_2003.
- You will get an empty text box if the article name hasn't already been created.
- We need to categorize this article. To do this type in [[category: NAME]].
- To choose a good category, first search the wiki to see if there are categories already set up that it would fit in. Continuing with the same example there is already an Outlook 2003 category. Majority of articles will only need 1 category. Now click save at the bottom.
- A blank document should appear with only the article name showing.
- At the top of the wiki, select the Protect tab.
- This actions takes you to a confirmation page. Just check Confirm Protection and click the Confirm button. This will lock the page down so only staff and edit them. This prevents the pages getting hit by spammers.
Writing a guide
- DO NOT rewrite the title, the wiki automatically displays the title name. All you are doing is repeating the line above it.
- I recommend you to write a brief summary of what the guide is about.
- Example: Summary: If your inbox is getting full, one option is to move your e-mails to a personal folder. A personal folder is a folder store on separate location off of the mail server. Therefore, you are not limited by our small inbox sizes.
- DO NOT USE HTML!!!! The point of the wiki is suppose to be quick and easy editing and we don't feel like looking at your ugly tags. To better understand the wiki code read Wiki Guide (http://en.wikipedia.org/wiki/Help:Wikitext)
- If you want to a line breaks, just hit return twice in the wiki code.
- Use * for bullets to note each step.
- Bold any names that have to do with the action. Ex: click START or File -> Save As.
- Italics any names of the section they are under. Ex: Under File and Folder tasks click bla bla bla
Using Images
- Somehow we can't get the upload images to work, so you need to save your pictures in \\webshare\webcts\wikipix.
- Don't be lazy and crop all pictures to the area which the action is going on.
- Ex:
when I said click on the protect tab I cropped out everything that wasn't needed. This saves space and helps the user focus in on what needs changed. I usually leave titles or subtitles of an area.
- Ex:
- Save as a .gif. This helps save space and loading time for the user.
- You need to create a folder inside of wikipix of all pictures in this guide. I don't care if its only 1 picture. Look at your category and create the folder in the correct area. You will always create a folder inside a root category.
- Image library structure:
- Root category (Network, Software name, Email, Hardware, Phones)
- Parent category (software name, general term used 'VPN, Wireless')
- Version Optional (Version name like 2003, 8, CS2)
- General Action Optional (Calendar, personal folders)
- Action (point of the guide like creating, disable, sharing)
- Image library structure:
Example: \\webshare\webcts\wikipix\software\outlook\2003\calendar\sharing
- To use an image you have to past the full url of the image into the wiki.
