Wiki Help

From OpenStreetMap Wiki
Jump to: navigation, search
Available languages
  About   Guidelines   Organisation   Translations   Cleanup   Help  

This is the help page for editing the OpenStreetMap wiki. For support related to any other aspect of OpenStreetMap, please see the Main Help Page.

Getting started with wiki editing

We aim to build a user friendly wiki that helps OpenStreetMap contributors and users find the information they need quickly and easily. If you can help, please feel free to edit this wiki. Our general advise is to be bold - if a page can be improved, go forth and do it!

Jump straight in: Click 'Edit' at the top of any page, to edit the contents. You do need to create a wiki account before editing.

For introductory instructions on editing wiki pages, see Help:Wiki-Editing. This explains some of the wiki text syntax for achieving special effects in the text such as bold and italic text. You may also wish to visit Wikipedia's help. Wikipedia is the largest online Wiki, and has detailed articles covering almost every imaginable aspect of editing pages. It also has a group of volunteers who answer questions and provide help with editing. The OpenStreetMap Wiki shares the same platform as Wikipedia (namely Mediawiki), so much of what works there will work here too.

Wiki guidelines

Main article: Wiki guidelines

Remember that anyone can edit anything on the OSM Wiki. This includes you. When adding to the wiki, you should seek to find the correct place within the current structure, to build upon the information we already have. This is better than creating a new page as your page where things are written your way. Also be prepared for others to edit the page after you.

The wiki currently needs some re-organisation, and this effort is being coordinated this at WikiProject Cleanup. Large-scale re-arrangements or deletions may be necessary in order to achieve this. Feel free to get involved, but for any change which might be viewed as destructive, you should leave a trail of comments on the associated discussion pages, to explain what you are doing and why. For really big changes which might upset someone, it is best to hold a discussion about it first. Propose the change, discuss it, and reach agreement on the best organisation. Different people have different ideas for how to organise the wiki pages.

History and Discussion

All wiki pages have an associated history page where you can view previous versions of the page. You can also undo a recent edit if you are not happy with the result (although it is always worth previewing any changes before saving an edit). This can be accessed at the top right of each wiki page.

In addition to a history, all wiki pages also include a talk page. This is an ideal place to discuss potential changes to a page, particularly if they are large or could be deemed as controversial. This can be accessed by clicking "Discussion" at the top of each page.

Make a user page

You may want to start by editing your user page. If you wish to tell the OSM community where you are (for example, so neighboring OSM members can collaborate with you to map your locale), place some category links like the following at the bottom of your user page, as necessary to identify the area(s) you want to help map:

[[Category:Users in Country|Username]]
[[Category:Users in State/Province|Username]]
[[Category:Users in City|Username]]

Replace Country with the name of your country, Username with your username, etc. Then your username should appear under the Users by geographical region category tree. If you happen to be the first user in a particular geographical region category (country, city, etc.), the category link at the bottom of your user page will appear in red until someone creates the category page. If you are new to Wiki editing, don't worry about this - someone else should eventually create it for you.

You may also create user subpages, to practice editing before you post something to the main Wiki. Wikipedia provides some help on this.

If you upload images of you or other specific for the user page, place it in Category:User images with code [[Category:User images]].

At your personal page, you can place ready stickers with various information using custom templates. Choose Userboxes by visiting the Category:Userbox

Display OpenStreetMap

This is the OpenStreetMap wiki - of course you can insert the OSM's map into any pages. If you want to use static map image, see Simple image MediaWiki Extension. If you want to use dynamic Slippy Map, see Slippy Map MediaWiki Extension.

Include images from Wikimedia Commons

Since april 2009 it is possible to include images from Wikimedia Commons on the OSM wiki.

Short HowTo: look at Wikimedia Commons for the desired picture and embed it here like this:

[[Image:Dunvegan_Castle_in_the_mist01editcrop_2007-08-22.jpg]]

Options for resizing and placement are

[[Image:image.png|thumb/frame|left/right/center|size in px (e.g. 100px)|
alt=text describing picture (useful for people with screenreaders)|
description here is displayed below the image]]

Example:

[[Image:Dunvegan_Castle_in_the_mist01editcrop_2007-08-22.jpg|thumb|right|
200px|alt=photograph of Dunvegan Castle on the Isle of Skye in the mist|
Dunvegan castle on Isle of Skye]]
looks like this:
photograph of Dunvegan Castle on the Isle of Skye in the mist
Dunvegan castle on Isle of Skye

For a more verbose HowTo see the Wikipedia Picture_tutorial.

Note:
Use only pictures from Wikipedia if the license is Public Domain or CC-BY or CC-BY-SA.
You are NOT allowed to use pictures with GNU-License like GFDL or GPL. In this case you can contact the author and ask if he wants to make his picture available in CC-BY-SA for OSM.
You should probably not use any map image from Wikimedia, even where they are pronounced cc-by-sa on Wikipedia, because this community applies more strict criteria regarding derivative works.

See also Collaboration with Wikipedia.

Include source code

Q: How can I insert some readable source-code in a wiki page, so that it is shown in a non-proportional font, colorized for syntax, etc.?

A: Surround your code with <source lang=*>...</source>, where * is the language - one of:

actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, c, c_mac, caddcl, cadlisp, cfdg, cfm, cpp, cpp-qt, csharp, css, d, delphi, diff, div, dos, eiffel, fortran, freebasic, gml, groovy, html4strict, idl, ini, inno, io, java, java5, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php, php-brief, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vb, vbnet, vhdl, visualfoxpro, winbatch, xml, xpp, z80

For example:

<source lang=perl>
#-TEST--------------------------------------------------------------------------
our $help=0;
my $coord;
print "TEST\n\n";
</source>

is displayed as:

#-TEST--------------------------------------------------------------------------
our $help=0;
my $coord; 
print "TEST\n\n";

see also