Template:Software/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search

This template collects all notes of a software together. Some common information is displayed as an infobox.

To describe a tile layer or slippy map you can use Template:Layer.

Hint: Please only document software for end users in this way. Libraries can be documented here: Software libraries

Who also uses this data?

The template was also used by User:TTTBot to extract data for the software tables.

Now data from this template are extracted by:

The template and the Module:Software also adds categories and subcategories listed in Category:Software

Usage

Use only one single instance of this template! Don't add multiple ones on translated pages! You don't have to provide all information but try to gather as much as possible to get a nice overview for different perspectives of your tool (e.g. navigation, development, ... aspects).

{{Software
| name           = {{subst:PAGENAME}}
| screenshot     = <!-- xyz.jpg -->
| logo           = <!-- logo.png -->
| author         = <!-- who develops the software? -->
| license        = <!-- GPL;MIT;BSD;Apache 2.0;proprietary -->
| price          = <!-- 20$;35€;gratis -->
| platform       = <!-- Android;iOS;Linux;MacOS;web;Windows -->
| status         = <!-- one of: active, unmaintained, broken, unfinished -->
| version        = <!-- 1.0 -->
| date           = <!-- 2024-12-24 -->
| languages      = <!-- de,en,mul -->
 | languagesurl  = <!-- optional URL -->
| web            = <!-- https://www.example.org -->
| repo           = <!-- https://git.example.org -->
| code           = <!-- C;C++;C#;Python;Java -->
| framework      = <!-- GTK+;mono;J2ME;OpenGL -->
| description    = <!-- write your own description, don't just copy it from the website -->
| genre          = <!-- display;navi;logger;router;editor;renderer;converter;analyser -->
| coverage       = <!-- Worldwide or Continent, Country, Region, ... -->

<!-- Install options-->
| asin               = <!-- XXXXXXXXXX -->
| fDroidID           = <!-- org.example -->
| googlePlayID       = <!-- org.example -->
| huaweiAppGalleryID = <!-- XXXXXXXXXX -->
| appleStoreID       = <!-- id12344556 -->
| macAppStoreID      = <!-- id12344556 -->
| microsoftAppID     = <!-- XXXXXXXXXXXX -->
| obtainiumLink      = <!-- https://github.com/organicmaps/organicmaps/wiki/Installing-Organic-Maps-from-GitHub-using-Obtainium -->

<!-- Map -->
| map              = <!-- yes or no -->
| mapData          = <!-- raster;vector -->
| datasource       = <!-- online;cache;offline -->
| rotateMap        = <!-- yes or no -->
| 3D               = <!-- yes or no -->
| showWebsite      = <!-- yes or no -->
| showPhoneNumber  = <!-- yes or no -->
| showOpeningHours = <!-- yes or no -->

<!-- Routing -->
| routing                 = <!-- yes or no -->
| createRouteManually     = <!-- yes or no -->
| calculateRoute          = <!-- yes or no -->
| createRouteViaWaypoints = <!-- yes or no -->
| profiles                = <!-- car;bike;foot;wheelchair;public transport -->
| turnRestrictions        = <!-- yes or no -->
| calculateRouteOffline   = <!-- yes or no -->
| routingProviders        = <!-- OpenRouteService;Yours;CloudMade;MapQuest -->
| avoidTraffic            = <!-- yes or no -->
| trafficProvider         = <!-- todo -->

<!-- Navigating -->
| navigating      = <!-- yes or no -->
| findLocation    = <!-- yes or no -->
| findNearbyPOI   = <!-- yes or no -->
| navToPoint      = <!-- yes or no -->
| voice           = <!-- yes or no -->
| keepOnRoad      = <!-- yes or no -->
| turnLanes       = <!-- yes or no -->
| withoutGPS      = <!-- yes or no -->
| predefinedRoute = <!-- yes or no -->

<!-- Track logging -->
| tracking           = <!-- yes or no -->
| customInterval     = <!-- yes;no -->
| trackFormats       = <!-- gpx;kml;nmea;csv;trk;... -->
| geotagging         = <!-- note;photo;audio -->
| fastWayPointAdding = <!-- yes or no -->
| uploadGPX          = <!-- yes or no -->

<!-- Track monitoring -->
| monitoring          = <!-- yes or no -->
| showTrack           = <!-- yes or no -->
| showExistingTrack   = <!-- yes or no -->
| showAltitudeDiagram = <!-- yes or no -->
| showDOP             = <!-- yes or no -->
| showSatellites      = <!-- yes or no -->
| showNMEAlive        = <!-- yes or no -->
| showSpeed           = <!-- yes or no -->
| sendPosition        = <!-- yes;no;sms;mail;www -->

<!-- Editing -->
| addPOI          = <!-- yes or no -->
| editPOI         = <!-- yes or no -->
| addWay          = <!-- yes or no -->
| editGeom        = <!-- yes or no -->
| editTags        = <!-- yes or no -->
| editRelations   = <!-- yes or no -->
| viewNotes       = <!-- yes or no -->
| createNotes     = <!-- yes or no -->
| editNotes       = <!-- yes or no -->
| editSource      = <!-- online;cache;offline -->
| offsetDBsupport = <!-- yes or no -->
| uploadOSMData   = <!-- yes or no -->

<!-- Rendering -->
| rendererOutputFormats = <!-- svg;pdf;png;... -->

<!-- Accessibility -->
| accessibility       = <!-- blind;wheelchair -->
| textOnlyUI          = <!-- yes or no -->
| brailleUI           = <!-- yes or no -->
| explorerMode        = <!-- yes or no -->
| publicTransportMode = <!-- yes or no -->
| dangerWarnings      = <!-- yes or no -->
| screenReader        = <!-- NVDA;...  -->
| screenReaderLang    = <!-- EN;DE;... -->
}}

Technical details

This template uses:

TemplateData

This template collects all notes of a software together. Some common information is displayed as an infobox other are display in third-party software.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Template languagelang

Language in which the template texts are displayed.

Example
en
Lineoptional
Namename

Official name, otherwise most common one

Auto value
{{subst:PAGENAME}}
Linerequired
Statusstatus

Current status of the project.

Suggested values
active unmaintained broken unfinished
Default
active
Linesuggested
Licenselicense

What free license or proprietary?

Suggested values
GPL BSD MIT free proprietary AGPL
Example
GPL
Lineoptional
Priceprice

Costs if proprietary. If price is empty, application is for free.

Suggested values
free in-app purchases ads
Example
free;20$;35€;in-app purchases
Lineoptional
Web addressweb

no description

Example
https://www.example.org
URLsuggested
Source coderepo git svn

URL to view or download the source code (for example, a Git, Subversion, or CVS repository)

Example
https://git.example.org
URLoptional
Logologo

no description

Example
xyz.png
Fileoptional
Screenshotscreenshot

no description

Example
xyz.jpg
Filesuggested
Descriptiondescription

Brief description. What distinguishes this from other tools? (Write your own description, don't just copy it from the website)

Example
Easy to use, nice UI
Stringsuggested
Authorauthor

Name of the author or a link to their OSM-wiki user page

Linesuggested
Supported platformsplatform

List of platforms it runs on.

Suggested values
Linux Android Firefox OS Maemo MeeGo Openmoko Linux Tizen WebOS iOS iPhone iPad iPod touch macOS Unix Bada OS BSD FreeBSD Amiga OS MorphOS ArOS Windows Windows XP Windows 2000 Windows Vista Windows 7 Windows 8 Windows 8.1 Windows 10 Windows CE Windows Mobile Windows Mobile 5 Windows Mobile 6 Windows Mobile 2000 Windows Mobile 2003 Pocket PC Windows Phone BlackBerry OS Brew Palm OS Symbian Cross-platform Java Java ME Java SE Node.js Qt React Native Unity Web
Example
Android;iOS
Linesuggested
Genregenre

Main category for this tool.

Suggested values
display navi logger router editor renderer converter analyser
Linesuggested
Languageslanguages

Supported languages (list of valid language codes separated by semicolons) or number of languages supported

Suggested values
aa ab af ak als am an ang ar arc as ast av awa ay az ba bar bcl be be-tarask bg bh bi bm bn bo bpy br bs bug bxr ca cdo ce ceb ch cho chr chy co cr cs csb cu cv cy da de diq dsb dv dz ee el en eo es et eu ext fa ff fi fj fo fr frp fur fy ga gan gbm gcf gd gil gl gn got gu gv ha hak haw he hi ho hr ht hu hy hz ia id ie ig ii ik ilo inh io is it iu ja jbo jv ka kg khw ki kj kk kl km kn ko kr ks ksh ku kv kw ky la lad lan lb lg li lij lmo ln lo lt lv lzz man map-bms mg mh mi min mk ml mn mo mr mrh ms mt mul mus mwl my na nah nap nb nd nds nds-nl ne new ng nl nn no nr nrm nso nv ny oc oj om or os pa pag pam pap pdc pi pih pl pms ps pt qu rm rmy rn ro ru rup rw sa sc scn sco sd se sg sgs sh si sk sl sm sn so sq sr-latn sr ss st su sv sw ta te tet tg th ti tk tl tlh tn to tpi tr ts tt tum tw ty tzm udm ug uk ur uz ve vec vi vls vo vro wa war wo xal xh xmf yi yo yue za zh zh-classical zh-CN zh-hans zh-hant zh-min-nan zh-tw zh-yue zu
Example
DE;EN;MUL
Lineoptional
Languages URLlanguagesurl

Link to the actual full list of languages supported, described on another page (e.g. a portal page for the software, or a repository).

URLoptional
Coveragecoverage

Coverage or target region of the app. Formatting: "Continent, Country, Region, ...". Use "Worldwide" or leave it empty for global use.

Default
Worldwide
Example
Europe, Switzerland, Zurich, Gossau
Lineoptional
Codecode

List of programming languages used.

Suggested values
C Objective-C Objective-C++ C++ C# Visual Basic .NET Pascal Java JavaScript ActionScript HTML CSS Perl PHP Python Ruby Lua SQL Swift TypeScript .NET Node.js
Lineoptional
Frameworkframework

List of frameworks used.

Suggested values
GTK+ mono J2ME OpenGL
Example
GTK+;mono;J2ME;OpenGL
Lineoptional
Versionversion

Latest version

Example
1.0
Lineoptional
Release datedate

Latest release date

Example
2010-12-24
Dateoptional
Amazon Identificationasin

Amazon Standard Identification Number for the Amazon Appstore for Android

Example
XXXXXXXXXX
Lineoptional
BlackBerry IDbbWorldID

BlackBerry World application ID

Example
XXX
Linedeprecated
F-Droid IDfDroidID

F-Droid application ID

Example
org.example
Lineoptional
Firefox Marketplace IDfirefoxMarketplaceID

Mozilla Firefox Marketplace application ID

Linedeprecated
Google Play IDgooglePlayID

Google Play Store application ID

Example
org.example
Lineoptional
Huawei AppGallery IDhuaweiAppGalleryID

Huawei AppGallery application ID

Example
CXXXXXXXXX
Lineoptional
AppStore IDappleStoreID

iTunes App Store application ID

Example
id12344556
Lineoptional
Mac AppStore IDmacAppStoreID

Mac App Store application ID

Example
id12344556
Lineoptional
Microsoft IDmicrosoftAppID

Microsoft Store Windows application UUID

Example
XXXXXXXXXXXX
Lineoptional
Obtainium Updater LinkobtainiumLink

Link to Obtainium updater information

Example
https://github.com/organicmaps/organicmaps/wiki/Installing-Organic-Maps-from-GitHub-using-Obtainium
Lineoptional
Display mapmap

[Map display] Can it show a map?

Suggested values
yes no
Lineoptional
Map datamapData

[Map display] Maps drawn using pre-calculated/rasterized images (raster) or "on the fly" (vector)?

Suggested values
raster vector
Lineoptional
Sourcedatasource

[Map display] Can you store all map data offline? Download a separate file?

Suggested values
online cache offline
Example
online;cache
Lineoptional
Rotate maprotateMap

[Map display] Does it turn the map in driving/walking direction?

Suggested values
yes no
Lineoptional
3D view3D

[Map display] Is there some 3D or 2.5D view?

Suggested values
yes no
Lineoptional
Shows websiteshowWebsite

[POI Information] Shows link to the website from POI

Suggested values
yes no
Lineoptional
Shows phone numbershowPhoneNumber

[POI Information] Shows phone number from POI

Suggested values
yes no
Lineoptional
Shows operation hoursshowOpeningHours

[POI Information] Shows hours of operation from POI

Suggested values
yes no
Lineoptional
Routingrouting

[Routing] Can you calculate or otherwise plan a route?

Suggested values
yes no
Lineoptional
Create route manuallycreateRouteManually

[Routing]

Suggested values
yes no
Lineoptional
Calculate routecalculateRoute

[Routing] Can it calculate a route using routing?

Suggested values
yes no
Lineoptional
Create route via WaypointscreateRouteViaWaypoints

[Routing] Able to calculate route via Waypoints

Suggested values
yes no
Lineoptional
Routing profilesprofiles

[Routing] What profiles supported if it makes routing?

Suggested values
car bike foot wheelchair public transport
Example
car;bike;foot;wheelchair;public transport
Lineoptional
Turn restrictionsturnRestrictions

[Routing] Can it deal with turn restrictions?

Suggested values
yes no
Lineoptional
Calculate route without Internet (Offline routing)calculateRouteOffline

[Routing] Does it need internet to calculate a route?

Suggested values
yes no
Lineoptional
Routing providersroutingProviders

[Routing] What routing service(s) does it use?

Suggested values
OpenRouteService Yours CloudMade MapQuest Graphhopper OSRM Valhalla
Example
OpenRouteService;Yours
Lineoptional
Avoid trafficavoidTraffic

[Routing] Does app optimize route to avoid traffic jams?

Suggested values
yes no
Lineoptional
Traffic ProvidertrafficProvider

[Routing] Traffic data source provider.

Lineoptional
Navigatenavigating

[Navigation] Can you navigate in a compass like way?

Suggested values
yes no
Lineoptional
Find locationfindLocation

[Navigation] Can it search for a street/place?

Suggested values
yes no
Lineoptional
Find nearby POIsfindNearbyPOI

[Navigation] Can it discover/display Points of interests?

Suggested values
yes no
Lineoptional
Navigate to pointnavToPoint

[Navigation] Can it guide you to a point somewhere?

Suggested values
yes no
Lineoptional
Navigation with voice / Voice guidancevoice

[Navigation] Can it give you commands with a computer voice?

Suggested values
yes no
Lineoptional
Keep on roadkeepOnRoad

[Navigation] Can it assist you to keep your vehicle on the calculated route?

Suggested values
yes no
Lineoptional
Lane guidanceturnLanes

[Navigation] Does it support lane guidance?

Suggested values
yes no
Lineoptional
Works without GPSwithoutGPS

[Navigation] Does it work even without a GPS?

Suggested values
yes no
Lineoptional
Navigate along predefined routepredefinedRoute

[Navigation] Can it follow other GPS tracks?

Suggested values
yes no
Lineoptional
Make tracktracking

[Track logging] Can it record a GPS track?

Suggested values
yes no
Lineoptional
Customizable log intervalcustomInterval

[Track logging] Can you tune the interval manually?

Suggested values
yes no
Lineoptional
Track formatstrackFormats formats

[Track logging] What formats for storage can you save your GPS track?

Suggested values
gpx kml nmea csv trk
Example
gpx;csv
Lineoptional
Geotagginggeotagging

[Track logging] Are further mapping techniques supported

Suggested values
note photo audio
Example
note;photo
Lineoptional
Fast POI buttonsfastWayPointAdding

[Track logging] Easy to add a new Waypoint?

Suggested values
yes no
Lineoptional
Upload GPX to OSMuploadGPX

[Track logging] Can it send tracks directly to OSM?

Suggested values
yes no
Lineoptional
Monitoringmonitoring

[Track monitoring] Can you monitor GPS datas?

Suggested values
yes no
Lineoptional
Show current trackshowTrack

[Track monitoring] Show your current track?

Suggested values
yes no
Lineoptional
Open existing trackshowExistingTrack

[Track monitoring] Can it load existing tracks so you can follow them?

Suggested values
yes no
Lineoptional
Altitude diagramshowAltitudeDiagram

[Track monitoring]

Suggested values
yes no
Lineoptional
Show POD valueshowDOP

[Track monitoring] Shows signal quality?

Suggested values
yes no
Lineoptional
Satellite viewshowSatellites

[Track monitoring] Displays satellites?

Suggested values
yes no
Lineoptional
Show live NMEA datashowNMEAlive

[Track monitoring] Can you see the raw GPS stream?

Suggested values
yes no
Lineoptional
Show speedshowSpeed

[Track monitoring]

Suggested values
yes no
Lineoptional
Send current positionsendPosition

[Track monitoring] Can it send position to others?

Suggested values
yes no sms mail www
Example
yes;mail;www
Lineoptional
Add POIsaddPOI

[Editor] Can you add a node?

Suggested values
yes no
Lineoptional
Edit / Delete POIseditPOI

[Editor] Can you edit a node?

Suggested values
yes no
Lineoptional
Add wayaddWay

[Editor] Can you add a way?

Suggested values
yes no
Lineoptional
Edit geometrieseditGeom

[Editor] Can you edit nodes/ways?

Suggested values
yes no
Lineoptional
Edit arbitrary tags of existing OSM objectseditTags

[Editor] Can you edit existing tags?

Suggested values
yes no
Lineoptional
Edit relationseditRelations

[Editor] Can you edit relations?

Suggested values
yes no
Lineoptional
View notesviewNotes

[Editor] Can you view OSM Notes?

Suggested values
yes no
Lineoptional
Create notescreateNotes

[Editor] Can you add OSM Notes?

Suggested values
yes no
Lineoptional
Edit noteseditNotes

[Editor] Can you comment/close OSM Notes?

Suggested values
yes no
Lineoptional
Work offlineeditSource

[Editor] Can you work offline?

Suggested values
online cache offline
Example
online;cache
Lineoptional
Support imagery offset DBoffsetDBsupport

[Editor] Does it support the imagery offset DB?

Suggested values
yes no
Lineoptional
Upload to OSMuploadOSMData

[Editor] Can you send changes to OSM directly?

Suggested values
yes no
Lineoptional
Renderer output formatsrendererOutputFormats

[Renderer] Supported output formats.

Example
svg;pdf;png
Lineoptional
Accessibility supportaccessibility

[Accessibility] Does it help disabled people in some kind?

Suggested values
blind wheelchair
Example
blind;wheelchair
Lineoptional
Complete non graphics text outputtextOnlyUI

[Accessibility] Text to braille compatible interface?

Suggested values
yes no
Lineoptional
Braille interfacebrailleUI

[Accessibility] A special braille interface?

Suggested values
yes no
Lineoptional
Exploration modusexplorerMode

[Accessibility] Has a exploration modus (tell all objects approaching)?

Suggested values
yes no
Lineoptional
Public Transport modepublicTransportMode

[Accessibility] Supports routing with public transport?

Suggested values
yes no
Lineoptional
Danger WarningsdangerWarnings

[Accessibility]

Suggested values
yes no
Lineoptional
ScreenreaderscreenReader

[Accessibility] List of supported screenreaders

Example
NVDA
Lineoptional
Screenreader languagesscreenReaderLang

[Accessibility] List of supported screenreaders languages

Example
EN;DE
Lineoptional

Genre values, not exhaustive

Value Explanation
display The main goal of the software is to display OSM map
navi The main goal of the software is navigation through GPS and routing
logger The main goal of the software is to record a GPS track
router The main goal of the software is to calculate route (not navigation, only computation)
editor The main goal of the software is to edit OSM data and upload changes to OSM server
renderer The main goal of the software is to render OSM data to tile images
converter The main goal of the software is "convert" data
analyser The main goal of the software is to analyse OSM data. For quality assurance.

Todo

See also