Help

From WaterWiki

Jump to: navigation, search
Wikis are very easy to use 
They allow any registered participant to edit and add content to the web-page. Just click on the "Edit"-tab at the top, and once you have entered your text, you just click on "Save page". All previous editions are saved in the "History" page.
If you have any questions about using the wiki, first have a look at the following sections. If there still are questions, contact Juerg Staudenmann


Contents

Site Features

Here's a quick look at the main features of the Wiki software


Basic Structure

In a Wiki, information is organized into "articles". These can be edited or new articles added by people using the Wiki, without going through an editor or facilitator. The Wiki supports collaborative knowledge generation as well as updating.



Top row

Log in
At the top right of the page, you'll see a link to the log in page. Login is not required to read, but to edit or upload documents. Just use your UNDP login and password, or contact the Wiki administrator for a user account.
Watchlist
The watchlist link allows you to track changes made to an article / page that you are interested in. Just add the page you are interested in to your watchlist.


Tabs

At the top of every article/page in WaterWiki are three tabs:

  • The article-tab is selected by default; it displays a particular/page article in regular "read-mode".
  • the edit-tab brings up the editing-window (see below)
  • the history-tab lists the past versions of this article/page; you can compare and display the changes made, or even restore an earlier version
  • the watch-tab marks this article to be displayed bold in the "Recent changes" list



Breadcrumbs

Below the article tabs is a list of the last five pages you've visited in the Wiki. This is useful to find your way back to an article while browsing.


Left Column

Links to useful pages are always available on the left side column of every page.


Navigation
Recent changes is a list of pages that have been recently edited on the Wiki; it is a good tool to get a sense of what's been happening lately.


Go/Search
Search within article titles and article text for keywords. The "Go" button brings you directly to the article/page with the exact name entered in the search window. If irt doesn't exist yet, search results are displayed (and the option to start a new article with this title - see below).


Toolbox
"What links here" displays a list of pages with links to the article you're viewing.
"Upload File" allows you to attach a file to the current article.

Editing

How to open the Editing Box

(For an overview of more editing options check out the Wikipedia Cheatsheet)


Click the "Edit"-tag on top of any article page and you will be presented with an text editing box. You'll also notice [Edit]-links next to individual sections of an article. Within the edit box, you'll see the plain text of the article, but with a bit of special styling instructions for the formatting of the page. Don't be afraid, or put off by these instructions. You're already familiar with the functions, and the Wiki supports rapid access and use..

Don't forget to Save Changes when you have finished editing; click the Save page button below the text editing box. If you wish, enter some text in the Summary describing what you've changed before saving.

Show preview will do just that, without saving the changes, yet. And Cancel if you want to disregard your changes.

-> To play around and get a feel for writing in the wiki, visit the Sandbox. And of course, you are free to edit any article as needed on the system!

Basic text styles (Bold, Italic, Small Font)

The toolbar at the top of the edit box provide easy access to the most common styling instructions. You can either use the buttons in the toolbar or type the commands in yourself.


http://europeandcis.undp.org/WaterWiki/skins/common/images/button_bold.png <b>Bold text</b>

Text contained within <b> and </b> (or alternatively within three apostrophes each ('''TEXT''') is displayed in Bold.


http://europeandcis.undp.org/WaterWiki/skins/common/images/button_italic.png <i>Italic text</i>

Text contained within <i> and </i> (or alternatively within two apostrophes each (''TEXT'') is displayed in Italic.


<small>Small text</small>
Text contained within <small> and </small> appears in smaller font


Colored Text
Use the following tags for colored font: <font color=red>TEXT</font> (instead of red, use other color-names)


Indent paragraph with a bold header
The code for a paragraph that looks in its style like this one here - bold header and indent paragraph text starting on the next line - is written as follows:

; HEADING TEXT
: PARAGRAPH TEXT


Linking to other pages (internal/external)

[[Page Title]] or [[Page Title|LINK TITLE TO APPEAR]]
http://europeandcis.undp.org/WaterWiki/skins/common/images/button_link.png Use [[ and ]] to link to other pages in the WaterWiki. More info in the section "Create a New Page/Article" below.


[http://www.example.com LINK TITLE]
http://europeandcis.undp.org/WaterWiki/skins/common/images/button_extlink.png Use [ and ] to link to webpages outside the WaterWiki, on the WorldWideWeb.


Headings

http://europeandcis.undp.org/WaterWiki/skins/common/images/button_headline.png == Headline text ==

Use == and == to create a new section in the page.



Uploads & Images

Uploading files
Every page has an "Upload file" link in the left side "toolbox" (if you're logged in). Clicking this link and submitting the form will upload your document to the wiki. A link to the document is created at the bottom of the page you started from.
Viewing the source of that page, you'll see something like [[Media:FILE_NAME.doc]] at the bottom. You are free to copy-paste that link anywhere in the page where you want the file (link) to appear, or even remove it if the document is no longer relevant.


Images
Images can be included directly in the page. The image can be uploaded, or linked to from an external site.
Upload an image as instructed above. Position the resulting [[Media:SAMPLE.jpg]] where approriate on the page.
You might also see [[Image::sample.jpg]] in some place. This accomplishes the same thing.
To include a image hosted externally, simply paste the url of that image into the text.


A list of all Upload files and Images is at Special:Imagelist. You can create a link to any of the files by adding the line [[Media:FILE_NAME_.xyz]] to any location of a given page/article, as described above.


---
These are the basic formatting rules to know. You'll notice a few other styling instructions within the system; these are explained in the advanced section. But remember, the important thing is the text -- mostly the formatting is taken care of for you.



Tables

Making tables is a bit more challenging; but just give it a try!

Basics

The entire table
is encased with curly brackets and a "pipe" (|); so use {| to begin a table, and |} to end it. Each one needs to be on its own line.
{|
table code goes here
|}


Each separate row
of the table (with how many cells in each row there will be) starts with a pipe (|) and is encased by a "pipe" followed by a hyphen (|-), each on separate lines.
{|
|-
| 1st line
|-
| 2nd line
|-
|}


The different cells in a row
are divided by a "double-pipe" (||):
{|
|-
| 1st line's 1st cell || 2nd cell || 3rd cell
|-
| 2nd line's 1st cell || 2nd cell || 3rd cell
|-
|}

And that's how it looks:

1st line's 1st cell 2nd cell 3rd cell
2nd line's 1st cell 2nd cell 3rd cell


Borders
can be created by adding "border=X (X = strength of the border line) after the first curly-bracket-and-pipe code; just leave it away to avoid using any borders:
{|
|- border=X
| 1st line's 1st cell || 2nd cell || 3rd cell
|-
| 2nd line's 1st cell || 2nd cell || 3rd cell
|-
|}

And that's how the previous table lookswith border (border-strength=1)..:

1st line's 1st cell 2nd cell 3rd cell
2nd line's 1st cell 2nd cell 3rd cell


Headings on Rows and Columns

You can add column headings by inserting a separate line right after the curly-bracket-and-pipe code starting with an exclamation mark (!) at the top of the table:

{|
! Column-heading 1 || Column-heading 2 || Column-heading 3
|-
| 1st line's 1st cell || 2nd cell || 3rd cell
|-
| 2nd line's 1st cell || 2nd cell || 3rd cell
|-
|}

And that's how it looks (border-strength=4):

Column-heading 1 Column-heading 2 Column-heading 3
1st line's 1st cell 2nd cell 3rd cell
2nd line's 1st cell 2nd cell 3rd cell


You can also add Row Headings: The first cell of a row is identified as row heading by starting the line with ! instead of |, and starting subsequent data cells on a new line. - Don't forget to add an extra Column-heading

{|
! Extra Column Heading || Column-heading 1 || Column-heading 2 || Column-heading 3
|- {|
! 1st Row Heading 
| 1st line's 1st cell || 2nd cell || 3rd cell
|-
! 2nd Row Heading  
| 2nd line's 1st cell || 2nd cell || 3rd cell
|-
|}

And that's how it looks (border-strength=8):

Extra Column Heading Column-heading 1 Column-heading 2 Column-heading 3
1st Row Heading 1st line's 1st cell 2nd cell 3rd cell
2nd Row Heading 2nd line's 1st cell 2nd cell 3rd cell


Advanced

There are even more possibilities

e.g. inserting a Table heading, using different styling details like left- or right-alignment of text in the cells, exact cell measures, background-colors, etc.
-> Find out more on the Wikipedia Help on Tables.


background-color
insert in the first line of the cell the following code
 {|
 ! bgcolor=XYZ
 ...
 |} 

Where

  • bgcolor=#FFFFCC leads to yellow
  • bgcolor=#CCFFFF leads to light-blue
  • bgcolor=#99FF99 leads to light-green
  • bgcolor=#FF9966 leads to orange


For a combination of features and more complex example see the below table code applied here

 {| width=750
 |+ <font color=blue>'''Financing Overview'''</font>
 ! bgcolor=#CCFFFF align="left" | Partner || bgcolor=#CCFFFF align="right" | Co-financing (USD)
 |-
 | Norway || align="right" | 1,085,000
 |-
 | [[Committee for Water Resources]] (CWR) (in-kind) || align="right" | 30,000
 |- border=1 |
 | UNDP (Kaz) || align="right" | 100,000
 |-
 | [[WGF]] / [[Stockholm International Water Institute]] (SIWI) || align="right" | 150,000
 |-
 | GWP CACENA || align="right" | 0
 |-
 | [[DFID]] || align="right" | 86,679
 |- bgcolor=#FFFFCC
 | <font color=red> '''Total''' || align="right" bgcolor=#FF9966 | '''1,450,000'''
 |}

Create a New Page/Article

Creating a new page is simple. You may want to add a Resource or Report to an exisiting page. Or start an entirely new article. It's up to you:

1. Create a new page/article by starting with a link to it from an existing page
Edit an article and insert the following in the text:
[[The Title of Your New Page]]
"The Title of Your New Page" is just that -- set it to whatever you want to name the page (please try to be specific; e.g. "Kazakhstan NHDR 2003", not just "NHDR"). Save the edit, view the article, and you'll see a link to your page in red. Click it...
2. Start a new page/article without linking
Alternately, if you want to create an article/page without linking to it from another page, type the "The Title of Your New Page" into the Search box and click "search". Choose "create an article with this title"...


... you'll now come to a dialog, asking what type of page you'd like to create. There are several preset Templates you can use for your new page/article; or if no template seems appropriate choose "Blank Page" which will simply open an empty new page.
When you have finished writing the first version of your new article, don't forget to click "Save page". Your new page/article has been created and is available real-time!


Inter-link your new (or changed) article/page

PLEASE Link your new page to existing articles

One of the main strengths of a Wiki is that information is inter-linked. After creating (or adding to) a (new) page/article, we strongly encourage you to create links to it from pages where you would expect other users searching for information you just entered.

To do so, just open those pages in edit-mode and add [[TITLE OF YOUR NEW PAGE]]</nowiki]] at the appropriate place(s). <br> ''For example, "Kazakhstan HDR 2003" would deserve a link from the [[Kazakhstan]] page (reports)...'' <br> === Templates === If you choose a template for your new article, you'll see a suggested page/article structure with chapters and styling instructions. The portions to pay attention to are the instructions in ALL CAPS. (e.g. <nowiki>TYPE AUTHOR HERE)

Replace the entire line with the appropriate text. Edit as much or as little of the template as you like .. don't feel compelled to write something if it's not appropriate and feel free to add additional headings, or even delete headings you don't require (or leave them blank for others to complete).


When changing chapter headings, please be aware though that information in certain chapters (e.g. "Description" in the "projects" template) are used in "transclusions" on other pages (see below); the titles of these chapters require to be spelled exactly as given in the template. Equally, please be careful to change the "Category" entries at the beginning of articles/page (e.g. ).



Special Links (featuring "transclusions")

If you want Projects or Reports to contain brief descriptions on the country page, you follow these directions (if not, enter them as described above):

If you are adding a new Project page, insert

<Project>Project Title</Project>

into the article you are linking from. This will display information (project status and description) on the project directly under the project title on the country page.

If you are adding a new Report page, insert

<Report>Report Title</Report>

into the article. This will display the first line of the report description directly under the report title on the country page.

Questions and Comments

Have any queries, problems, suggestions, feedback .. anything on how to use the wiki or thoughts about how it's working, please add that to Suggestion Box and we'll try to answer asap.

Advanced Topics

Want to go in deeper?! Check out the Advanced Help.

Or take a look at the MediaWiki Documentation.

[[Category:Project</nowiki>).]]

740 Rating: 2.5/5 (11 votes cast)