Add example to custom url template prompt

(closes #3887)
openstreetmap · Jun 20, 2017 · eff9aae · eff9aae
1 parent 684de28
commit eff9aae
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/API.md b/API.md
@@ -19,7 +19,7 @@ in the hash portion of the URL:
   where the URL can contain the standard tile URL placeholders `{x}`, `{y}` and
   `{z}`/`{zoom}`, `{ty}` for flipped TMS-style Y coordinates, and `{switch:a,b,c}` for
   DNS multiplexing.  Example:
-  `background=custom:http://{switch:a,b,c}.tiles.mapbox.com/v4/examples.map-4l7djmvo/{z}/{x}/{y}.png`
+  `background=custom:https://{switch:a,b,c}.tiles.mapbox.com/v4/examples.map-4l7djmvo/{zoom}/{x}/{y}.png`
 * `gpx` - A custom URL for loading a gpx track.  Specifying a `gpx` parameter will
   automatically enable the gpx layer for display.  Example:
   `gpx=https://tasks.hotosm.org/project/592/task/16.gpx`

diff --git a/data/core.yaml b/data/core.yaml
@@ -347,7 +347,7 @@ en:
     switch: Switch back to this background
     custom: Custom
     custom_button: Edit custom background
-    custom_prompt: "Enter a tile URL template. Valid tokens are {zoom}, {x}, {y} for Z/X/Y scheme and {u} for quadtile scheme."
+    custom_prompt: "Enter a tile URL template. Valid tokens are {zoom}, {x}, {y} for Z/X/Y scheme and {u} for quadtile scheme.\n\nExample:\n{example}"
     fix_misalignment: Adjust imagery offset
     imagery_source_faq: Where does this imagery come from?
     reset: reset

diff --git a/dist/locales/en.json b/dist/locales/en.json
@@ -431,7 +431,7 @@
             "switch": "Switch back to this background",
             "custom": "Custom",
             "custom_button": "Edit custom background",
-            "custom_prompt": "Enter a tile URL template. Valid tokens are {zoom}, {x}, {y} for Z/X/Y scheme and {u} for quadtile scheme.",
+            "custom_prompt": "Enter a tile URL template. Valid tokens are {zoom}, {x}, {y} for Z/X/Y scheme and {u} for quadtile scheme.\n\nExample:\n{example}",
             "fix_misalignment": "Adjust imagery offset",
             "imagery_source_faq": "Where does this imagery come from?",
             "reset": "reset",

diff --git a/modules/ui/background.js b/modules/ui/background.js
@@ -111,7 +111,8 @@ export function uiBackground(context) {
 
         function editCustom() {
             d3.event.preventDefault();
-            var template = window.prompt(t('background.custom_prompt'), customTemplate);
+            var example = 'https://{switch:a,b,c}.tiles.mapbox.com/v4/examples.map-4l7djmvo/{zoom}/{x}/{y}.png';
+            var template = window.prompt(t('background.custom_prompt', { example: example }), customTemplate);
             if (template) {
                 setCustom(template);
             } else {