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. The template was also used by User:TTTBot to extract data for the lists on 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           = xyz
|author         = 
|wiki           = xyz
|web            = http://www.xyz.org
|repo           = http://
|platform       = win;winxp;wm;linux;macos;iphone;android;palm;j2me;j2se
|code           = C;C++;C#;Python;Java
|framework      = GTK+;mono;J2ME;OpenGL;
|languages      = DE;EN;MUL
|languagesurl   = <!-- optional URL -->
|genre          = display;navi;logger;router;editor;renderer;converter;analyser
|license        = GPL;BSD;free;proprietary
|price          = 20$;35€;gratis
|version        = 1.0
|date           = 2010-12-24
|screenshot     = xyz.jpg
|description    = Easy to use, nice UI
|asin           = XXXXXXXXXX
|bbWorldID      = XXX
|googlePlayID   = org.xyz
|fDroidID       = org.xyz
|firefoxMarketplaceID = XXX
|appleStoreID   = id12344556
|macAppStoreID  = id12344556
|microsoftAppID = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX


|map        = yes
|tracking   = no
|monitoring = no
|navigating = no
|routing    = yes


|mapData    = raster;vector
|datasource = online;cache;offline
|rotateMap  = yes;no
|3D         = yes;no


|navToPoint              = yes;no
|findLocation            = yes;no
|findNearbyPOI           = yes;no
|predefinedRoute         = yes;no
|calculateRoute          = yes;no
|calculateRouteOffline   = yes;no
|createRouteViaWaypoints = yes;no
|profiles                = car;bike;foot;wheelchair
|turnRestrictions        = yes;no
|voice                   = yes;no
|keepOnRoad              = yes;no
|withoutGPS              = yes;no
|routingProviders        = OpenRouteService;Yours;CloudMade;MapQuest


|customInterval     = yes;no
|trackFormats       = gpx;kml;nmea;csv;trk;...
|geotagging         = note;photo;audio
|fastWayPointAdding = yes;no
|uploadGPX          = yes;no
|sendPosition       = yes;no;sms;mail;www


|showTrack           = yes;no
|showExistingTrack   = yes;no
|showAltitudeDiagram = yes;no
|showDOP             = yes;no
|showSatellites      = yes;no
|showNMEAlive        = yes;no


|accessibility       = blind;wheelchair
|textOnlyUI          = yes;no
|brailleUI           = yes;no
|explorerMode        = yes;no
|publicTransportMode = yes;no
|dangerWarnings      = yes;no
|screenReader        = NVDA;....
|screenReaderLang    = EN;DE;...


|addPOI          = yes;no
|addWay          = yes;
|editSource      = online;cache;offline
|editPOI         = yes;no
|editTags        = yes;no
|editGeom        = yes;no
|editRelations   = yes;no
|viewNotes       = yes;no
|editNotes       = yes;no
|offsetDBsupport = yes;no
|uploadOSMData   = yes;no


|rendererOutputFormats = svg;pdf;png;...


|showSpeed       = yes;no
|
}}

Parameters

General

|name = 
Display name
|author = 
Who started this project? Who maintains?
|wiki = 
Link back to the page in this wiki
|web = 
Web address
|repo = or |svn = 
URL to view or download the source code (for example, a Git, Subversion, or CVS repository)
|platform = 
list of platforms it runs on
|code = 
list of languages used
|framework = 
list of frameworks used
|languages = 
supported languages (list of valid language codes separated by commas or semicolons, which are then displayed using {{Languagename}}; use "mul" in the list for "multiple languages")
|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)
|genre = 
main category for this tool
|license = 
what free license or proprietary?
|price = 
Costs if proprietary. If price is empty, application is for free.
|version = 
latest version
|date = 
latest release date
|screenshot = 
a screenshot (remove line if none)
|description = 
brief description. What distinguishes this from other tools?
|asin = 
Amazon Standard Identification Number for the Amazon Appstore for Android
|bbWorldID = 
BlackBerry World application ID
|googlePlayID = 
Google Play Store application ID
|fDroidID = 
F-Droid application ID
|firefoxMarketplaceID = 
Mozilla Firefox Marketplace application ID
|appleStoreID = 
iTunes App Store application ID
|macAppStoreID = 
Mac App Store application ID
|microsoftAppID = 
Microsoft Store Windows application UUID

Features

|map = 
Can it show a map?
|tracking = 
Can it record a GPS track?
|monitoring = 
Can you monitor GPS datas?
|navigating = 
Can you navigate in a compass like way?
|routing = 
Can you route along a road network?

Map display

|mapData = 
Maps drawn using pre-calculated/rasterized images or "on the fly"?
|datasource = 
Can you store all map data offline? Download a separate file?
|rotateMap = 
Does it turn the map in driving direction?
|3D = 
Is there some 3D or 2.5D view?

Navigation

|navToPoint = 
Can it guide you to a point somewhere?
|findLocation = 
Can it search for a street/place?
|findNearbyPOI = 
Can it discover/display Points of interests?
|predefinedRoute = 
Can it follow other GPS tracks?
|calculateRoute = 
Can it calculate a route using routing?
|calculateRouteOffline = 
Does it need internet to calculate a route?
|profiles = 
What profiles supported if it makes routing?
|turnRestrictions = 
Can it deal with turn restrictions
|voice = 
Can it give you commands with a computer voice?
|keepOnRoad = 
Can it assist you to keep your vehicle on the calculated route?
|withoutGPS = 
Does it work even without a GPS?
|routingProviders = 
What routing service(s) does it use?

Track logging

|customInterval = 
Can you tune the interval manually?
|trackFormats = 
What formats for storage can you save your GPS track?
|geotagging = 
Are further Mapping Techniques supported
|fastWayPointAdding = 
Easy to add a new Waypoint?
|uploadGPX = 
Can it send tracks directly to OSM?
|sendPosition = 
Can it send position to others?

Track monitoring

|showTrack = 
Show your current track?
|showExistingTrack = 
Can it load existing tracks so you can follow them?
|showAltitudeDiagram = 
 ?
|showDOP = 
Shows signal quality?
|showSatellites = 
Displays satellites?
|showNMEAlive = 
Can you see the raw GPS stream?

Accessibility

|accessibility = 
Does it help disabled people in some kind?
|textOnlyUI = 
Text so braille compatible interface?
|brailleUI = 
A special braille interface?
|explorerMode = 
 ? nobody knows...
|publicTransportMode = 
Supports routing with public transport?
|dangerWarnings = 
 ?
|screenReader = 
List of supported Screenreaders
|screenReaderLang = 
And their languages

Editor

|addPOI = 
Can you add a node?
|addWay = 
Can you add a way?
|editSource = 
Can you work offline?
|editPOI = 
Can you edit a node?
|editTags = 
Can you edit existing tags?
|editGeom = 
Can you edit nodes/ways?
|editRelations = 
Can you edit relations?
|viewNotes = 
Can you view OSM Notes?
|editNotes = 
Can you add/comment OSM Notes?
|offsetDBsupport = 
Does it support the imagery offset DB?
|uploadOSMData = 
Can you send changes to OSM directly?

Renderer

|rendererOutputFormats = 
supported output formats

Analysis

|showSpeed = 
 ?

Todo

  • find all software from wiki pages list, categories, renderer, editors, converter,...
  • make a Project of the week to check the lists

TemplateData

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

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Langlang

no description

Unknownoptional
Namename

Display name

Example
xyz
Unknownrequired
Authorauthor

Who started this project? Who maintains?

Unknownsuggested
Wikiwiki

Link back to the page in this wiki

Example
xyz
Unknownsuggested
Webweb

Web address

Example
http://www.xyz.org
Unknownsuggested
Reporepo git svn

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

Unknownoptional
Platformplatform

list of platforms it runs on

Example
win;winxp;wm;linux;macos;iphone;android;palm;j2me;j2se
Unknownsuggested
Codecode

list of languages used

Example
C;C++;C#;Python;Java
Unknownoptional
Frameworkframework

list of frameworks used

Example
GTK+;mono;J2ME;OpenGL
Unknownoptional
Languageslanguages

supported languages (list of valid language codes separated by commas or semicolons, which are then displayed using {{Languagename}}; use "mul" in the list for "multiple languages")

Example
DE;EN;MUL
Unknownoptional
Languagesurllanguagesurl

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

Unknownoptional
Genregenre

main category for this tool

Example
display;navi;logger;router;editor;renderer;converter;analyser
Unknownsuggested
Licenselicense

what free license or proprietary?

Example
GPL;BSD;free;proprietary
Unknownoptional
Priceprice

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

Example
20$;35€;gratis
Unknownoptional
Versionversion

latest version

Example
1.0
Unknownoptional
Datedate

latest release date

Example
1.0
Unknownoptional
Screenshotscreenshot

a screenshot

Example
xyz.jpg
Unknownoptional
Descriptiondescription

brief description. What distinguishes this from other tools?

Example
Easy to use, nice UI
Unknownoptional
Asinasin

Amazon Standard Identification Number for the Amazon Appstore for Android

Unknownoptional
BbWorldIDbbWorldID

BlackBerry World application ID

Unknownoptional
GooglePlayIDgooglePlayID

Google Play Store application ID

Unknownoptional
FDroidIDfDroidID

F-Droid application ID

Unknownoptional
FirefoxMarketplaceIDfirefoxMarketplaceID

Mozilla Firefox Marketplace application ID

Unknownoptional
AppleStoreIDappleStoreID

iTunes App Store application ID

Unknownoptional
MacAppStoreIDmacAppStoreID

Mac App Store application ID

Unknownoptional
MicrosoftAppIDmicrosoftAppID

Microsoft Store Windows application UUID

Unknownoptional
MapDatamapData

Map display: Maps drawn using pre-calculated/rasterized images or "on the fly"?

Example
raster;vector
Unknownoptional
Datasourcedatasource

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

Example
online;cache;offline
Unknownoptional
RotateMaprotateMap

Map display: Does it turn the map in driving direction?

Unknownoptional
3D3D

Map display: Is there some 3D or 2.5D view?

Unknownoptional
NavToPointnavToPoint

Navigation: Can it guide you to a point somewhere?

Unknownoptional
FindLocationfindLocation

Navigation: Can it search for a street/place?

Unknownoptional
FindNearbyPOIfindNearbyPOI

Navigation: Can it discover/display Points of interests?

Unknownoptional
PredefinedRoutepredefinedRoute

Navigation: Can it follow other GPS tracks?

Unknownoptional
CalculateRoutecalculateRoute

Navigation: Can it calculate a route using routing?

Unknownoptional
CalculateRouteOfflinecalculateRouteOffline

Navigation: Does it need internet to calculate a route?

Unknownoptional
Profilesprofiles

Navigation: What profiles supported if it makes routing?

Example
car;bike;foot;wheelchair
Unknownoptional
TurnRestrictionsturnRestrictions

Navigation: Can it deal with turn restrictions

Unknownoptional
Voicevoice

Navigation: Can it give you commands with a computer voice?

Unknownoptional
KeepOnRoadkeepOnRoad

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

Unknownoptional
WithoutGPSwithoutGPS

Navigation: Does it work even without a GPS?

Unknownoptional
RoutingProvidersroutingProviders

Navigation: What routing service(s) does it use?

Example
OpenRouteService;Yours;CloudMade;MapQuest
Unknownoptional
CustomIntervalcustomInterval

Track logging: Can you tune the interval manually?

Unknownoptional
TrackFormatstrackFormats

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

Example
gpx;kml;nmea;csv;trk
Unknownoptional
Geotagginggeotagging

Track logging: Are further Mapping Techniques supported

Example
note;photo;audio
Unknownoptional
FastWayPointAddingfastWayPointAdding

Track logging: Easy to add a new Waypoint?

Unknownoptional
UploadGPXuploadGPX

Track logging: Can it send tracks directly to OSM?

Unknownoptional
SendPositionsendPosition

Track logging: Can it send position to others?

Example
yes;no;sms;mail;www
Unknownoptional
ShowTrackshowTrack

Track monitoring: Show your current track?

Unknownoptional
ShowExistingTrackshowExistingTrack

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

Unknownoptional
ShowAltitudeDiagramshowAltitudeDiagram

Track monitoring: ?

Unknownoptional
ShowDOPshowDOP

Track monitoring: Shows signal quality?

Unknownoptional
ShowSatellitesshowSatellites

Track monitoring: Displays satellites?

Unknownoptional
ShowNMEAliveshowNMEAlive

Track monitoring: Can you see the raw GPS stream?

Unknownoptional
Accessibilityaccessibility

Accessibility: Does it help disabled people in some kind?

Example
blind;wheelchair
Unknownoptional
TextOnlyUItextOnlyUI

Accessibility: Text so braille compatible interface?

Unknownoptional
BrailleUIbrailleUI

Accessibility: A special braille interface?

Unknownoptional
ExplorerModeexplorerMode

Accessibility: ? nobody knows...

Unknownoptional
PublicTransportModepublicTransportMode

Accessibility: Supports routing with public transport?

Unknownoptional
DangerWarningsdangerWarnings

Accessibility: ?

Unknownoptional
ScreenReaderscreenReader

Accessibility: List of supported Screenreaders

Example
NVDA
Unknownoptional
ScreenReaderLangscreenReaderLang

Accessibility: And their languages

Example
EN;DE
Unknownoptional
AddPOIaddPOI

Editor: Can you add a node?

Unknownoptional
AddWayaddWay

Editor: Can you add a way?

Unknownoptional
EditSourceeditSource

Editor: Can you work offline?

Example
online;cache;offline
Unknownoptional
EditPOIeditPOI

Editor: Can you edit a node?

Unknownoptional
EditTagseditTags

Editor: Can you edit existing tags?

Unknownoptional
EditGeomeditGeom

Editor: Can you edit nodes/ways?

Unknownoptional
EditRelationseditRelations

Editor: Can you edit relations?

Unknownoptional
ViewNotesviewNotes

Editor: Can you view OSM Notes?

Unknownoptional
EditNoteseditNotes

Editor: Can you add/comment OSM Notes?

Unknownoptional
OffsetDBsupportoffsetDBsupport

Editor: Does it support the imagery offset DB?

Unknownoptional
UploadOSMDatauploadOSMData

Editor: Can you send changes to OSM directly?

Unknownoptional
RendererOutputFormatsrendererOutputFormats

Renderer: supported output formats

Example
svg;pdf;png
Unknownoptional
ShowSpeedshowSpeed

Analysis: ?

Unknownoptional

See also