[ios, macos] Factored out tile URL template guide

Factored out redundant tile URL template documentation from the MGLRasterSource and MGLVectorSource documentation into a jazzy guide. This documentation used to live in one place, on a method on MGLTileSource, but that method had to be moved to MGLTileSource’s concrete subclasses. A jazzy guide is easier to link to, in any case.
mapbox · May 16, 2017 · 30b9191 · 30b9191
1 parent c7acb55
commit 30b9191
Show file tree

Hide file tree

Showing 8 changed files with 326 additions and 177 deletions.
diff --git a/platform/darwin/docs/guides/Tile URL Templates.md.ejs b/platform/darwin/docs/guides/Tile URL Templates.md.ejs
@@ -0,0 +1,109 @@
+<%
+  const os = locals.os;
+  const iOS = os === 'iOS';
+  //const macOS = os === 'macOS';
+  //const cocoaPrefix = iOS ? 'UI' : 'NS';
+-%>
+<!--
+  This file is generated.
+  Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`.
+-->
+# Tile URL Templates
+
+`MGLTileSource` objects, specifically `MGLRasterSource` and `MGLVectorSource`
+objects, can be created using an initializer that accepts an array of tile URL
+templates. Tile URL templates are strings that specify the URLs of the vector
+tiles or raster tile images to load. A template resembles an absolute URL, but
+with any number of placeholder strings that the source evaluates based on the
+tile it needs to load. For example:
+
+* `http://www.example.com/tiles/{z}/{x}/{y}.pbf` could be
+   evaluated as `http://www.example.com/tiles/14/6/9.pbf`.
+* `http://www.example.com/tiles/{z}/{x}/{y}{ratio}.png` could be
+   evaluated as `http://www.example.com/tiles/14/6/[email protected]`.
+
+Tile URL templates are also used to define tilesets in TileJSON manifests or
+[`raster`](https://www.mapbox.com/mapbox-gl-js/style-spec/#sources-raster-tiles)
+and
+[`vector`](https://www.mapbox.com/mapbox-gl-js/style-spec/#sources-vector-tiles)
+sources in style JSON files. See the
+[TileJSON specification](https://github.com/mapbox/tilejson-spec/tree/master/2.2.0)
+for information about tile URL templates in the context of a TileJSON or style
+JSON file.
+
+Tile sources support the following placeholder strings in tile URL templates,
+all of which are optional:
+
+<table>
+<thead>
+<tr><th>Placeholder string</th><th>Description</th></tr>
+</thead>
+<tbody>
+<tr>
+    <td><code>{x}</code></td>
+    <td>The index of the tile along the map’s x axis according to Spherical
+       Mercator projection. If the value is 0, the tile’s left edge corresponds
+       to the 180th meridian west. If the value is 2<sup><var>z</var></sup>−1,
+       the tile’s right edge corresponds to the 180th meridian east.</td>
+</tr>
+<tr>
+    <td><code>{y}</code></td>
+    <td>The index of the tile along the map’s y axis according to Spherical
+       Mercator projection. If the value is 0, the tile’s tile edge corresponds
+       to arctan(sinh(π)), or approximately 85.0511 degrees north. If the value
+       is 2<sup><var>z</var></sup>−1, the tile’s bottom edge corresponds to
+       −arctan(sinh(π)), or approximately 85.0511 degrees south. The y axis is
+       inverted if the <code>options</code> parameter contains
+       <code>MGLTileSourceOptionTileCoordinateSystem</code> with a value of
+       <code>MGLTileCoordinateSystemTMS</code>.</td>
+</tr>
+<tr>
+    <td><code>{z}</code></td>
+    <td>The tile’s zoom level. At zoom level 0, each tile covers the entire
+       world map; at zoom level 1, it covers ¼ of the world; at zoom level 2,
+       <sup>1</sup>⁄<sub>16</sub> of the world, and so on. For tiles loaded by
+       a <code>MGLRasterSource</code> object, whether the tile zoom level
+       matches the map’s current zoom level depends on the value of the
+       source’s tile size as specified in the
+       <code>MGLTileSourceOptionTileSize</code> key of the <code>options</code>
+       parameter.</td>
+</tr>
+<tr>
+    <td><code>{bbox-epsg-3857}</code></td>
+    <td>The tile’s bounding box, expressed as a comma-separated list of the
+       tile’s western, southern, eastern, and northern extents according to
+       Spherical Mercator (EPSG:3857) projection. The bounding box is typically
+       used with map services conforming to the
+       <a href="http://www.opengeospatial.org/standards/wms">Web Map Service</a>
+       protocol.</td>
+</tr>
+<tr>
+    <td><code>{quadkey}</code></td>
+    <td>A quadkey indicating both the tile’s location and its zoom level. The
+       quadkey is typically used with
+       <a href="https://msdn.microsoft.com/en-us/library/bb259689.aspx">Bing Maps</a>.
+    </td>
+</tr>
+<tr>
+    <td><code>{ratio}</code></td>
+    <td>A suffix indicating the resolution of the tile image. The suffix is the
+       empty string for standard resolution displays and <code>@2x</code> for
+<% if (iOS) { -%>
+       Retina displays, including displays for which <code>UIScreen.scale</code>
+       is 3.
+<% } else { -%>
+       Retina displays.
+<% } -%>
+       </td>
+</tr>
+<tr>
+    <td><code>{prefix}</code></td>
+    <td>Two hexadecimal digits chosen such that each visible tile has a
+       different prefix. The prefix is typically used for domain sharding.</td>
+</tr>
+</tbody>
+</table>
+
+For more information about the `{x}`, `{y}`, and `{z}` placeholder strings,
+consult the
+[OpenStreetMap Wiki](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames).
diff --git a/platform/darwin/scripts/generate-style-code.js b/platform/darwin/scripts/generate-style-code.js
@@ -522,8 +522,9 @@ global.setSourceLayer = function() {
 const layerH = ejs.compile(fs.readFileSync('platform/darwin/src/MGLStyleLayer.h.ejs', 'utf8'), { strict: true });
 const layerM = ejs.compile(fs.readFileSync('platform/darwin/src/MGLStyleLayer.mm.ejs', 'utf8'), { strict: true});
 const testLayers = ejs.compile(fs.readFileSync('platform/darwin/test/MGLStyleLayerTests.mm.ejs', 'utf8'), { strict: true});
-const guideMD = ejs.compile(fs.readFileSync('platform/darwin/docs/guides/For Style Authors.md.ejs', 'utf8'), { strict: true });
+const forStyleAuthorsMD = ejs.compile(fs.readFileSync('platform/darwin/docs/guides/For Style Authors.md.ejs', 'utf8'), { strict: true });
 const ddsGuideMD = ejs.compile(fs.readFileSync('platform/darwin/docs/guides/Using Style Functions at Runtime.md.ejs', 'utf8'), { strict: true });
+const templatesMD = ejs.compile(fs.readFileSync('platform/darwin/docs/guides/Tile URL Templates.md.ejs', 'utf8'), { strict: true });
 
 const layers = _(spec.layer.type.values).map((value, layerType) => {
     const layoutProperties = Object.keys(spec[`layout_${layerType}`]).reduce((memo, name) => {
@@ -635,12 +636,12 @@ global.guideExample = function (guide, exampleId, os) {
     return '```swift\n' + example + '\n```';
 };
 
-fs.writeFileSync(`platform/ios/docs/guides/For Style Authors.md`, guideMD({
+fs.writeFileSync(`platform/ios/docs/guides/For Style Authors.md`, forStyleAuthorsMD({
     os: 'iOS',
     renamedProperties: renamedPropertiesByLayerType,
     layers: layers,
 }));
-fs.writeFileSync(`platform/macos/docs/guides/For Style Authors.md`, guideMD({
+fs.writeFileSync(`platform/macos/docs/guides/For Style Authors.md`, forStyleAuthorsMD({
     os: 'macOS',
     renamedProperties: renamedPropertiesByLayerType,
     layers: layers,
@@ -651,3 +652,9 @@ fs.writeFileSync(`platform/ios/docs/guides/Using Style Functions at Runtime.md`,
 fs.writeFileSync(`platform/macos/docs/guides/Using Style Functions at Runtime.md`, ddsGuideMD({
     os: 'macOS',
 }));
+fs.writeFileSync(`platform/ios/docs/guides/Tile URL Templates.md`, templatesMD({
+    os: 'iOS',
+}));
+fs.writeFileSync(`platform/macos/docs/guides/Tile URL Templates.md`, templatesMD({
+    os: 'macOS',
+}));
diff --git a/platform/darwin/src/MGLRasterSource.h b/platform/darwin/src/MGLRasterSource.h
@@ -108,96 +108,13 @@ MGL_EXPORT
  Returns a raster source initialized an identifier, tile URL templates, and
  options.
 
+ Tile URL templates are strings that specify the URLs of the raster tile images
+ to load. See the “<a href="../tile-url-templates.html">Tile URL Templates</a>”
+ guide for information about the format of a tile URL template.
+
  After initializing and configuring the source, add it to a map view’s style
  using the `-[MGLStyle addSource:]` method.
 
- #### Tile URL templates
-
- Tile URL templates are strings that specify the URLs of the tile images to
- load. Each template resembles an absolute URL, but with any number of
- placeholder strings that the source evaluates based on the tile it needs to
- load. For example:
-
- <ul>
- <li><code>http://www.example.com/tiles/{z}/{x}/{y}.pbf</code> could be
-    evaluated as <code>http://www.example.com/tiles/14/6/9.pbf</code>.</li>
- <li><code>http://www.example.com/tiles/{z}/{x}/{y}{ratio}.png</code> could be
-    evaluated as <code>http://www.example.com/tiles/14/6/[email protected]</code>.</li>
- </ul>
-
- Tile sources support the following placeholder strings in tile URL templates,
- all of which are optional:
-
- <table>
- <thead>
- <tr><th>Placeholder string</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr>
-     <td><code>{x}</code></td>
-     <td>The index of the tile along the map’s x axis according to Spherical
-        Mercator projection. If the value is 0, the tile’s left edge corresponds
-        to the 180th meridian west. If the value is 2<sup><var>z</var></sup>−1,
-        the tile’s right edge corresponds to the 180th meridian east.</td>
- </tr>
- <tr>
-     <td><code>{y}</code></td>
-     <td>The index of the tile along the map’s y axis according to Spherical
-        Mercator projection. If the value is 0, the tile’s tile edge corresponds
-        to arctan(sinh(π)), or approximately 85.0511 degrees north. If the value
-        is 2<sup><var>z</var></sup>−1, the tile’s bottom edge corresponds to
-        −arctan(sinh(π)), or approximately 85.0511 degrees south. The y axis is
-        inverted if the <code>options</code> parameter contains
-        <code>MGLTileSourceOptionTileCoordinateSystem</code> with a value of
-        <code>MGLTileCoordinateSystemTMS</code>.</td>
- </tr>
- <tr>
-     <td><code>{z}</code></td>
-     <td>The tile’s zoom level. At zoom level 0, each tile covers the entire
-        world map; at zoom level 1, it covers ¼ of the world; at zoom level 2,
-        <sup>1</sup>⁄<sub>16</sub> of the world, and so on. For tiles loaded by
-        a <code>MGLRasterSource</code> object, whether the tile zoom level
-        matches the map’s current zoom level depends on the value of the
-        source’s tile size as specified in the
-        <code>MGLTileSourceOptionTileSize</code> key of the
-        <code>options</code> parameter.</td>
- </tr>
- <tr>
-     <td><code>{bbox-epsg-3857}</code></td>
-     <td>The tile’s bounding box, expressed as a comma-separated list of the
-        tile’s western, southern, eastern, and northern extents according to
-        Spherical Mercator (EPSG:3857) projection. The bounding box is typically
-        used with map services conforming to the
-        <a href="http://www.opengeospatial.org/standards/wms">Web Map Service</a>
-        protocol.</td>
- </tr>
- <tr>
-     <td><code>{quadkey}</code></td>
-     <td>A quadkey indicating both the tile’s location and its zoom level. The
-        quadkey is typically used with
-        <a href="https://msdn.microsoft.com/en-us/library/bb259689.aspx">Bing Maps</a>.
-     </td>
- </tr>
- <tr>
-     <td><code>{ratio}</code></td>
-     <td>A suffix indicating the resolution of the tile image. The suffix is the
-        empty string for standard resolution displays and <code>@2x</code> for
-        Retina displays, including displays for which
-        <code>NSScreen.backingScaleFactor</code> or <code>UIScreen.scale</code>
-        is 3.</td>
- </tr>
- <tr>
-     <td><code>{prefix}</code></td>
-     <td>Two hexadecimal digits chosen such that each visible tile has a
-        different prefix. The prefix is typically used for domain sharding.</td>
- </tr>
- </tbody>
- </table>
-
- For more information about the `{x}`, `{y}`, and `{z}` placeholder strings,
- consult the
- <a href="https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames">OpenStreetMap Wiki</a>.
-
  @param identifier A string that uniquely identifies the source in the style to
     which it is added.
  @param tileURLTemplates An array of tile URL template strings. Only the first

diff --git a/platform/darwin/src/MGLVectorSource.h b/platform/darwin/src/MGLVectorSource.h
@@ -74,96 +74,13 @@ MGL_EXPORT
  Returns a vector source initialized an identifier, tile URL templates, and
  options.
 
+ Tile URL templates are strings that specify the URLs of the vector tiles to
+ load. See the “<a href="../tile-url-templates.html">Tile URL Templates</a>”
+ guide for information about the format of a tile URL template.
+
  After initializing and configuring the source, add it to a map view’s style
  using the `-[MGLStyle addSource:]` method.
 
- #### Tile URL templates
-
- Tile URL templates are strings that specify the URLs of the tile images to
- load. Each template resembles an absolute URL, but with any number of
- placeholder strings that the source evaluates based on the tile it needs to
- load. For example:
-
- <ul>
- <li><code>http://www.example.com/tiles/{z}/{x}/{y}.pbf</code> could be
-    evaluated as <code>http://www.example.com/tiles/14/6/9.pbf</code>.</li>
- <li><code>http://www.example.com/tiles/{z}/{x}/{y}{ratio}.png</code> could be
-    evaluated as <code>http://www.example.com/tiles/14/6/[email protected]</code>.</li>
- </ul>
-
- Tile sources support the following placeholder strings in tile URL templates,
- all of which are optional:
-
- <table>
- <thead>
- <tr><th>Placeholder string</th><th>Description</th></tr>
- </thead>
- <tbody>
- <tr>
-     <td><code>{x}</code></td>
-     <td>The index of the tile along the map’s x axis according to Spherical
-        Mercator projection. If the value is 0, the tile’s left edge corresponds
-        to the 180th meridian west. If the value is 2<sup><var>z</var></sup>−1,
-        the tile’s right edge corresponds to the 180th meridian east.</td>
- </tr>
- <tr>
-     <td><code>{y}</code></td>
-     <td>The index of the tile along the map’s y axis according to Spherical
-        Mercator projection. If the value is 0, the tile’s tile edge corresponds
-        to arctan(sinh(π)), or approximately 85.0511 degrees north. If the value
-        is 2<sup><var>z</var></sup>−1, the tile’s bottom edge corresponds to
-        −arctan(sinh(π)), or approximately 85.0511 degrees south. The y axis is
-        inverted if the <code>options</code> parameter contains
-        <code>MGLTileSourceOptionTileCoordinateSystem</code> with a value of
-        <code>MGLTileCoordinateSystemTMS</code>.</td>
- </tr>
- <tr>
-     <td><code>{z}</code></td>
-     <td>The tile’s zoom level. At zoom level 0, each tile covers the entire
-        world map; at zoom level 1, it covers ¼ of the world; at zoom level 2,
-        <sup>1</sup>⁄<sub>16</sub> of the world, and so on. For tiles loaded by
-        a <code>MGLRasterSource</code> object, whether the tile zoom level
-        matches the map’s current zoom level depends on the value of the
-        source’s tile size as specified in the
-        <code>MGLTileSourceOptionTileSize</code> key of the
-        <code>options</code> parameter.</td>
- </tr>
- <tr>
-     <td><code>{bbox-epsg-3857}</code></td>
-     <td>The tile’s bounding box, expressed as a comma-separated list of the
-        tile’s western, southern, eastern, and northern extents according to
-        Spherical Mercator (EPSG:3857) projection. The bounding box is typically
-        used with map services conforming to the
-        <a href="http://www.opengeospatial.org/standards/wms">Web Map Service</a>
-        protocol.</td>
- </tr>
- <tr>
-     <td><code>{quadkey}</code></td>
-     <td>A quadkey indicating both the tile’s location and its zoom level. The
-        quadkey is typically used with
-        <a href="https://msdn.microsoft.com/en-us/library/bb259689.aspx">Bing Maps</a>.
-     </td>
- </tr>
- <tr>
-     <td><code>{ratio}</code></td>
-     <td>A suffix indicating the resolution of the tile image. The suffix is the
-        empty string for standard resolution displays and <code>@2x</code> for
-        Retina displays, including displays for which
-        <code>NSScreen.backingScaleFactor</code> or <code>UIScreen.scale</code>
-        is 3.</td>
- </tr>
- <tr>
-     <td><code>{prefix}</code></td>
-     <td>Two hexadecimal digits chosen such that each visible tile has a
-        different prefix. The prefix is typically used for domain sharding.</td>
- </tr>
- </tbody>
- </table>
-
- For more information about the `{x}`, `{y}`, and `{z}` placeholder strings,
- consult the
- <a href="https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames">OpenStreetMap Wiki</a>.
-
  @param identifier A string that uniquely identifies the source in the style to
     which it is added.
  @param tileURLTemplates An array of tile URL template strings. Only the first