Cs:Key:comment
comment |
Popis |
---|
Popis sady změn určený hlavně pro ostatní mappery. |
Skupina: Sada změn |
Použité na těchto prvcích |
Viz též |
|
Status: de facto |
Nástroje |
Značka comment=* se používá pro komentář sad změn (changeset) a byla zavedena spolu s API v0.6. Obsahuje informaci o tom, jaké změny byly provedeny a hlavně proč. Například v případě přesunu uzlu highway=bus_stop může být komentář sady změn buď "přesunuta zastávka po přestavbě ulice", nebo "přesunuta zastávka, byla na špatném místě". Takovýto text pak může ostatním sdělit, proč byla daná změna provedena.
Tato značka se nepřidává k žádnému uzlu, cestě, ploše ani relaci. Jde o systémovou značku, se kterou se běžný uživatel setká pouze v popisech sad změn. Uživatel ji vyplňuje zpravidla na výzvu mapovacího software při ukládání sady změn.
Značka comment=* je zobrazena na různých místech na webu OSM, zejména na záložce Historie a dalších místech, které mají co do činění se sadami změn. Komentář k sadě změn není povinný. Je to zpráva vašim kolegům o tom, co jste udělali a proč. Smysluplný komentář je tedy znakem ohleduplnosti k ostatním.
Pokud si neuděláte čas na přidání této zprávy, nebo přidáte-li nesmyslný obsah, pak je to některými považováno za nezdvořilé. Na druhou stranu mnoho komentářů není nikdy přečteno a někteří je považují za ztrátu času, protože není jisté, zda si je vůbec někdo někdy přečte a radši čas věnují vylepšování mapy. Doporučený způsob využívání komentářů je v angličtině zde.
Rozdíl mezi poznámkou (note) a komentářem (comment) je v tom, že poznámka se obecně přidává k uzlům/cestám/relacím, kde popisuje věci z reálného světa, jako například "zastávka tu skutečně je, i když její značení bylo ztrženo v září 2009", zatímco komentář se používá na sady změn (changeset).
Viz také
- note=* - poznámka pro sebe nebo další mappery.
- description=* - pro připojení textu, který může být zobrazen koncovému uživateli mapy.
- fixme=* - pro označení místa, které je potřeba dále upravit
Pro vývojáře
Obzvláště s přihlédnutím k sadám změn:
- Značka comment by neměla být generována automaticky. Pokud projekt zpracovávající data potřebuje automatizovaná data, pak si je má vytvořit sám.
- Značka comment není povinná - např. pracovní postup editoru není vhodný pro přidávání komentářů (např. živý režim editoru Potlatch (v1.x)). Na druhou stranu smysluplný komentář je velmi užitečný, takže by bylo dobře, aby váš editor nabízel uživateli snadnou cestu, jak komentář přidat. Pokud váš software komentář vyžaduje povinně, může se stát, že někteří mappeři budou reagovat negativně a zadávat nesmyslné komentáře.
- Značka comment by měla být dostupná v editoru, aby ji uživatel mohl použít.