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}} | 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:
- Module:Software
- Template:Software/feature
- Template:Software/languages – allows to add more than one programming language
- Template:Software/language – names of programming languages, their synonyms and categories
- Template:Software/licenses – allows to add more than one license
- Template:Software/license – names of licenses, their synonyms and categories
- Template:Software/platforms – allows to add more than one platform
- Template:Software/platform – names of platforms and operating systems, their synonyms and categories
- Template:Software/status – adds status of software
- Template:Software/uilanguages – allows to add more than one UI language
- Category:Translation string templates – some of the strings from the pages from this category are used to display localized strings
- Template:TranslationOf author
- Template:TranslationOf free of charge
- Template:TranslationOf install
- Template:TranslationOf language
- Template:TranslationOf license
- Template:TranslationOf platform
- Template:TranslationOf programming language
- Template:TranslationOf Project status
- Template:TranslationOf source code
- Template:TranslationOf version
- Template:TranslationOf website
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template language | lang | Language in which the template texts are displayed.
| Line | optional |
Name | name | Official name, otherwise most common one
| Line | required |
Status | status | Current status of the project.
| Line | suggested |
License | license | What free license or proprietary?
| Line | optional |
Price | price | Costs if proprietary. If price is empty, application is for free.
| Line | optional |
Web address | web | no description
| URL | suggested |
Source code | repo git svn | URL to view or download the source code (for example, a Git, Subversion, or CVS repository)
| URL | optional |
Logo | logo | no description
| File | optional |
Screenshot | screenshot | no description
| File | suggested |
Description | description | Brief description. What distinguishes this from other tools? (Write your own description, don't just copy it from the website)
| 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.
| Line | suggested |
Genre | genre | Main category for this tool.
| Line | suggested |
Languages | languages | Supported languages (list of valid language codes separated by semicolons) or number of languages supported
| 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.
| Line | optional |
Code | code | List of programming languages used.
| Line | optional |
Framework | framework | List of frameworks used.
| Line | optional |
Version | version | Latest version
| Line | optional |
Release date | date | Latest release date
| Date | optional |
Amazon Identification | asin | Amazon Standard Identification Number for the Amazon Appstore for Android
| Line | optional |
BlackBerry ID | bbWorldID | BlackBerry World application ID
| Line | deprecated |
F-Droid ID | fDroidID | F-Droid application ID
| Line | optional |
Firefox Marketplace ID | firefoxMarketplaceID | Mozilla Firefox Marketplace application ID | Line | deprecated |
Google Play ID | googlePlayID | Google Play Store application ID
| Line | optional |
Huawei AppGallery ID | huaweiAppGalleryID | Huawei AppGallery application ID
| Line | optional |
AppStore ID | appleStoreID | iTunes App Store application ID
| Line | optional |
Mac AppStore ID | macAppStoreID | Mac App Store application ID
| Line | optional |
Microsoft ID | microsoftAppID | Microsoft Store Windows application UUID
| Line | optional |
Obtainium Updater Link | obtainiumLink | Link to Obtainium updater information
| Line | optional |
Display map | map | [Map display] Can it show a map?
| Line | optional |
Map data | mapData | [Map display] Maps drawn using pre-calculated/rasterized images (raster) or "on the fly" (vector)?
| Line | optional |
Source | datasource | [Map display] Can you store all map data offline? Download a separate file?
| Line | optional |
Rotate map | rotateMap | [Map display] Does it turn the map in driving/walking direction?
| Line | optional |
3D view | 3D | [Map display] Is there some 3D or 2.5D view?
| Line | optional |
Shows website | showWebsite | [POI Information] Shows link to the website from POI
| Line | optional |
Shows phone number | showPhoneNumber | [POI Information] Shows phone number from POI
| Line | optional |
Shows operation hours | showOpeningHours | [POI Information] Shows hours of operation from POI
| Line | optional |
Routing | routing | [Routing] Can you calculate or otherwise plan a route?
| Line | optional |
Create route manually | createRouteManually | [Routing]
| Line | optional |
Calculate route | calculateRoute | [Routing] Can it calculate a route using routing?
| Line | optional |
Create route via Waypoints | createRouteViaWaypoints | [Routing] Able to calculate route via Waypoints
| Line | optional |
Routing profiles | profiles | [Routing] What profiles supported if it makes routing?
| Line | optional |
Turn restrictions | turnRestrictions | [Routing] Can it deal with turn restrictions?
| Line | optional |
Calculate route without Internet (Offline routing) | calculateRouteOffline | [Routing] Does it need internet to calculate a route?
| Line | optional |
Routing providers | routingProviders | [Routing] What routing service(s) does it use?
| Line | optional |
Avoid traffic | avoidTraffic | [Routing] Does app optimize route to avoid traffic jams?
| Line | optional |
Traffic Provider | trafficProvider | [Routing] Traffic data source provider. | Line | optional |
Navigate | navigating | [Navigation] Can you navigate in a compass like way?
| Line | optional |
Find location | findLocation | [Navigation] Can it search for a street/place?
| Line | optional |
Find nearby POIs | findNearbyPOI | [Navigation] Can it discover/display Points of interests?
| Line | optional |
Navigate to point | navToPoint | [Navigation] Can it guide you to a point somewhere?
| Line | optional |
Navigation with voice / Voice guidance | voice | [Navigation] Can it give you commands with a computer voice?
| Line | optional |
Keep on road | keepOnRoad | [Navigation] Can it assist you to keep your vehicle on the calculated route?
| Line | optional |
Lane guidance | turnLanes | [Navigation] Does it support lane guidance?
| Line | optional |
Works without GPS | withoutGPS | [Navigation] Does it work even without a GPS?
| Line | optional |
Navigate along predefined route | predefinedRoute | [Navigation] Can it follow other GPS tracks?
| Line | optional |
Make track | tracking | [Track logging] Can it record a GPS track?
| Line | optional |
Customizable log interval | customInterval | [Track logging] Can you tune the interval manually?
| Line | optional |
Track formats | trackFormats formats | [Track logging] What formats for storage can you save your GPS track?
| Line | optional |
Geotagging | geotagging | [Track logging] Are further mapping techniques supported
| Line | optional |
Fast POI buttons | fastWayPointAdding | [Track logging] Easy to add a new Waypoint?
| Line | optional |
Upload GPX to OSM | uploadGPX | [Track logging] Can it send tracks directly to OSM?
| Line | optional |
Monitoring | monitoring | [Track monitoring] Can you monitor GPS datas?
| Line | optional |
Show current track | showTrack | [Track monitoring] Show your current track?
| Line | optional |
Open existing track | showExistingTrack | [Track monitoring] Can it load existing tracks so you can follow them?
| Line | optional |
Altitude diagram | showAltitudeDiagram | [Track monitoring]
| Line | optional |
Show POD value | showDOP | [Track monitoring] Shows signal quality?
| Line | optional |
Satellite view | showSatellites | [Track monitoring] Displays satellites?
| Line | optional |
Show live NMEA data | showNMEAlive | [Track monitoring] Can you see the raw GPS stream?
| Line | optional |
Show speed | showSpeed | [Track monitoring]
| Line | optional |
Send current position | sendPosition | [Track monitoring] Can it send position to others?
| Line | optional |
Add POIs | addPOI | [Editor] Can you add a node?
| Line | optional |
Edit / Delete POIs | editPOI | [Editor] Can you edit a node?
| Line | optional |
Add way | addWay | [Editor] Can you add a way?
| Line | optional |
Edit geometries | editGeom | [Editor] Can you edit nodes/ways?
| Line | optional |
Edit arbitrary tags of existing OSM objects | editTags | [Editor] Can you edit existing tags?
| Line | optional |
Edit relations | editRelations | [Editor] Can you edit relations?
| Line | optional |
View notes | viewNotes | [Editor] Can you view OSM Notes?
| Line | optional |
Create notes | createNotes | [Editor] Can you add OSM Notes?
| Line | optional |
Edit notes | editNotes | [Editor] Can you comment/close OSM Notes?
| Line | optional |
Work offline | editSource | [Editor] Can you work offline?
| Line | optional |
Support imagery offset DB | offsetDBsupport | [Editor] Does it support the imagery offset DB?
| Line | optional |
Upload to OSM | uploadOSMData | [Editor] Can you send changes to OSM directly?
| Line | optional |
Renderer output formats | rendererOutputFormats | [Renderer] Supported output formats.
| Line | optional |
Accessibility support | accessibility | [Accessibility] Does it help disabled people in some kind?
| Line | optional |
Complete non graphics text output | textOnlyUI | [Accessibility] Text to braille compatible interface?
| Line | optional |
Braille interface | brailleUI | [Accessibility] A special braille interface?
| Line | optional |
Exploration modus | explorerMode | [Accessibility] Has a exploration modus (tell all objects approaching)?
| Line | optional |
Public Transport mode | publicTransportMode | [Accessibility] Supports routing with public transport?
| Line | optional |
Danger Warnings | dangerWarnings | [Accessibility]
| Line | optional |
Screenreader | screenReader | [Accessibility] List of supported screenreaders
| Line | optional |
Screenreader languages | screenReaderLang | [Accessibility] List of supported screenreaders languages
| 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
See also
- {{Communication channels}} – Template for linking official communication channels of a project.
- Subtemplates:
- Translations of heading labels: author, website, source code, version, install, licence, gratis (free of charge), platform(s), programming language(s), (human) language(s)
- Template:List for formatting the enumerated lists below
- Enumeration of platforms, and naming/classification for each enumerated platform
- Enumeration of programming languages, and naming/classification for each enumerated programming language
- Enumeration of licenses, and naming/classification for each enumerated license
- Enumeration of (human) languages supported by the user interface of applications
- Talk:Software/Mobile phones#Cleanup Request - initial discussion that lead to this template's creation