Template:Software/doc

This is a documentation subpage for Template:Software.
It contains usage information, categories and other content or metadata that is not part of the original template.

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:

Osm Software Catalog — Desktop Windows application. Supports sorting, filtering and comparison. Based on Software template entries.
OSM Apps Catalog — A WebApp. Supports filtering and comparison. Based on Software, Service item and Layer template entries. Enriched with data from the Taginfo Project list.

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}}
|status         = <!-- one of: active, unmaintained, broken, unfinished -->
|license        = <!-- GPL;BSD;MIT;free;proprietary -->
|price          = <!-- 20$;35€;gratis -->
|web            = <!-- https://www.example.org -->
|repo           = <!-- https://git.example.org -->
|logo           = <!-- xyz.png -->
|screenshot     = <!-- xyz.jpg -->
|description    = <!-- write your own description, don't just copy it from the website -->
|author         = <!-- who develops the software? -->
|platform       = <!-- web;win;linux;macos;iphone;android;cross-platform;wm;palm;j2me;j2se -->
|genre          = <!-- display;navi;logger;router;editor;renderer;converter;analyser -->
|languages      = <!-- DE;EN;MUL -->
|languagesurl   = <!-- optional URL -->
|coverage       = <!-- Worldwide or Continent, Country, Region, ... -->
|code           = <!-- C;C++;C#;Python;Java -->
|framework      = <!-- GTK+;mono;J2ME;OpenGL -->
|version        = <!-- 1.0 -->
|date           = <!-- 2010-12-24 -->

<!-- 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;... -->
}}

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.
Parameter		Description	Type	Status
Template language	`lang`	Language in which the template texts are displayed. Example en	Line	optional
Name	`name`	Official name, otherwise most common one Auto value `{{subst:PAGENAME}}`	Line	required
Status	`status`	Current status of the project. Suggested values `active` `unmaintained` `broken` `unfinished` Default active	Line	suggested
License	`license`	What free license or proprietary? Suggested values `GPL` `BSD` `MIT` `free` `proprietary` `AGPL` Example GPL	Line	optional
Price	`price`	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	Line	optional
Web address	`web`	no description Example https://www.example.org	URL	suggested
Source code	`repo` `git` `svn`	URL to view or download the source code (for example, a Git, Subversion, or CVS repository) Example https://git.example.org	URL	optional
Logo	`logo`	no description Example xyz.png	File	optional
Screenshot	`screenshot`	no description Example xyz.jpg	File	suggested
Description	`description`	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	String	suggested
Author	`author`	Name of the author or a link to their OSM-wiki user page	Line	suggested
Supported platforms	`platform`	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	Line	suggested
Genre	`genre`	Main category for this tool. Suggested values `display` `navi` `logger` `router` `editor` `renderer` `converter` `analyser`	Line	suggested
Languages	`languages`	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` `bat-smg` `bcl` `be` `be-x-old` `bg` `bh` `bi` `bm` `bn` `bo` `bpy` `br` `bs` `bug` `bxr` `ca` `cdo` `ce` `ceb` `ch` `cho` `chr` `chy` `closed-zh-tw` `co` `cr` `cs` `csb` `cu` `cv` `cy` `da` `de` `diq` `dsb` `dv` `dz` `ee` `el` `en` `eo` `es` `et` `eu` `ext` `fa` `ff` `fi` `fiu-vro` `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` `roa-rup` `ru` `rw` `sa` `sc` `scn` `sco` `sd` `se` `sg` `sh` `si` `simple` `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` `tokipona` `tpi` `tr` `ts` `tt` `tum` `tw` `ty` `tzm` `udm` `ug` `uk` `ur` `uz` `ve` `vec` `vi` `vls` `vo` `wa` `war` `wo` `xal` `xh` `xmf` `yi` `yo` `yue` `za` `zh` `zh-classical` `zh-hans` `zh-hant` `zh-min-nan` `zh-tw` `zh-yue` `zu` Example DE;EN;MUL	Line	optional
Languages URL	`languagesurl`	Link to the actual full list of languages supported, described on another page (e.g. a portal page for the software, or a repository).	URL	optional
Coverage	`coverage`	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	Line	optional
Code	`code`	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`	Line	optional
Framework	`framework`	List of frameworks used. Suggested values `GTK+` `mono` `J2ME` `OpenGL` Example GTK+;mono;J2ME;OpenGL	Line	optional
Version	`version`	Latest version Example 1.0	Line	optional
Release date	`date`	Latest release date Example 2010-12-24	Date	optional
Amazon Identification	`asin`	Amazon Standard Identification Number for the Amazon Appstore for Android Example XXXXXXXXXX	Line	optional
BlackBerry ID	`bbWorldID`	BlackBerry World application ID Example XXX	Line	deprecated
F-Droid ID	`fDroidID`	F-Droid application ID Example org.example	Line	optional
Firefox Marketplace ID	`firefoxMarketplaceID`	Mozilla Firefox Marketplace application ID	Line	deprecated
Google Play ID	`googlePlayID`	Google Play Store application ID Example org.example	Line	optional
Huawei AppGallery ID	`huaweiAppGalleryID`	Huawei AppGallery application ID Example CXXXXXXXXX	Line	optional
AppStore ID	`appleStoreID`	iTunes App Store application ID Example id12344556	Line	optional
Mac AppStore ID	`macAppStoreID`	Mac App Store application ID Example id12344556	Line	optional
Microsoft ID	`microsoftAppID`	Microsoft Store Windows application UUID Example XXXXXXXXXXXX	Line	optional
Obtainium Updater Link	`obtainiumLink`	Link to Obtainium updater information Example https://github.com/organicmaps/organicmaps/wiki/Installing-Organic-Maps-from-GitHub-using-Obtainium	Line	optional
Display map	`map`	[Map display] Can it show a map? Suggested values `yes` `no`	Line	optional
Map data	`mapData`	[Map display] Maps drawn using pre-calculated/rasterized images (raster) or "on the fly" (vector)? Suggested values `raster` `vector`	Line	optional
Source	`datasource`	[Map display] Can you store all map data offline? Download a separate file? Suggested values `online` `cache` `offline` Example online;cache	Line	optional
Rotate map	`rotateMap`	[Map display] Does it turn the map in driving/walking direction? Suggested values `yes` `no`	Line	optional
3D view	`3D`	[Map display] Is there some 3D or 2.5D view? Suggested values `yes` `no`	Line	optional
Shows website	`showWebsite`	[POI Information] Shows link to the website from POI Suggested values `yes` `no`	Line	optional
Shows phone number	`showPhoneNumber`	[POI Information] Shows phone number from POI Suggested values `yes` `no`	Line	optional
Shows operation hours	`showOpeningHours`	[POI Information] Shows hours of operation from POI Suggested values `yes` `no`	Line	optional
Routing	`routing`	[Routing] Can you calculate or otherwise plan a route? Suggested values `yes` `no`	Line	optional
Create route manually	`createRouteManually`	[Routing] Suggested values `yes` `no`	Line	optional
Calculate route	`calculateRoute`	[Routing] Can it calculate a route using routing? Suggested values `yes` `no`	Line	optional
Create route via Waypoints	`createRouteViaWaypoints`	[Routing] Able to calculate route via Waypoints Suggested values `yes` `no`	Line	optional
Routing profiles	`profiles`	[Routing] What profiles supported if it makes routing? Suggested values `car` `bike` `foot` `wheelchair` `public transport` Example car;bike;foot;wheelchair;public transport	Line	optional
Turn restrictions	`turnRestrictions`	[Routing] Can it deal with turn restrictions? Suggested values `yes` `no`	Line	optional
Calculate route without Internet (Offline routing)	`calculateRouteOffline`	[Routing] Does it need internet to calculate a route? Suggested values `yes` `no`	Line	optional
Routing providers	`routingProviders`	[Routing] What routing service(s) does it use? Suggested values `OpenRouteService` `Yours` `CloudMade` `MapQuest` `Graphhopper` `OSRM` `Valhalla` Example OpenRouteService;Yours	Line	optional
Avoid traffic	`avoidTraffic`	[Routing] Does app optimize route to avoid traffic jams? Suggested values `yes` `no`	Line	optional
Traffic Provider	`trafficProvider`	[Routing] Traffic data source provider.	Line	optional
Navigate	`navigating`	[Navigation] Can you navigate in a compass like way? Suggested values `yes` `no`	Line	optional
Find location	`findLocation`	[Navigation] Can it search for a street/place? Suggested values `yes` `no`	Line	optional
Find nearby POIs	`findNearbyPOI`	[Navigation] Can it discover/display Points of interests? Suggested values `yes` `no`	Line	optional
Navigate to point	`navToPoint`	[Navigation] Can it guide you to a point somewhere? Suggested values `yes` `no`	Line	optional
Navigation with voice / Voice guidance	`voice`	[Navigation] Can it give you commands with a computer voice? Suggested values `yes` `no`	Line	optional
Keep on road	`keepOnRoad`	[Navigation] Can it assist you to keep your vehicle on the calculated route? Suggested values `yes` `no`	Line	optional
Lane guidance	`turnLanes`	[Navigation] Does it support lane guidance? Suggested values `yes` `no`	Line	optional
Works without GPS	`withoutGPS`	[Navigation] Does it work even without a GPS? Suggested values `yes` `no`	Line	optional
Navigate along predefined route	`predefinedRoute`	[Navigation] Can it follow other GPS tracks? Suggested values `yes` `no`	Line	optional
Make track	`tracking`	[Track logging] Can it record a GPS track? Suggested values `yes` `no`	Line	optional
Customizable log interval	`customInterval`	[Track logging] Can you tune the interval manually? Suggested values `yes` `no`	Line	optional
Track formats	`trackFormats` `formats`	[Track logging] What formats for storage can you save your GPS track? Suggested values `gpx` `kml` `nmea` `csv` `trk` Example gpx;csv	Line	optional
Geotagging	`geotagging`	[Track logging] Are further mapping techniques supported Suggested values `note` `photo` `audio` Example note;photo	Line	optional
Fast POI buttons	`fastWayPointAdding`	[Track logging] Easy to add a new Waypoint? Suggested values `yes` `no`	Line	optional
Upload GPX to OSM	`uploadGPX`	[Track logging] Can it send tracks directly to OSM? Suggested values `yes` `no`	Line	optional
Monitoring	`monitoring`	[Track monitoring] Can you monitor GPS datas? Suggested values `yes` `no`	Line	optional
Show current track	`showTrack`	[Track monitoring] Show your current track? Suggested values `yes` `no`	Line	optional
Open existing track	`showExistingTrack`	[Track monitoring] Can it load existing tracks so you can follow them? Suggested values `yes` `no`	Line	optional
Altitude diagram	`showAltitudeDiagram`	[Track monitoring] Suggested values `yes` `no`	Line	optional
Show POD value	`showDOP`	[Track monitoring] Shows signal quality? Suggested values `yes` `no`	Line	optional
Satellite view	`showSatellites`	[Track monitoring] Displays satellites? Suggested values `yes` `no`	Line	optional
Show live NMEA data	`showNMEAlive`	[Track monitoring] Can you see the raw GPS stream? Suggested values `yes` `no`	Line	optional
Show speed	`showSpeed`	[Track monitoring] Suggested values `yes` `no`	Line	optional
Send current position	`sendPosition`	[Track monitoring] Can it send position to others? Suggested values `yes` `no` `sms` `mail` `www` Example yes;mail;www	Line	optional
Add POIs	`addPOI`	[Editor] Can you add a node? Suggested values `yes` `no`	Line	optional
Edit / Delete POIs	`editPOI`	[Editor] Can you edit a node? Suggested values `yes` `no`	Line	optional
Add way	`addWay`	[Editor] Can you add a way? Suggested values `yes` `no`	Line	optional
Edit geometries	`editGeom`	[Editor] Can you edit nodes/ways? Suggested values `yes` `no`	Line	optional
Edit arbitrary tags of existing OSM objects	`editTags`	[Editor] Can you edit existing tags? Suggested values `yes` `no`	Line	optional
Edit relations	`editRelations`	[Editor] Can you edit relations? Suggested values `yes` `no`	Line	optional
View notes	`viewNotes`	[Editor] Can you view OSM Notes? Suggested values `yes` `no`	Line	optional
Create notes	`createNotes`	[Editor] Can you add OSM Notes? Suggested values `yes` `no`	Line	optional
Edit notes	`editNotes`	[Editor] Can you comment/close OSM Notes? Suggested values `yes` `no`	Line	optional
Work offline	`editSource`	[Editor] Can you work offline? Suggested values `online` `cache` `offline` Example online;cache	Line	optional
Support imagery offset DB	`offsetDBsupport`	[Editor] Does it support the imagery offset DB? Suggested values `yes` `no`	Line	optional
Upload to OSM	`uploadOSMData`	[Editor] Can you send changes to OSM directly? Suggested values `yes` `no`	Line	optional
Renderer output formats	`rendererOutputFormats`	[Renderer] Supported output formats. Example svg;pdf;png	Line	optional
Accessibility support	`accessibility`	[Accessibility] Does it help disabled people in some kind? Suggested values `blind` `wheelchair` Example blind;wheelchair	Line	optional
Complete non graphics text output	`textOnlyUI`	[Accessibility] Text to braille compatible interface? Suggested values `yes` `no`	Line	optional
Braille interface	`brailleUI`	[Accessibility] A special braille interface? Suggested values `yes` `no`	Line	optional
Exploration modus	`explorerMode`	[Accessibility] Has a exploration modus (tell all objects approaching)? Suggested values `yes` `no`	Line	optional
Public Transport mode	`publicTransportMode`	[Accessibility] Supports routing with public transport? Suggested values `yes` `no`	Line	optional
Danger Warnings	`dangerWarnings`	[Accessibility] Suggested values `yes` `no`	Line	optional
Screenreader	`screenReader`	[Accessibility] List of supported screenreaders Example NVDA	Line	optional
Screenreader languages	`screenReaderLang`	[Accessibility] List of supported screenreaders languages Example EN;DE	Line	optional

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

find all software from wiki pages list, categories, renderer, editors, converter,... (Mark with Category:Software list)
make a Project of the week to check the lists

Template:Software/doc

Contents

Who also uses this data?

Usage

TemplateData

Genre values, not exhaustive

Todo

See also

Navigation menu

Template:Software/doc

Who also uses this data?

Usage

TemplateData

Genre values, not exhaustive

Todo

See also

Navigation menu

Search