From 4038c8200e366166a4e441ef79651521030cda2b Mon Sep 17 00:00:00 2001 From: Thomas Hervey Date: Sun, 22 Jul 2018 00:05:15 -0400 Subject: [PATCH 1/2] added note section to help docs --- data/core.yaml | 9 +++++++++ dist/locales/en.json | 10 ++++++++++ modules/ui/help.js | 13 +++++++++++++ 3 files changed, 32 insertions(+) diff --git a/data/core.yaml b/data/core.yaml index b317df32a..348dfaa0f 100644 --- a/data/core.yaml +++ b/data/core.yaml @@ -762,6 +762,15 @@ en: boundary_h: "Boundaries" boundary: "A *boundary* relation is a group of one or more line features that together form an administrative boundary." boundary_add: "To add a feature to a boundary relation, select the feature and scroll down to the \"All relations\" section of the feature editor, then click the {plus} add button to add this feature to a nearby existing relation or a new relation." + notes: + title: Notes + intro: "*Notes* are used to alert other users that a feature requires fixing or attention. Notes mark a specific location on the map. To view existing notes or add new ones, click the {data} **Map data** panel or press the shortcut key `` to enable the notes layer." + add_note_h: "Adding Notes" + add_note: "To add a new note, click the {note} **Note** button on the toolbar above the map, or press the shortcut key `4`. This will change the mouse cursor to a cross symbol. To place the new note on the map, position the mouse cursor where the note should go, then {leftclick} left-click or press `Space`." + move_note: "Only new notes can be moved. To move a note, place the mouse cursor over the new note, then press and hold the {leftclick} left mouse button while dragging the note to its new location. Once acceptable, give the note a description and click `Add Note`." + update_note_h: "Closing, Reopening, and Commenting" + update_note: "An existing note can be updated by closing it, reopening it, or commenting on it. Closing a note indicates that the problem has been resolved. Reopening a note indicates that the original or a previous issue is not resolved, or that there is a new issue. A comment on a note is for discussion." + update_note_command: "To update a note, {leftclick} left-click on the note to select it and show the edit menu, then update as needed." imagery: title: Background Imagery intro: "The background imagery that appears beneath the map data is an important resource for mapping. This imagery can be aerial photos collected from satellites, airplanes, and drones, or it can be scanned historical maps or other freely available source data." diff --git a/dist/locales/en.json b/dist/locales/en.json index 8781f6338..24f1863f3 100644 --- a/dist/locales/en.json +++ b/dist/locales/en.json @@ -905,6 +905,16 @@ "boundary": "A *boundary* relation is a group of one or more line features that together form an administrative boundary.", "boundary_add": "To add a feature to a boundary relation, select the feature and scroll down to the \"All relations\" section of the feature editor, then click the {plus} add button to add this feature to a nearby existing relation or a new relation." }, + "notes": { + "title": "Notes", + "intro": "*Notes* are used to alert other users that a feature requires fixing or attention. Notes mark a specific location on the map. To view existing notes or add new ones, click the {data} **Map data** panel or press the shortcut key `` to enable the notes layer.", + "add_note_h": "Adding Notes", + "add_note": "To add a new note, click the {note} **Note** button on the toolbar above the map, or press the shortcut key `4`. This will change the mouse cursor to a cross symbol. To place the new note on the map, position the mouse cursor where the note should go, then {leftclick} left-click or press `Space`.", + "move_note": "Only new notes can be moved. To move a note, place the mouse cursor over the new note, then press and hold the {leftclick} left mouse button while dragging the note to its new location. Once acceptable, give the note a description and click `Add Note`.", + "update_note_h": "Closing, Reopening, and Commenting", + "update_note": "An existing note can be updated by closing it, reopening it, or commenting on it. Closing a note indicates that the problem has been resolved. Reopening a note indicates that the original or a previous issue is not resolved, or that there is a new issue. A comment on a note is for discussion.", + "update_note_command": "To update a note, {leftclick} left-click on the note to select it and show the edit menu, then update as needed." + }, "imagery": { "title": "Background Imagery", "intro": "The background imagery that appears beneath the map data is an important resource for mapping. This imagery can be aerial photos collected from satellites, airplanes, and drones, or it can be scanned historical maps or other freely available source data.", diff --git a/modules/ui/help.js b/modules/ui/help.js index 5b5c71993..a5901b2a9 100644 --- a/modules/ui/help.js +++ b/modules/ui/help.js @@ -147,6 +147,16 @@ export function uiHelp(context) { 'boundary', 'boundary_add' ]], + ['notes', [ + 'intro', + 'add_note_h', + 'add_note', + 'move_note', + 'update_note_h', + 'update_note', + 'update_note_command' + ]], + ['imagery', [ 'intro', 'sources_h', @@ -210,6 +220,8 @@ export function uiHelp(context) { 'help.relations.turn_restriction_h': 3, 'help.relations.route_h': 3, 'help.relations.boundary_h': 3, + 'help.notes.add_note_h': 3, + 'help.notes.update_note_h': 3, 'help.imagery.sources_h': 3, 'help.imagery.offsets_h': 3, 'help.streetlevel.using_h': 3, @@ -220,6 +232,7 @@ export function uiHelp(context) { point: icon('#iD-icon-point', 'pre-text'), line: icon('#iD-icon-line', 'pre-text'), area: icon('#iD-icon-area', 'pre-text'), + note: icon('#iD-icon-note', 'pre-text'), plus: icon('#iD-icon-plus', 'pre-text'), minus: icon('#iD-icon-minus', 'pre-text'), orthogonalize: icon('#iD-operation-orthogonalize', 'pre-text'), From 27922e81b8f16bc12ef3f0fb391215ff836ae950 Mon Sep 17 00:00:00 2001 From: Thomas Hervey Date: Sun, 22 Jul 2018 00:16:17 -0400 Subject: [PATCH 2/2] updated shortcut menu --- data/core.yaml | 5 +++-- data/shortcuts.json | 5 +++++ dist/locales/en.json | 5 +++-- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/data/core.yaml b/data/core.yaml index 348dfaa0f..ceff1d969 100644 --- a/data/core.yaml +++ b/data/core.yaml @@ -770,7 +770,7 @@ en: move_note: "Only new notes can be moved. To move a note, place the mouse cursor over the new note, then press and hold the {leftclick} left mouse button while dragging the note to its new location. Once acceptable, give the note a description and click `Add Note`." update_note_h: "Closing, Reopening, and Commenting" update_note: "An existing note can be updated by closing it, reopening it, or commenting on it. Closing a note indicates that the problem has been resolved. Reopening a note indicates that the original or a previous issue is not resolved, or that there is a new issue. A comment on a note is for discussion." - update_note_command: "To update a note, {leftclick} left-click on the note to select it and show the edit menu, then update as needed." + update_note_command: "To update a note, {leftclick} left-click on the note to select it and show the edit menu, then update as needed. Notes are not features and updates must be saved individually." imagery: title: Background Imagery intro: "The background imagery that appears beneath the map data is an important resource for mapping. This imagery can be aerial photos collected from satellites, airplanes, and drones, or it can be scanned historical maps or other freely available source data." @@ -1135,7 +1135,8 @@ en: add_point: "'Add point' mode" add_line: "'Add line' mode" add_area: "'Add area' mode" - place_point: "Place a point" + add_note: "'Add note' mode" + place_point: "Place a point or note" disable_snap: "Hold to disable point snapping" stop_line: "Finish drawing a line or area" operations: diff --git a/data/shortcuts.json b/data/shortcuts.json index ee0c9cdc9..ff4fd800d 100644 --- a/data/shortcuts.json +++ b/data/shortcuts.json @@ -171,6 +171,11 @@ ], "text": "shortcuts.editing.drawing.add_area" }, + { + "shortcuts": ["4" + ], + "text": "shortcuts.editing.drawing.add_note" + }, { "shortcuts": ["Left-click","shortcuts.key.space" ], diff --git a/dist/locales/en.json b/dist/locales/en.json index 24f1863f3..8a0708fd7 100644 --- a/dist/locales/en.json +++ b/dist/locales/en.json @@ -913,7 +913,7 @@ "move_note": "Only new notes can be moved. To move a note, place the mouse cursor over the new note, then press and hold the {leftclick} left mouse button while dragging the note to its new location. Once acceptable, give the note a description and click `Add Note`.", "update_note_h": "Closing, Reopening, and Commenting", "update_note": "An existing note can be updated by closing it, reopening it, or commenting on it. Closing a note indicates that the problem has been resolved. Reopening a note indicates that the original or a previous issue is not resolved, or that there is a new issue. A comment on a note is for discussion.", - "update_note_command": "To update a note, {leftclick} left-click on the note to select it and show the edit menu, then update as needed." + "update_note_command": "To update a note, {leftclick} left-click on the note to select it and show the edit menu, then update as needed. Notes are not features and updates must be saved individually." }, "imagery": { "title": "Background Imagery", @@ -1309,7 +1309,8 @@ "add_point": "'Add point' mode", "add_line": "'Add line' mode", "add_area": "'Add area' mode", - "place_point": "Place a point", + "add_note": "'Add note' mode", + "place_point": "Place a point or note", "disable_snap": "Hold to disable point snapping", "stop_line": "Finish drawing a line or area" },