More actions
Grammar and structure improvements |
|||
| Line 3: | Line 3: | ||
[[Category:Wiki Contributions]] | [[Category:Wiki Contributions]] | ||
{{Contribution menu}} | {{Contribution menu}} | ||
[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 | [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 its greatest weakness. Wikis 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. | It is assumed that the user is logged in for this entire guide. | ||
| Line 25: | Line 25: | ||
== Editing a page == | == Editing a page == | ||
To edit any page, go to that page and click the 'Edit' tab at the top of the page or the 'Edit' link to the right of each section (if you don't see the 'Edit' you need to login first). | To edit any page, go to that page and click the 'Edit' tab at the top of the page or the 'Edit' link to the right of each section (if you don't see the 'Edit' you need to login first). | ||
=== Wiki syntax === | === Wiki syntax === | ||
==== Headings ==== | ==== Headings ==== | ||
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 ( '=' ). | 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> | <pre><nowiki>= Heading level 1 (top) =</nowiki> | ||
<nowiki>== Heading level 2 ==</nowiki> | <nowiki>== Heading level 2 ==</nowiki> | ||
<nowiki>=== Heading level 3 ===</nowiki> | <nowiki>=== Heading level 3 ===</nowiki> | ||
<nowiki>==== Heading level 4 ====</nowiki></pre> | <nowiki>==== Heading level 4 ====</nowiki></pre> | ||
Heading 1 is the same as the page heading, so it is recommended to start with heading level 2 on your page. | Heading 1 is the same as the page heading, so it is recommended to start with heading level 2 on your page. | ||
| Line 42: | Line 39: | ||
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). | 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> | 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 [[Intentionally Red Link]], when you feel that subject deserves it's own article. The link will then appear red instead of yellow, 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> | 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> | 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> | ||
==== Redirect ==== | ==== Redirect ==== | ||
| Line 77: | Line 74: | ||
==== Images ==== | ==== Images ==== | ||
Advanced information can be found | Advanced information can be found on [http://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia]. | ||
In order to include images (or other files) in your article, simply link them like <pre><nowiki>[[File:filename.ext]]</nowiki></pre> | 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. | After saving the edit, click the file link and follow the form to upload your file. Of course, you can always look at the source of an article (click the edit link) and look up markup codes that aren't described here. | ||
Of course, you can always look at the source of an article (click the edit link) and look up markup codes that aren't described here. | |||
To upload your image: | To upload your image: | ||
| Line 138: | Line 133: | ||
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. | 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. | Categories should be used as collection mechanic instead of custom-made pages where we have to manually add links to new articles. | ||
You can add a category to an article by adding | You can add a category to an article by adding | ||
| Line 161: | Line 156: | ||
==== Cleanup ==== | ==== Cleanup ==== | ||
<pre><nowiki>{{Cleanup}}</nowiki></pre> | <pre><nowiki>{{Cleanup}}</nowiki></pre> | ||
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, | 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, etc. | ||
==== Deprecated ==== | ==== Deprecated ==== | ||
| Line 259: | Line 254: | ||
== Discussion == | == Discussion == | ||
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 | 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 article. If you want to sign the message with your name, then end your message with four tildes. <nowiki>( ~~~~ )</nowiki> | ||
== Sandbox == | == Sandbox == | ||
| Line 271: | Line 266: | ||
* You are actively involved in the [[Wiki How To Guide#Discussion|discussion]] of a page | * You are actively involved in the [[Wiki How To Guide#Discussion|discussion]] of a page | ||
* The page is a work in progress and you'd like to monitor it's development | * The page is a work in progress and you'd like to monitor it's development | ||
Luckily the wiki provides us with a very helpful tool for monitoring the last time a particular page was edited and they do this with a "watch list". | Luckily the wiki provides us with a very helpful tool for monitoring the last time a particular page was edited and they do this with a "watch list". | ||