Actions

Creating, editing and translating LimeSurvey Wiki pages

From LimeSurvey Manual

Revision as of 23:39, 9 June 2013 by Actxcellence (talk | contribs)

LimeSurvey Wiki

What it is?

You may already be familiar with the wiki concept, made known worldwide by Wikipedia, but just to make sure, here it is a short definition based on the WikiPedia article about the subject:

{QUOTE()}A wiki is a website that allows the easy creation and editing of web pages via a web browser using a simplified markup language. Wikis are typically powered by wiki software and are often used to power community websites, for personal note taking, in corporate intranets, and in knowledge management systems.{QUOTE}

LimeSurvey uses an open source wiki system (called MediaWiki) to manage the software manual along with other project related pages, such as developing documentation and the LimeSurvey project team page. And if you haven't noticed yet, this page itself is a wiki page.

How it works

As mentioned before, everyone is able to create, edit and translate almost every page hosted on this wiki. The following guide will help you with those tasks.

What can I do?

You can start helping the LimeSurvey wiki with small actions, like fixing typos or misspellings that you may find here. On the other hand, it is also possible to start big, writing entire guides, translating pages and sharing any information that you find relevant.

If writing is not your thing, check out ["Help+us:+Tasks"|this] page and learn other ways to contribute. It is all up to you.


Searching

Before you start writing your own articles it is always nice to spend some time using the search tool. After all, creating duplicated information will confuse other users and may be a waste of time.


Creating a user

Although everyone has the permission to edit and create pages on this wiki, you have to create an user before doing such actions. A link to the registration page can be found on the menu located on the right side of the LimeSurvey webpage (or you can click here).

The registration form is very short and the whole process takes less than a minute. Follow the instructions there and don't forget to check your mailbox to confirm your account. Logging in is also possible here inside the wiki system (see form on the top).


Markup language

It is important to notice that most wiki systems have some syntax rules to help you formatting your page and to make things look nicer. But there is no need to worry memorizing weird code rules because you can always use the formatting toolbar. There is also a reference guide of those rules under the editing page.

Style syntax

Icon
Code
Result
text_bold.png
'''bold'''
bold
text_italic.png
''italic''
italic
text_underline.png
<u>underline</u>
underline
text_strikethrough.png
<strike>deleted</strike>
deleted

Structure syntax

It is also a very good idea to structure your page using headings to separate different sections on your page. That can be done using exclamation marks (!). Nested headings are also possible with the use of more than one exclamation mark in a row. You can use the tag __TOC__ in the beginning of your page to automagically create a "table of content" that looks like this:

File:Headings2.png


Editing pages

There are several ways of reaching the edit form from a page. You can press either the page_edit.png icon on top right of a page, the "Edit" button on bottom left or the page_edit_section.png icon, located on the right side of each page section. This last option is particularly interesting when you want to edit just something on a really big page.


Creating pages

Creating a page is very easy and everything you need to get started is a title. On the left menu there is a text box right below the words Quick Edit a Wiki Page. Fill it out with your title and after that, click the button "Create/Edit".

If you have ever edited some page you will find this interface very familiar. That's because creating a page is nothing more than editing a blank page.

Depending on what title you choose for your new article you will see some recommendation links generated automatically by the wiki system. It is only to prevent you from creating something that has already a page for it. For example: if you try to create a page called "Team" you will see this:


Translating pages

LimeSurvey has grown up a lot and this time it has users and developers from all over the world, and for that reason translators are needed more than ever!

Have you ever noticed that on the top right of every page there is a form field telling you in which language was this page written? Clicking there will show you other language options that are available for the page.

If you fell that you can contribute translating a page into a new language you are more then welcome to do it. Here it is how it works:

  • Make sure that you are logged in
  • Go to the page that you would like to translate
  • Make sure the page is not already translated into the language that you want to translate. This can be done checking available translations on the language form field mentioned before

  • Click the button on the bottom of the page
  • There will be a form right below the revision table. Select the language that you would like translate to and just click the "Update Translation" button

  • Now you have to choose between 3 options:
    • Create a new translation page (most probably): Choose the language you would like to translate, write the title in that language and you are ready to go.
    • Add existing page as a translation of this page: If you already created a translation page before but did that using the normal "Create Page" process you should tell the wiki system that this is a translation of another page. This can be done "attaching" one page to another.
    • Change language for this page:  As the title says, you can change here the language identification of a page. You are probably never going to use that since you are already able choose the language when creating pages and translations.

Please note that you don't need to translate word-by-word, but please try to keep as close as possible to the original text.


History

Every action made by every person on a wiki (like creating and editing pages) is logged - along with the information of who done it and when - and can be reverted back at any time. So, if you spent the whole week working on a page and then you came home drunk on Saturday and erased all the content of that page, don't worry because the button will always be there for you.