NL:Taginfo/Projects

From OpenStreetMap Wiki
Jump to: navigation, search

Er zijn veel projecten die op de een of andere manier tags van OSM gebruiken: bewerkers, routers, kaarten, programma's voor het uitnemen van gegevens, ... Taginfo kan informatie uit deze prjecten verkrijgen over hun gebruik van tags van OSM met behulp van 'project files'. De database van Taginfo bevat de informatie over welke projecten welke sleutels en tags gebruiken (optioneel met beschrijvingen en/of links naar de documentatie van het project). Deze informatie wordt dan door Taginfo weergegeven op elke pagina van de sleutel/tag op de tab 'Projects' (Voorbeelden: lijst van projecten, Projecten die de sleutel 'highway' gebruiken).

Projectbestanden

Projectbestanden zijn beschrijvingen die door de projecten zijn verschaft over hun gebruik van de tags van OSM. Projectbestanden gebruiken de populaire bestandsindeling JSON. Zijn bevatten enige metagegevens naast het project zelf en dan een lijst van alle sleutels en waarden die door het project worden gebruikt en beschrijvingen over hoe zij worden gebruikt.

Hier staat hoe een dergelijk bestand van JSON er uit ziet:

   {
       "data_format": 1,           # versie indeling gegevens, momenteel altijd 1, zal worden bijgewerkt indien er 
                                   # niet verenigbare wijzigingen in de indeling optreden (vereist)
       "data_url": "...",          # dit zou de URL moeten zijn waaronder dit projectbestand kan worden benaderd (optioneel)
       "data_updated": "yyyymmddThhmmssZ", # tijdstempel van wanneer het projectbestand werd bijgewerkt (optioneel, 
                                           # gebruikt HTTP header-datum indien niet beschikbaar)
       "project": {                # meta-informatie over het project (vereist)
           "name": "...",          # naam van het project (vereist)
           "description": "...",   # korte beschrijving van het project (vereist)
           "project_url": "...",   # thuispagina van het project met algemene informatie (vereist)
           "doc_url": "...",       # documentatie van het project en in het bijzonder de gebruikte tags (optioneel)
           "icon_url": "...",      # projectlogo, zou moeten werken in 16x16 pixels op witte
                                   # en lichtgrijze achtergronden (optioneel)
           "contact_name": "...",  # contactnaam, nodig voor de beheerder van Taginfo (vereist)
           "contact_email": "..."  # contacte-mail, nodig voor de beheerder van Taginfo (vereist)
       },
       "tags": [...]               # lijst van gebruikte keys en tags (zie hieronder)
   }

Elk van de "tags" ziet er zo uit:

   {
       "key": "...",          # key van tag van OSM (vereist)
       "value": "...",        # waarde van tag van OSM (optioneel, indien niet opgegeven betekent dit "alle waarden")
       "object_types": [...], # OSM objecttypen waarvoor deze key/tag mag worden gebruikt (optioneel, zie hieronder)
       "description": "...",  # hoe de key/tag wordt gebruikt in dit project (optioneel)
       "doc_url": "...",      # link naar verdere documentatie van het project over deze specifieke key/tag (optioneel)
       "icon_url": "..."      # URL van een pictogram, zou moeten werken in 16x16 pixels op witte 
                              # en lichtgrijze achtergronden (optioneel)
   }

De 'object_types' is een array van één of meer van de volgende woorden: "node", "way", "relation", en "area". Als er geen array van 'object_types' is, zijn alle typen toegestaan. U mag meerdere items in de tagslijst hebben met dezelfde combinatie van key/value met verschillende object_types.

De 'description' zou moeten weergeven hoe de key/tag wordt gebruikt in de context van het project, het zou GEEN algemene beschrijving van de key/tag moeten zijn, tenzij de key/tag specifiek is voor alleen dit project.

Integratie met Taginfo

Projecten moeten hun eigen projectbestanden maken (gewoonlijk genaamd taginfo.json), ergens op het web. Meestal zullen ze in hun Git of andere opslagplaats staan, maar het mag overal op het web zijn. De URL van het projectbestand moet dan worden doorgegeven aan Taginfo. Als u een account voor Github heeft, lees dan https://github.com/taginfo/taginfo-projects/blob/master/CONTRIBUTING.md, voeg de URL toe aan https://github.com/taginfo/taginfo-projects/blob/master/project_list.txt en verstuur een Pull request. Indien u gene account voor Github heeft, e-mail dan de URL naar jochen@remote.org.

Taginfo zal periodiek het projectbestand ophalen en de informatie erin toevoegen aan zijn eigen database.

Geen project is te klein of te groot of niet interessant genoeg. We willen absoluut het project van iedereen in de database. Overweeg om uw project ook toe te voegen!