Difference between revisions of "How To Wiki"

From MEDS Wiki

m (How to use MEDS wiki)
Line 36: Line 36:
  
  
=== Embedding Videos ===
+
=== Creating a new Wiki Article ===
 +
 
 +
 
 +
Simply use the search bar on the top left and enter your desired article title. You can see if the article (or a similar one) already exists in the search results. If your desired article does NOT exist, simply click "Create the page "****" on this wiki.". You will be greeted by the text editor, where you can add your content. Don't forget to save and publish your changes after you're done.
 +
 
 +
 
 +
 
 +
 
 +
 
 +
[[File:Creating a new Page.png|frame]]
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
====  Hyperlinks and desired Pages ====
 +
 
 +
 
 +
 
 +
You can link wiki pages by simply typing the name of the page in double square '''<nowiki>[[example]]</nowiki>''' brackets, or simply use the link symbol above the text editor.
 +
 
 +
 
 +
 
 +
It is possible to link non existing wiki pages as well, e.g. if you think there should be an article about a topic in your text. If you a link a non existing page, this will be categorised as a ""desired article"". By clicking on such a link, the wiki asks if you want to create this page. Refer to the [https://www.mediawiki.org/wiki/Help:Contents official guide] for more details.
 +
 
 +
 
 +
==== Categories ====
 +
 
 +
 
 +
It is convenient to catigorise all articles to keep order on the wiki. It also helps to find related articles.
 +
 
 +
Categories work similarly as a tree. You have your main category (tree trunk) where multiple sub categories (branches) can evolve from. This principle works with endless sub and sub-sub categories.
 +
 
 +
To assign your article to a category, simply add ""<nowiki>[[Category:XXX]]</nowiki>"" at the end of your article. If the category won't exist already, it will be automatically created. By clicking on a certain category on the bottom on your article, a list with all articles of this category will appear. This list is also a wiki page itself and can be edited accordingly. By editing the category page, you can simply add a parent category in the same fashion.
 +
 
 +
 
 +
New categories, and thus category trees, can also be created in the same manner as a regular wiki page.
 +
 
 +
 
 +
Usually you would only use an end branch to categorise your article.
 +
 
 +
 
 +
""A category tree helps to organise the wiki. However, in the beta stage of the wiki, a tree structure first has to be planned. This has been done before, but was not applicable 1/1 on the actual wiki.""
 +
 
 +
 
 +
==== Embedding Videos ====
  
  
Line 42: Line 88:
  
  
=== Foreground Skin ===
+
==== Foreground Skin ====
  
  
Line 49: Line 95:
  
  
=== Sensitive Data ===
+
==== Sensitive Data ====
  
  
Line 56: Line 102:
  
  
=== Sandbox ===
+
==== Sandbox ====
  
  

Revision as of 18:19, 19 October 2019

MEDS wiki is open and visible for anyone. You don't need a user account to look up content.

Everybody is able to create an account, add and edit content.

All heads of departments are invited to sign up and contribute to the wiki. Additional helpers and editors are very welcome too.

MEDS wiki is based on MediaWiki, the same platform behind Wikipedia and many other similar pages.


Creating a user account

Open the user menu on the top right. Click on create account, fill in your real name as the user name, password, email address and complete the captcha. As soon you send the form, your user account is generated.

In order to be able to edit and add content, you have to confirm your email address. While logged in, go to your [profile settings] and click on "confirm email address". Check your email inbox (or spam folder) and finish your signing up by clicking the confirmation link in the mail.

Join #wiki on Slack

It's mandatory to be member of the #Wiki Slack channel, in order to get updates and discuss about wiki technical related topics.


How to use MEDS wiki

The easiest way to look up information is by using the search bar. If you can't find what you are looking for, you are welcome to create a page about your desired topic.

A extensive guide how to create pages, editing and organizing pages can be found here.


During the beta phase wiki articles may be created and be unfinished. However in the future we should follow this rule:

Only add content that has beed agreed in consensus with your team/department. This wiki is not a debating platform. Discussions should be held on Slack.


Creating a new Wiki Article

Simply use the search bar on the top left and enter your desired article title. You can see if the article (or a similar one) already exists in the search results. If your desired article does NOT exist, simply click "Create the page "****" on this wiki.". You will be greeted by the text editor, where you can add your content. Don't forget to save and publish your changes after you're done.



Creating a new Page.png




Hyperlinks and desired Pages

You can link wiki pages by simply typing the name of the page in double square [[example]] brackets, or simply use the link symbol above the text editor.


It is possible to link non existing wiki pages as well, e.g. if you think there should be an article about a topic in your text. If you a link a non existing page, this will be categorised as a ""desired article"". By clicking on such a link, the wiki asks if you want to create this page. Refer to the official guide for more details.


Categories

It is convenient to catigorise all articles to keep order on the wiki. It also helps to find related articles.

Categories work similarly as a tree. You have your main category (tree trunk) where multiple sub categories (branches) can evolve from. This principle works with endless sub and sub-sub categories.

To assign your article to a category, simply add ""[[Category:XXX]]"" at the end of your article. If the category won't exist already, it will be automatically created. By clicking on a certain category on the bottom on your article, a list with all articles of this category will appear. This list is also a wiki page itself and can be edited accordingly. By editing the category page, you can simply add a parent category in the same fashion.


New categories, and thus category trees, can also be created in the same manner as a regular wiki page.


Usually you would only use an end branch to categorise your article.


""A category tree helps to organise the wiki. However, in the beta stage of the wiki, a tree structure first has to be planned. This has been done before, but was not applicable 1/1 on the actual wiki.""


Embedding Videos

We have the MediaWiki Youtube extension running on the Wiki, which allows embedding Videos not only from Youtube, but also from other Video hosting sites. For the full instructions, see the extensions documentation.


Foreground Skin

This wiki uses the Foreground Skin to make it visually appealing. This skin has some useful features such as image sliders and grid systems. If you're planning the make use of it, refer to their documentation.


Sensitive Data

Keep in mind, this wiki is open for anyone, there is no restricted area here. Please do not post personal information (eg. participants lists) on the wiki. If you refer to documents containing personal information, please make a private link to Mega, where we have password restriction.


Sandbox

Use the Sandbox page to play around with all the layout options and media wiki mechanics.