Help:Tutorial

From WaterWiki.net

Jump to: navigation, search
Offering you a helping hand
Offering you a helping hand

This step-by-step tutorial is a helping hand for you to learn all that you need to know to contribute/edit/find knowledge.

If this is your first time on Waterwiki, following the directions below is the perfect, and quickest way to become a wiki expert! You'll realise just how easy (and fun!) it is in no time!


Contents

CONTRIBUTING KNOWLEDGE

CREATING a new page

To create a new page, you must be logged in. Click "Log in" in the top right-hand corner if you are a registered user. If you are not a registered user you may request an account.

By inserting a link

This is the best way to create a new page, because it means that right from the start, the page will be linked from at least one other place on the wiki (and typically you will want to mesh it into other related pages later). Normally there is no reason to create a page without first creating a red link to it.

Simply type



[[The Title of Your New Page]] into a suitable existing article where it fits well, or add square brackets ([[ ]]) around a term/phrase that is not yet linked to, but deserves a page in itself and you want to create that page (please try to be specific; e.g. "Kazakhstan NHDR 2003", not just "NHDR").


When creating a link to a non-existent page, the link will be coloured orange. Click on the orange link. This will take you to the edit page for the article you wish to create.


Select the relevant page type template, and simply fill in the sections. Be sure to select "add a map" at the top of the page, to add a google map to your page, where appropriate. Also add categories from the keyword box/category hierarchy at the foot of the page. Categories chosen will be displayed in the "Category Selection Box" in edit mode, and are crucial for enhancing the functionality and usability of the wiki (see below). NB: It is best to make only text edits at this stage. Adding a picture is best done once you have saved.


To see what your page will look like, click "Show Preview", then "SAVE" and the new page will be created and saved on the wiki. It is that simple!


I have created my page, but now want to add a picture. How do I do this?

Where appropriate, it is best practice to add an image to articles. Click "Upload File" on the navigation toolbar, and "Browse" to select the specific image from those saved on your computer. ( Images must be in JPG or GIF format). Once selected the name of the image will appear in the “source filename” box. Click "Upload file". On uploading, a page will appear notifying this, with details such as



[[Image:File_name.jpg]] . Simply copy and paste this to your page as necessary (use "recent changes" in the navigation bar to easily locate your recently created page).The same procedure can be followed to upload a document (in word format). However, in such cases



[[Image:File_name.jpg]] must be changed to



[[Media:File_name.jpg]] (i.e. Image, replaced with Media)
.

The page you have just created is not a homepage, but one of the 1000’s of pages of information on the wiki, each linked to related pages; part of the interlinked, expanding body of knowledge that waterwiki aims to be!

Once the page has been created, the previously orange link will now appear blue.

What will happen to my article now?

Other users may decide to edit your page – either by adding content/altering existing content/linking it to other articles. Every edit made can be detected by clicking on the "history" tab. This also allows any erroneous edits to be overruled by restoring to an earlier/the original version. Only deleting the page, using the "delete" tab at the top of the article will remove the article from the wiki.

I’ve misspelt the title of the article, and wish to edit it. How can I?

Unfortunately, you cannot edit titles once they have been created. To change the title of your page so it reads correctly, the page has to be moved. Select the "move" tab on the top of the page, edit the article title as you wish and select "Move page". All links to the previous page will be redirected to this new, correctly titled page.

By using the search function

Alternatively, you can type the The Title of Your New Page into the Search box in the navigation toolbar and click "search". Choose "create a page with this title", and follow the same steps as above.

FORMATTING your article

Wiki’s require special syntax to present text as bold, or in italics for example. For tips on how to make your article look how you want it to, see Help:Formatting.

Best practice

Interlink

To enable users to find your article when reading related pages, please interlink it as much as possible to pages where you would expect other users to find the information you just entered.


Simply, open those pages in edit-mode and add


[[TITLE OF YOUR NEW PAGE]] at the appropriate place(s), or add


[[TITLE OF YOUR NEW PAGE]] in the See also section of related articles. E.g. "Kazakhstan HDR 2003" would deserve a link from the Kazakhstan page.


Beyond placing a link to your new page from other pages, also create links to other wiki pages from yours. Add related article titles in the See also section, and simply add square brackets [[ ]] around terms/phrases in your article text that are the titles of other articles.


E.g. The UN works in many African countries including Mozambique and Ethiopia, to improve access to safe water and sanitation.....could be linked as follows......

The


[[UN]] works in many


[[Africa|African]] countries including


[[Mozambique]] and


[[Ethiopia]] , to improve access to safe water and


[[sanitation]] . NB: How ‘African’ is linked to the ‘Africa’ page. Africa is the page we want to link to, but African is the word in the text, and so we link to the page we want without changing the wording of the sentence using a | between the two words.


Categorise

Ensure all appropriate categories are selected before saving your page. Typically, an article should be categorised with its:

  1. location (water basin/country(ies)/region(s)) all found in the category hierarchy;
  2. theme (e.g IWRM, transboundary water, sanitation, WSS etc) from the keyword box
  3. Organisation (the author of a publication/implementing agency(ies) of a project etc) from the category hierarchy.
  4. Mapped EVERY time a google map is added to a page, using the "add a map to this article" option in edit mode.


Why do I need to categorise?

Categorising pages are crucial for the wiki’s functionality and usability. For example, categorising a page by topic e.g “IWRM”, ensures it appears on the Category:IWRM page, on which a user can find all pages concerning IWRM on the wiki. The same is true for pages related to a water basin, country etc. Categories are also used in Dynamic Page Lists, which are used throughout the wiki to list related articles. (see Help:Categorising for further information).


Add graphic/Map

Where appropriate, select add a map to this article when creating a page (also an option whenever editing a page). Place the cursor on the map, and zoom in/navigate until the correct location is in view. On saving the page, the google map will appear in the top right-hand corner of your article.


Why should I map my article?

By mapping articles, interactive google maps (at the country, region or global scales) can be created displaying all projects on a world/regional map for example. (e.g. A map of all projects in Central Asia).


In addition to adding a map, where appropriate also upload an image to display on your page. E.g the cover of a publication, or an organization’s logo etc...or any other picture that helps to make your article aesthetically pleasing!!! Simply use the upload file option in the navigation bar (when not in edit mode), browse and select the image you want to add, and click upload. On saving a page will appear notifying this. Copy and paste the


[[Image:Newphoto.jpg]] to your article and format as desired.


Attachments

Especially when creating a page on a publication, best practice is to copy and paste the executive summary in the “description” section of the semi-structured page template, and upload the full document (as a word doc/PDF) in the "attachments" section at the bottom of the page. Attachments may also be added to other page types (e.g. related to an event), but ALL pages created referring to a publication should ideally have the full publication attached.

EDITING an existing article

If instead of creating an entire new article, you wish to edit a section/sections of an existing article, click the "Edit"-tab on top of any article page and you will be presented with a 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, which you can edit as you wish. "Show Preview" if you wish, and then "Save". Before you save a change, you may enter a short note in the Summary box describing your changes. Don't worry too much about this, or spend too much time thinking about it, but a little description of what you just changed e.g. "fixed typo" or "updated project information with lessons learned" allows people to track changes in waterwiki more effectively.


Remember: Create links to other articles, by using square brackets around terms/phrases wherever possible. Also edits can always be overruled by reverting back to a previous/the original version of an article. So don’t fear to be bold in your editing!!


For tips on font styles and more, see Help:Formatting.


FINDING KNOWLEDGE

If instead of contributing you are searching for a specific article/browsing knowledge, here is what to do:

Type the name of the article you are looking for in the Search box located in the navigation bar and click search. If you cannot recall the exact title, just type one or two keywords into the search box and click search. A list of pages with those keywords in their titles will appear for you to choose from.


I have found the article I was searching for, but now want to find other related articles. How can I?

This is easy, and exactly what "See also" sections are for. Simply scroll down to the "See also" section of the article you are reading, and click on the links to other articles listed. Alternatively, you can also find other articles on the same topic by using the categories listed at the bottom of the page. For example, if the categories listed include Georgia, Project, IWRM and Europe & CIS, it is likely the article you are reading refers to an Integrated Water Resources Management project in Georgia. Clicking the Georgia category will allow you to browse all pages on Waterwiki referring to Georgia. But you may wish to find other IWRM articles in which case click IWRM category, and browse.


See Help for further information and guidance.