Wiki guidelines
The following Wiki guidelines should be followed when writing wiki pages. This will help create a useful and easy to use wiki, that is accessible to everyone. WikiProject Cleanup is a page coordinating work on the wiki in part to increase conformance with these guidelines.
Understandability
Keep pages short, use simple language and avoid jargon. OpenStreetMap aims to be accessible to all, and our documentation should reflect this. Aim your writing at the level of children and grandmothers!
Some wiki pages naturally take the form of technical documentation. Even within these we should aim to be understandable to users with a range of technical abilities. Write simple introductions to lead into a topic, and consider splitting off very complex details to separate more focussed wiki pages.
Structure
The wiki should be arranged to allow people to easily find the content they are looking for starting from the Main Page. Some key content is linked directly from the Main Page, but other main page links take you to 'start pages' on a particular topic. They are the next level in a kind of navigation hierarchy. They are often short pages with many links and not too much text (also known as 'portals'). Work is needed to ensure that this navigation is still working effectively for new visitors.
Conflicting information
Conflicting information is very bad. Information about current tagging recommendations should be consistent. If this is not the case please get in touch with other users to develop a consensus. Tagging recommendations should ideally match actual tagging practice, unless there is a valid reason not to do so.
Proposals and proposed changes to tagging are the exception to this rule. They must however be clearly be identified as proposals.
Duplication
Duplication is often bad because it risks providing conflicting information and increases the amount of work. Where there is unnecessary duplication, it should be rationalised to provide a single clear source of information. This may require discussion with other users! It is fine to summarise a topic in another page but that summary would link to the main page.
Template:merge is used to label pages which require reorganisation to remove duplication.
Where duplication is useful (for example, it is being presented in a different style, page structure, or for differing audiences), it is important to be clear about the reasoning for this, and cross-link to avoid confusion. If there is no good reason for duplication, then the pages should be merged. Note that a merge does not necessarily mean we are left with one page where there were two before. There are other outcomes, for example a non-technical summary page page may link to a more detailed technical page.
Titles - Page naming convention
Please follow Wikipedia capitalising naming conventions: For multiword page titles, leave the second and subsequent words in lowercase unless the title phrase is a proper noun that would always occur capitalized, even in the middle of a sentence.
Do not use CamelCasePageTitles in which words are jammed together with no spaces - MediaWiki allows us to use spaces as in natural language. The exception to this would be where the page title is the name of something which does typically have its words jammed together e.g. "OpenLayers"
Prefixes in page titles have been used heavily in the past (e.g. the 'WikiProject' prefix). This is mostly a cumbersome legacy, but not one we can't easily rectify at this stage. Moving all such pages would be a very big task. However creating new page title prefixing schemes is strongly discouraged. Use natural language page titles, and cross-link a set of pages to create linking structures in the content of the pages themselves. Please refer to the Wiki organisation for the current discussion on this topic.
Introduction
Pages should start with a short introductory paragraph comprising a few sentences. This should include the title in bold and explain what the page is about. It's often useful to include a link to a more general page and to any more specific pages, as this helps navigation.
This introductory section should appear before any headings (and before the Table of Contents on a long page). Note that it is fairly common for people to create a first heading "Introduction". This should be restructured so that at least part of the introduction is at the top of the page above any headings. This will achieve a consistent layout across the wiki.
Linking
Pages should be well linked to help users find the information they are looking for. Important related concepts are usually linked to within the introduction. If you can't think of a related wiki page to link from here, then you're probably not describing the page in broad enough terms. You are also encouraged to link to related concepts throughout the rest of the page.
Linking a section to a main page
The {{main|page name}} code could be used under a section heading to provide a link to a main page relating to the subject of the section. The section should then only summarise the linked 'main' page (and should certainly not conflict with it in any way). The title for the section should normally be the same as the page to which it is linked.
Linking to and styling of keys or values
Often, texts contain related keys or values. If you use the templates (in other wiki softwares called "macros") Template:Tag (Key is an alias), Template:Value and related by typing wiki source {{Tag|highway|motorway}} or adding it using the editor's menu, the text appears like highway=motorway which has several advantages:
- Due to the standardized and well-known formatting, the text can be recognized as key=value at first glance, while that is more difficult with plain text.
- Both key and value are each a link of it's own, making it easy to find more information.
- It is an interal link, so it leads a user to the page in the current language, it won't break even if URLs do change, it can be followed in both directions, it can be analysed for statistics, etc.
Wikipedia linking
Wikipedia links can be confusing. Only link to wikipedia if it's useful, and if the concept is not better explained in an OSM context on this wiki.
If using the [[wikipedia:page name]] interwiki syntax, please leave the wikipedia: prefix in place i.e. don't do alternate link text: [[wikipedia:page name|page name]] as this is hugely confusing in a basic navigational sense. However you may use a template to make the external link to Wikipedia more explicit: {{Wikipedia|en|Page name}}, or {{Wikipedia|en|Page name|text= no }} to just keep the leading icon without the trailing text "on Wikipedia".
Don't link to a Wikipedia page where the same or similar title exists on this wiki (except from the article on this wiki, where it could be used as an additional external reference for more information about the same topic).
Page about a website
We have lots of wiki pages dedicated to describing some external website (map services, software products etc). Obviously the external link to that site is hugely important. The main link should be placed in brackets after the title (which is bold) in the very first sentence and/or linked in larger text on it's own line after the top descriptive sentences.
On these pages there is no point duplicating lots of 'about' information found on the external site. The page should describe the site in an OSM context. Be more neutral and less promotional with your description, although do aim to use language which promotes OSM and uses of OSM.
Listing software / services
We have a number of pages containing bullet pointed lists or wiki tables listing software / services. If we have wiki pages about the software, or even if we haven't (red links) the preferred format is an internal link to the OSM wiki page followed by an external link to the site in brackets. This might then be followed by a short description or other table columns. We should aim to provide links to both the wiki page and the external link even where the wiki page doesn't exist yet to encourage a healthy level of wiki interlinking. Red links can be filled in with stub information following the advice above.
Full URL external links can be nice, if they are short, since the user knows what to expect when they click it. Alternate link text should be used to shorten this, preferably to the domain name so that it's still clear that this is an external link.
Example:
- OpenLayers (openlayers.org) - A JavaScript library for showing maps.
In very space constrained situations (often in the case of wiki tables) we might use the numbered link syntax (e.g. [1]) to shrink the external link right down. We might opt to drop the external link and only link the wiki page, since this will itself have the external link. If the wiki page doesn't exist we might opt to only provide an external link, but it might be better to create a wiki page with stub description.
Categories
Categories should be used to group pages by type which should follow the same naming conventions as with wiki pages.
Categories can themselves be categorised to create a hierarchy to help navigation to the subject of interest. For example Category:Buses is categorised within Category:Public transport.
Pages can be part of a number of categories but should not 'spam' categories. A page relating to buses (for example, a page about bus stops) should be categorised as 'Buses' but not also as 'Public transport'. However, the main Buses page should be tagged within the 'Public transport' category as well as the more specific one.
A single line introduction should be provided for every category which should in general link to an appropriate 'main' page for the subject, ideally of the same name. For example 'Pages relating to [[Public transport]] as an introduction to the category 'Public transport'.
When being categorised, pages should use the sort order option if necessary to ensure that they appear appropriately in the list of pages. For instance look at the pages listed in Category:Users in London. They would all be listed under 'U' because of the 'User:' prefix, but this has been overridden. For example the User:Harry Wood has the category wiki text: [[Category:Users in London|Harry Wood]] with the sort phrase provided after the '|'.
This wiki provides HotCat-Gadget, a simple interface for changing categories.
Language
OpenStreetMap uses British English for general English pages and the appropriate 'local' English for localised topic pages. So any page which mostly concerns the U.S., for whatever reason, would use American English. This particularly applies to place pages under Mapping projects.
Translation
See Wiki Translation. This includes some introductory philosophical thoughts on what we aim to achieve with translations within the wiki. Migration to Translate extension has been discussed several times, but the current consensus seems to oppose this.
Date formatting
Dates should be formatted in one of these ways depending on the precision required:
- 27 November 2024 (the normal format, unless there is uncertainty or where the day is highly relevant; no need for the leading zero in the day value)
- Wednesday 27 November 2024 (for when the day of the week matters)
- November 2024 (day of month is not known nor relevant)
- 2024-11-27 (fixed format from ISO 8601 standard, to be used in tabular data, especially when content should be transcluded into multiple translated pages; includes zero left-padding)
- 2024-11 (similar when day of month is not known nor relevant)
- 2024 (year only, without thousands group separator)
- 'Soon' (November 2024) (when a prediction was made at a particular time)
Ordinal suffixes (th, nd, rd) are not necessary, and days and months should be written out in full. Avoid incomplete dates that are unclear, and avoid the use of seasons (summer in the northern hemisphere is winter down south!).
Edit descriptions
Remember to use "Summary" field during editing to indicate what was changed. It helps other editors.