Help:Tutorials

From WeSISpedia
Jump to: navigation, search

This help page contains information and tutorials to support you on the use of WeSISpedia.

WeSISpedia is a wiki, which means that it is a website written collaboratively by multiple users. The goal is to develop the content together and be able to keep track of the modifications. Once you save a page, it is immediately available online. However, the structure of a wiki is based on links and therefore, you should take care of always adding the link to your new page somewhere visible, e.g. in the main page. The text of the wiki is written using a markup language, known as Wikitext. For more details on editing, check the Editing section below.

For creating indicator pages, we set up a template for you to use. Alternatively, you may use the indicator form for creating a new page if you are less familiar with Wikitext. Check the specific instructions in the Tutorials.

WeSISpedia was built with the MediaWiki wiki software. Therefore, you can go to the MediaWiki help page to find general instructions on how the wiki works and all the options available.

Editing

To write in the wiki, we recommend you to use the Wikipedia's manual of style and Wikipedia's Dos and Don'ts.

Wikipedia's cheatsheet contains the basic tips to write Wikitext.

Ideally, you should divide your page into sections. If you do so, you can modify a specific section directly without affecting the rest of the page, clicking on the Edit link next to the section's name. This is practical to avoid confusion if multiple users are working on the same page at the same time.

For each page, you can see the date of the last modification at the bottom. To take a closer look on the last modifications, look for the page in Special:RecentChanges.

Some pages, such as the main page, are protected. Protected pages can only be modified by users with administrator rights.

Tutorials

As mentioned above, you can find help in MediaWiki's help pages. For information specific to WeSISpedia, you can find instructions below. We plan to also add video tutorials.


  • How to access WeSISpedia?

In order to be able to access the WeSISpedia website, a user name and a password are necessary. The project A01 will give them to the Principal Investigators (PI) who will then take care of giving them to their teams. With the correct credentials, the user can already see the WeSISpedia main page, but not edit it. Editing is only possible for registered logged in users.


  • How to create an account?

In the top right corner of any page, you can find the link "Create account" which will lead to the corresponding page. After filling the form and receiving a confirmation e-mail, the user account is ready to use.

Note: Currently, only members of the INF project are administrators.




  • How to create a page?

There are multiple ways to create a new page. You can find the instructions in MediaWiki's help page. If you are using the indicator form a new page will be created automatically by the form.


  • How to create a new indicator page using the template?

You should create a new blank page, as usual. Then, use the Template:Indicator by copying the text between brackets shown at the beginning. Afterwards, add your content to each row after the equal sign. For more information on the use of templates, check MediaWiki's templates help page. This Example:_Example_indicator was created using the template.


  • How to create a new indicator page using the form?

If you are less familiar with the Wiki markup language, you can use the indicator form to create a new page. The form (1) automatically creates an indicator page and (2) helps populating the template via the form. Providing a simple editor, the form also allows for conveniently editing the text.

There is one known "bug" when using either the template or the form: if you want to include a list (e.g. for value labels), the first point is not properly parsed when writing Wikitext. It is related to how the Wiki grammatically processes the parameters/value of a template (cf. Wikipedia's help page). The best way is using HTML code for lists instead.

The code for an unordered list is:
 <ul><li>Point1</li><li>Point2</li></ul> 
For an ordered list it is:
 <ol><li>Point1</li><li>Point2</li></ol> 

If you want to edit already existing pages using the form, you can do so by simply changing the first line of the markup in "Edit-mode" from {{Indicator to {{IndicatorForm. Reloading the page, a new "button" will appear next to "Edit" which says "Edit with form". It parses the already existing content, though you need to re-set "Scale" and "Data type" using the radio buttons and "Category" using the drop-down list once.

User groups and user rights

There are three types of users: anonymous users (without an account), registered users and administrators. The following table shows the most relevant rights of each group and who belongs to each user group within the Collaborative Research Center (CRC).

WeSISpedia user groups
User group Main rights Members
Anonymous visitors (not registered) Read
Create accounts
External visitors
Registered users Read
Edit
Move
CRC members

Student assistants (if desired)

Administrators Protect pages
Delete or undelete pages
Change user rights of others
INF project members