UniWiki:Editing Guide: Difference between revisions

[[Category:Guides]]

[[Category:Wiki Information]]

[http://en.wikipedia.org/wiki/Wiki Wikis] are a great way to share information within a community, since everyone can make additions to the knowledge base. This is also it's greatest weakness. Wiki's often rely on a relatively large active community, instead of a small group of dedicated writers. This guide explains how you can add stuff to our wiki.

It is assumed that the user is logged in for this entire guide.

== Creating a page ==

Before creating a new page, do a few wiki searches with relevant keywords. If there is an existing article that already ties closely to your subject, it may be better to add to the existing article instead of creating a new one. Likelwise, if a subtopic in an article becomes really big, it may be worth splitting it off into it's own article.

Creating a page is very easy, as all pages exist ''in potentia''. This means in order to create a page, all you need to do is go to that page and add content. Confused? Don't worry, we have pictures!

First, you'll need to go to the page you want to create. This example shows how this guide was made. You can navigate to the page you wish to make by manually adjusting your browser URL and click 'edit', or - as shown in this example - simply do a search on our wiki for the name of the page you wish to create, and then click 'Create this page'. You can use spaces if the page you wish to create contains multiple words.

[[File:wiki1.png]]

[[File:wiki3.png]]

Ofcourse, just plain text doesn't make for very useful and readable wiki pages. The next part of this guide describes the wiki markup language.

== Editing a page ==

To edit any page, go to that page and click the 'edit' tab at the top of the page.

 

=== Wiki syntax ===

The use of headings not only makes for readable text but also automatically generates a table of contents. Headings are very easy to add, simply surround the title of the paragraph with equal signs ( '=' ).

<pre><nowiki>= Heading level 1 (top) =</nowiki>

<nowiki>== Heading level 2 ==</nowiki>

Heading 1 is the same as the page heading, so it is recommended to start with heading level 2 on your page.

Linking is one of the most powerful aspects of a wiki, so it is important that it is understood well. First you must realise there is a difference between intra-wiki links (links to other articles on this wiki) and external links (links to external websites/pages).

The basic intra-wiki link has the following syntax: <pre><nowiki>[[Link topic]]</nowiki></pre> where '''Link topic''' is a page on the wiki. For example, if we wish to link to [[Main Page]] we use <pre><nowiki>[[Main Page]]</nowiki></pre>. These topics can include spaces, as the wiki will automatically reformat the text to the correct link. You can also link to pages that do not exist yet [[such as this one]], when you feel that subject deserves it's own article. The link will then appear red instead of blue, and people will hopefully feel encouraged to make the article.

As you can see, the text inside the double square brackets is both the destination (the page it links to) and the description (the text that shows up as link). In order to change the description you can use the pipe ('|') in the following syntax: <pre><nowiki>[[Link topic|link text]]</nowiki></pre>. For example: <pre><nowiki>[[Main Page|Example]]</nowiki></pre> becomes [[Main Page|Example]].

In order to make external links, you can use single square brackets like so: <pre><nowiki>[http://www.google.com]</nowiki></pre>. If you want to change the description text of your external link, separate the url from the description with a space [http://www.google.com like so]: <pre><nowiki>[http://www.google.com like so]</nowiki></pre>.

<nowiki>** List</nowiki>

In order to include images (or other files) in your article, simply link them like <pre><nowiki>[[File:filename.ext]]</nowiki></pre>. For example, the first image in this guide is linked as <pre><nowiki>[[File:wiki1.png]]</nowiki></pre>.

After saving the edit, click the file link and follow the form to upload your file.

It is important we categorize our articles properly. This allows our [[Wiki Structure|category pages]] to automatically list all articles in their category, which makes it easy for people to see the collection of articles in the same category.

Categories should be used as collection mechanic instead of custom made pages where we have to manually add links to new articles.

<pre><nowiki>[[Category:</nowiki>CategoryName<nowiki>]]</nowiki></pre> anywhere in the article (categories are usually listed either at the start or end of an article). CategoryName should obviously be replaced with the name of the category. For an example, see the source of this article and note that it includes: <pre><nowiki>[[Category:Guides]]</nowiki></pre>

If you wish to link to a category page, use the following syntax: <pre><nowiki>[[:Category:CategoryName]]</nowiki></pre> Note the first colon. Example [[:Category:Guides|Guides]]: <pre><nowiki>[[:Category:Guides|Guides]]</nowiki></pre>

[http://meta.wikimedia.org/wiki/Help:Template Templates] are a bit more advanced so this guide will not explain how to make them, but we do have some [[:Category:Template|templates made that are ready to use]].

 

Templates allow us to automatically format information a certain way. For example, the Clean Up template always looks like this: {{Cleanup}}

Some templates allow variable input. {{Example|The example template for example!}}

You simply put a pipe character after the template name and then put the text. A new pipe for each variable:

We have several templates that we use at the moment, see the [[:Category:Template|template category]] for the full collection. We'll discuss some of the more common maintenance templates here.

Indicates that this article needs to be cleaned up/improved. Mark articles with the Cleanup template if they contain a lot of spelling errors, unwieldy layout, etcetera.

==== Deprecated ====

<pre><nowiki>{{Deprecated}}</nowiki></pre>

Indicates that this article is no longer required and is no longer being maintained. Depreciated pages may be reused or edited into something useful.

Used for pages that were created by accident, empty categories, blank pages, or abusive articles that are better off removed entirely.

==== Merge ====

Indicates that the contents of an article is duplicated somewhere else. Duplication of information will almost certainly lead to inconsistencies when changes are applied to only a part of the duplicate information, and as such should be avoided at all cost. Instead, articles should link to one another to reference information. If you find articles that have significant duplicate information, mark them with the Merge template. The Merge template takes one argument, the name of the other article containing the duplicate information:

If you feel a certain page requires discussion, each page comes with it's own discussion page. This is really just a regular wiki page, so adding comments to it works exactly the same way as adding to any other wiki artcile. If you want to sign the message with your name, then end your message with four tildes. <nowiki>( ~~~~ )</nowiki>

=== Sandbox ===

Want to fool around in the wiki without worrying about screwing up existing articles? [[Sandbox|Go play in the sandbox]]!