Help:uniKB User's Guide

From uniWIKI
Jump to navigation Jump to search

Writing an article

The process of creating an article is very simple:

  1. Use the input box on your department page.
  2. Write your content as you would any text document, but using wikitext markup for any styling (bold, italic). Consult the cheatsheet.
  3. Refer to the template page to get a feel for the general structure. However, there are no rules for article structure - write as you feel it is best read.
  4. Categorize your article accordingly (if they have been established by your manager), or temporarily categorize it under your department so that it may be arranged later.

Remember these important facts about editing wiki content:

  • Only logged in users are permitted to edit. You will not see the edit tab if you are not logged in.
  • All changes are tracked and include timestamp and username. Any change can be reverted.
  • Create and edit knowing that there is no consequence to making mistakes, but refrain from being overly cavalier such that it results in a lot of empty pages and redirects (i.e. due to mere typos in titles).

Uploading files

There are two ways of uploading files, both of which bring you to the upload page.

  1. One way is by clicking the "Upload file" link in the sidebar (to the left, under Tools).
  2. The second way (the easier method), is to just reference the file you want to create/upload as you're editing the page, and clicking on the red link after (similar to creating a new page by first creating the link).

A note about filenames: There will no naming convention with regards to filenames for files uploaded to uniKB. As naming will be left to the user's discretion, please consider using descriptive yet short names, and consider being consistent (these will only make it easier for you). In Information Systems, we have found it helpful to use numbered series to upload images in batch (web_orders_screenshot-1.jpg, web_orders_screenshot-2.jpg). See Special:ListFiles for a general idea of how you can name your files.

Linking to uploaded files

The syntax [[File:filename.jpg]] is correct for linking to files, but clicking this method brings you to the file description page (a page about the file). From here you can click on the file again, and if it's an image, it will open in its original size, and if it's a Word document or Adobe PDF, it will open in the program. To have the link open the file directly, you can use [[Media:filename.jpg]]. This is a much better way to link to uploaded documents, since they immediately are downloaded and opened.

Linking to superserver files

Useful tips

  • Use ~~~~ to leave a signature (e.g. useful for signing off on a statement), or ~~~~~ to leave a timestamp. Your signature can be edited in Preferences

Example: I want people to know who wrote this and when I wrote it. -norwizzle (talk) 14:10, 27 July 2016 (PDT)

Example: Isn't time cool? 14:10, 27 July 2016 (PDT)