Difference between revisions of "Wiki manual"

Revision as of 11:15, 6 January 2012

1 Click4it learning and training wiki - Step by step user guide
2 Introduction
3 Getting started
- 3.1 The editor
- 3.2 Using templates
4 Creating a term
5 Creating a toolkit
6 Including additional material
7 Adding a list of web resources
8 Template- Quick reference list

Click4it learning and training wiki - Step by step user guide

This user guide should enable you to start working on the wiki and, in particular, to maintain the required formatting style. Should you need any additional information or clarification, do not hesitate to contact us at click4it@unitar.org

This document is also available in PDF version (2.03 MB).

Introduction

What is a Wiki?

A wiki is a page or collection of web pages designed to enable whoever is given the editing rights to contribute or modify content, using a simplified markup language. Wikis are often used to create collaborative websites and to power community websites.

One of the characteristics that make a wiki different from other websites is the fact that users having an account can add new pages, change the content of existing ones, upload pictures and files and create links to external and internal web pages.

These features make a wiki a perfect tool to build a site as the Click4it wiki is supposed to be: a dynamic collaborative environment where information and materials on training methodologies can be collected and shared. Allowing contributions from various contributors, the wiki can be viewed as a knowledge base platform for training tools and methods.

The primary difference between a wiki and a traditional website is that it uses a simplified markup language. This particular syntax makes editing much easier for people who are not familiar with the HTML language. Increasingly, wikis are making "WYSIWYG" ("What You See Is What You Get") editing available to users, so that they can edit a page by using icons and buttons they are familiar with (e.g. bold, italic). For more advanced editing options, users can utilize a simplified HTML coding; this is based on a syntax that allows them to have a wider range of formatting possibilities and to make a page much more interesting to use than a plain text.

Who can write on the wiki?

To assure the quality of the material that is published on the Click4it wiki, only registered users are granted editing rights. It should be noted that in order to make any modifications on the wiki, users should be logged in.

Registered users: If you already have an account, go to the upper right corner of any page and click on Login. Once you enter your username and password you will be able to modify content and add new pages, links or documents.

New users: If you do not have an account yet, please send a request to click4it@unitar.org; you will receive an email containing your access details.

What is a template?

A template is a standard element that can be used to create other pages with the same layout. The goal of having templates for the wiki is to streamline the content creation process, so that users do not need advanced HTML editing skills.

An example is provided below to clarify this point:

Any definition in the Click4it is written inside a light brown box containing a small icon of a book and a pen in the left corner. This box is a template. The HTML code associated with the box has been created once and saved in the template section. The name of the template in question is Term. Should a user need to write a definition inside this template, all they need to do is type (or copy and paste) the following code in the editing section of a new page:

{{Term|TERMNAME|Definition}}

The result should be as follows:

TERMNAME

Definition

Getting started

In this section, you will be introduced to some basic notions you need to acquire for creating and editing content.

The editor

Before exploring how to create a new term, let us get familiar with the editing environment. When a new element is created, an empty editing page like the one shown below appears:

The white space is where you type your text. The small toolbar at the top of the writing space (see red box) offers you some basic formatting options (see list below). To preview your page before saving it, click on the Show preview button. Note that once you save the page, it will be visible publicly, so please do not save it while the editing is still in progress.

"What You See Is What You Get" editor toolbar icons:

Use the following icons to:

- format selected text in bold

- format selected text in italics

- create a link to an internal click4it wiki page

- create an external link (remember to add the http:// prefix)

- format the selected text into a Level 2 Headline

- embed an image file

- embed a media file

- include mathematical characters

- override the existing formatting in this wiki

- add a signature with a timestamp

- add a horizontal line that separates two or more paragraphs in your entry

Using templates

In order to have the wiki harmonized, new definitions, toolkits and other sections are to be created using the corresponding templates. Please follow the instructions to make sure you use the right format: it is important to maintain consistency throughout the wiki.

Creating a term

The terms contained in the Click4it are listed alphabetically in the Overall Repository. They consist of a definition, whose length can vary from a few sentences to a very long text, and might also include a toolkit or other additional materials.

This section will guide you through the creation of a new term page and instruct you on how to use the Term template.

To create a new term:

Go to the Overall Repository page.
Select Edit and insert the term at the appropriate point in the alphabetical list by using the following syntax: *[[Page Name]]. The link will appear in red to show that the page does not exist yet.
Click on the term and an empty editing page will appear.
Use the following term template: {{Term|TERMNAME|Definition}}
Replace ‘TERMNAME’ with the name of your term in capital letters and type your definition between the second vertical slash and the closing braces.

TERMNAME

Definition

Adding in-text references

When you create a new term, it is essential to include a reference list at the end of the page containing all the sources you used for your definition. In order to maintain the definition easy-to-read and uncluttered, references have to appear in the form of a footnote at the bottom of the page; see picture below:

To create a list of References, please follow these steps:

Identify the place in the text where you want the footnote to be linked (i.e. the point where, once saved, the superscript number will appear). Note that even if you have to type the sources here, they will however appear at the bottom of the page, as requested.
Type the following and list your resources here as indicated: ^[1]

When referencing websites, please indicate both the full URL and the text tag you want to appear. Example: www.mywebsite.com (November 2011)

Scroll down to the end of your text and add 4 spacing lines, then create the References heading by typing ==References==.
Underneath the heading, close the section by typing
↑ [Resource 1] (date accessed), [Resource 2] (date accessed)

Please note that sources should also be included in the general Bibliography of the wiki. This contains two lists: one for books and articles and one for websites.

Adding links

At the end of your definition, if relevant, please include a See Also section, i.e. a list of terms that are already available on the wiki and are related to the term you are compiling.

Also remember to place an internal link every time you mention one of the existing terms in the body of your definition.

Please refer to the table below whenever you need to insert links in your page.

Important note: Once the term has been added to the Overall Repository, it should also be added in the relevant section for that term.

The following categories are currently available: e-Learning, Knowledge Management, Monitoring & Evaluation.

Advanced editing options

Inserting a table

To add a table to your definition, use the syntax below. The number of columns can be customized according to your needs; to create a new row, simply add a new section starting with |-
{| class="wikitable"
|-
! header 1
! header 2
! header 3
|-
| row 1, cell 1
| row 1, cell 2
| row 1, cell 3
|-
| row 2, cell 1
| row 2, cell 2
| row 2, cell 3
|}
Important note: The table template is not compatible with the other templates, i.e. a table cannot be contained inside another template. It is necessary to close the template (to do so use the closing braces) before creating a table. The same template can be re-opened afterwards.

The Term Addition template

In case you want to add more text to your definition underneath a table, use the Termaddition template: {{Termaddition|Text}}. This will show as a simple box framed by a brown border and with no title (see image below).

Text

By using this template, the Definition, Table and Term Addition sections will look as an integrated whole, as you can see in the picture below.

Making changes to your page

Remember that you can always make changes or corrections to your page at a later moment. To do so:

Go to the page you want to modify and select Edit.
Identify the point in the text where you want to make corrections and/or modifications (e.g. add text, link to some other page of the wiki) and start typing.
Preview the page and save it when you are happy with it.

Creating a toolkit

If you want to elaborate on the practical aspects of an already existing term (e.g. how to implement a particular method, or how to put into practice a certain technique), the toolkit is the right instrument to do so. The template associated with it is called Tool.

Remember that a toolkit should be practical and immediately usable by readers. Therefore, it is important to structure your toolkit in a clear and pragmatic way: you might want to consult other existing toolkits to get ideas on how to organize information in yours (e.g. title choice, formatting style). The picture below is an example of how a toolkit appears in the wiki and what its structure is.

To create a toolkit, please follow the steps below:

Go to the term page and click on Edit.
Use the Tool template: {{Tool|ToolkitTitle|Text}}
Refer to the instructions given in the Creating a Term Section to edit the page and add links, references or tables. Please remember that if you need to add a table the template you are using should be closed and reopened afterwards if needed, as explained in the Inserting a Table Section.
Make sure that references appear at the bottom of the page, entering 4 spacing lines after the end of the text.
Use the template provided to create a PDF document of the toolkit (you do not need to include the definition).
Create the following heading ==’’’Job Aid’’’== and upload your PDF here.
Provide a link to this page in the Toolkit section (follow the same procedure as you would if you were to add the term to the Overall Repository).

ToolkitTitle

Text

Including additional material

In the Additional materials section you can include relevant materials that are copyright-free (or for which the user has been granted permission) by uploading them in PDF format. This section can be identified for the PDF icon that appears in the title box.

Save the file on your computer (remember to use a clear, self-explanatory name for it, as this will appear on the wiki)
Click on Upload file at the bottom of the page, then browse and select your file.
Go to the definition page and click on Edit.
Create some spacing before the References section at the bottom of the page to insert the additional materials.
Use the template called Addmaterial: {{Addmaterial| }}
Create the PDF icon: [[Image: pdf.png]]
Create links to the files: [[Media:FileName.extension|WordToBeClicked]]

Adding a list of web resources

Creating a list of web resources is a good way to showcase relevant information, tools or examples you consider to have an added value for a given term. The list should appear in the form of a two-column table displaying the links on the left side and a brief description of content on the right, to allow users to quickly identify information they are interested in.

Please find an example in the table below:

File:10-Web resources.jpg

Firstly, create the Web Resources label:

Go to the term page and click on Edit.
The table should appear directly above the References at the bottom of the page (add 4 spacing lines before the References).
Use the template called Addlink: {{Addlink| Text}}

Now create the body of the table:

Follow the instructions given in the Inserting a table Section 2.3.1.
Create links to the websites you selected: [http://www.yourwebsite.com TitleToBeClicked].
Add a short description of content to each link.

Template- Quick reference list

[1]

@@ Line 298: / Line 298: @@
 Please find an example in the table below:
+[[Image:10-Web_resources.jpg|center]]
-=== How to add a reference to the References list ===
-If you have added new information to a definition and you want the source to appear in the list of references at the end of the page, in the form of a footnote, follow these steps:
+Firstly, create the Web Resources label:
+#Go to the term page and click on Edit.
+#The table should appear directly above the References at the bottom of the page (add 4 spacing lines before the References).
+#Use the template called Addlink: <nowiki>{{Addlink| Text}}</nowiki>
-# Identify the place in the text where you want the footnote to appear and position the cursor on that spot. (As you will notice later on, once you've saved the footnote, you will see the number linked to the list of sources at the end of the page, not the source itself, even if you have to type it here).
+Now create the body of the table:
-# Add:  <nowiki> <ref>title of the book or website (date of consulting)</ref></nowiki>
-# If it is not already written, add: <nowiki> <references/> </nowiki>at the end of the page.
-# In order to keep the style of the pages homogeneous, enter 4 rows between the definition and the References section and add a title for it using this syntax:<nowiki> ==References==</nowiki>.
-# The sources should also be included in the Bibliography of the website, where you can find two lists, one for the books and articles and another one for the websites. Websites should be added on the top of the list, always including dates when they were consulted.
+#Follow the instructions given in the '''Inserting a table''' Section 2.3.1.
+#Create links to the websites you selected: <nowiki>[http://www.yourwebsite.com TitleToBeClicked]</nowiki>.
+#Add a short description of content to each link.
-==<font color="#D87A35" size="4" >'''Adding new terms, toolkits, material '''</font>==
-In order to have the wiki harmonized, the respective templates need to be used whenever materials or toolkits are added or a brand new definition is created.
-Follow these instructions to be sure to use the right format, keeping the click4it consistent.
-==='''Adding a new term'''===
-To add a new definition, you will need to create a new page called as the term you want to include. The easiest way to create a new page in a wiki is to create a link to it from an existing page.
-# Go to the Overall Repository page.
-#:[[Image:overall_repository.jpg|center]]
-# Select edit and add a link (<nowiki>[[Page Name]]</nowiki>) respecting the alphabetical order. The link will appear red, to show that this page does not exist yet.
-# When you click on the red link, the following page opens:
-#:[[Image:editing_example_page.jpg|center]]
-# Now you can start entering text in the WYSIWYG editing box. When you finish and click on Save page, your entry will appear on a wiki page. As explained in the Introduction, you can use the WYSYWIG toolbar to perform basic formatting.
-# Use the template called term:<nowiki> {{Term|TERMNAME|Definition}}</nowiki>
-#:{{Term|TERMNAME|Definition}}
-#:Write the term you want to add in capital letters in the space marked as TERMNAME and use the space called definition to enter your explanation. It can be either a sentence or a very long definition.
-# Use the instructions given in section A (page 6) to edit the page, add links to websites or documents, add references and tables.
-# Note that it is not possible to integrate a table inside a template. If you want to have a table in the definition, you will have to close the template by entering : <nowiki>}}</nowiki>) and then add the table.
-#:If you would like to add more information in the definition below the table, add the template '''Termaddition''':<nowiki>{{Termaddition|Text}}</nowiki>.
-#:The result will be a simple box, with the blue lines framing it and no title. It will look like the template is following from the previous one.
-#:{{Termaddition|Text}}
-#:Below you can see an example of the use of table and of the '''Termaddition''' template:
-#:[[Image:accelerated_learning.jpg|center]]
-#:The template definition ends before the first table. The text between the first and the second table and the last sentence are contained in the template Termaddition.
-#Once the new definition has been created, all the sources of the information contained in it should be cited in the References section at the end of the page. The instructions to do so are in section A (page 8).
-# The sources should also be included in the Bibliography of the website, where you can find two lists, one for the books and articles and another one for the websites. Websites should be added to the top of the list, always including dates when they were consulted.
-# Once you have created the term in the overall repository, a link to it should also be added in the other terminologies where the term might belong to. For example, if the new term is related to e-learning, a link to it should also appear in the E-learning list. The following categories are currently listed: E-learning, Knowledge Management, Monitoring & Evaluation.
-===Adding a Toolkit===
-If a definition already exists, or you have already created it, and you want to add more information on how a particular method can be used, or how to put in practice a particular technique, you can use the toolkits template. The information contained in this section is supposed to be Step-by-Step or General Guidelines format.
-Below you have an example of a toolkit from the click4it website:
-[[Image:organizing_a_role_play.jpg|center]]
-# Go to the page of the definition where you would like to add a toolkit and click on ''Edit''.
-# Enter four empty rows between the end of the definition and the References section.
-# Use the template called '''Tool''': <nowiki>{{Tool|ToolkitTitle|Text}}</nowiki>
-#: {{Term|ToolkitTitle|Text}}
-# Use the instructions given in section A (page 6) to edit the page, add links to websites or documents, add references and tables.
-# If you want to add a table, you should close the template and open a new one afterwards, as explained under point 7 of the previous section (page 10).
-# Add the link to this page in the Toolkit Section, so that the users may know that they will be able to find more detailed information for that term.
-==='''Including additional material'''===
-If you have files related to a term that could be useful for other users of the click4it website, you might want to add a section of additional materials.
-Additional materials must be uploaded in a PDF format.
-# Go to the page of the definition where you would like to include additional material and click on ''Edit''.
-# Enter four empty rows between the end of the definition or the toolkit (if it exists) and the References section.
-# Use the template called '''Addmaterial''': <nowiki>{{Addmaterial| List of files}}</nowiki>
-#: {{Addmaterial|[[Image:pdf.png]] List of files}}
-# Create links to the files that you should have uploaded beforehand, as explained in section A (page 6).  The syntax to link a site is: <nowiki>[[Media:FileName.extention|WordToBeClicked]]</nowiki>
-# In the same line where you create the link to each file, in front of the link, add a small PDF file icon by typing this: <nowiki>[[Image: pdf.png]] </nowiki>so that the user may know what kind of file he/she is downloading (as shown in the image above).
-==='''Adding a list of web resources'''===
-Whenever you come across interesting websites related to a term on the click4it site (information, tools, examples, etc.), you might want to create a section to display all of these links.
-When creating this section, include a brief explanation of what kind of information/materials are available on the page, so that the user would have an indication of the sort of information/material he/she will find in the link.
-As shown in the example below, a good way to organize the information for this section is to use a table format.
-[[Image:web_resources.jpg|center]]
-# Go to the page of the definition where you would like to add a list of web resources and click on edit.
-# Enter four empty rows between the end of the definition, the toolkit or the additional material (if these sections exist) and the References section.
-# Use the template called '''Addlink''': <nowiki>{{Addlink|List of resources}}</nowiki>
-#: {{Addlink|List of resources}}
-# Create the links to the websites. The syntax to create a link to a website is: <nowiki>[http://www.google.com WordToBeClicked]</nowiki>
-#: It is a good rule to repeat the website name this way: <nowiki>[http://www.google.it www.google.it]</nowiki>, so that the user sees which is the site he/she will be directed to.
-# If you want to present all the links in a table format,  you can use a different template: '''Addtitle''': <nowiki>{{Addtitle}}</nowiki> starting right after the blue title - Web Resources.
-#: {{Addtitle}}
-#: This way you will be able to add a table right after the title. If you want to add then a part of text inside the usual box, you can use the template '''Termaddition''', as shown in section B.1, point 6 (page 7).

Navigation

Search

Toolbox

LANGUAGES