Skip to content

Commit

Permalink
Indicate macOS SDK support (#641)
Browse files Browse the repository at this point in the history 
* Indicate macOS SDK support

Added macOS SDK support information alongside the existing iOS SDK support information. Clarified that, with respect to the iOS and macOS SDKs, this document is intended as a file format reference for style authors rather than a runtime styling reference.

* macOS SDK v0.2.1

* Removed link to iOS SDK API reference

We’ll add the link back in as soon as iOS SDK v3.4.0 and macOS SDK v0.3.0 are officially released.
  • Loading branch information
@1ec5
1ec5 authored Jan 2, 2017
1 parent 85d8a20 commit 25d721b
Show file tree
Hide file tree
Showing 3 changed files with 235 additions and 115 deletions.
50 changes: 35 additions & 15 deletions docs/_generate/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,11 @@ <h1>{{ page.title }}</h1>
<p>The intended audience of this specification includes:
<ul>
<li>Advanced designers and cartographers who want to write styles by hand rather than use <a href='https://www.mapbox.com/studio'>Mapbox Studio</a></li>
<li>Developers using style-related features of <a href='https://www.mapbox.com/mapbox-gl-js/'>Mapbox GL JS</a> or the Mapbox <a href='https://www.mapbox.com/ios-sdk/'>iOS</a> or <a href='https://www.mapbox.com/android-sdk/'>Android</a> SDKs</li>
<li>Developers using style-related features of <a href='https://www.mapbox.com/mapbox-gl-js/'>Mapbox GL JS</a> or the <a href='https://www.mapbox.com/android-sdk/'>Mapbox Android SDK</a></li>
<li>Authors of software that generates or processes Mapbox styles.</li>
</ul>
</p>
<p>Developers using the <a href='https://www.mapbox.com/ios-sdk/'>Mapbox iOS SDK</a> or <a href='https://github.com/mapbox/mapbox-gl-native/tree/master/platform/macos/'>Mapbox macOS SDK</a> should consult the iOS SDK API reference for platform-appropriate documentation of style-related features.</p>
</div>

<div class='prose'>
Expand Down Expand Up @@ -254,16 +255,18 @@ <h3 class='space-bottom1'><a href='#sources-vector' title='link to vector'>vecto
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
<tr>
<td>basic functionality</td>
<td class='center'>&gt;= 0.10.0</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 2.0.1</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 0.1.0</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -294,16 +297,18 @@ <h3 class='space-bottom1'><a href='#sources-raster' title='link to raster'>raste
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
<tr>
<td>basic functionality</td>
<td class='center'>&gt;= 0.10.0</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 2.0.1</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 0.1.0</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -356,21 +361,25 @@ <h3 class='space-bottom1'><a href='#sources-geojson' title='link to geojson'>geo
<tr class='fill-light'>
<th>SDK Requirements</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
<tr>
<td>basic functionality</td>
<td class='center'>&gt;= 0.10.0</td>
<td class='center'>&gt;= 2.0.1</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 2.0.1</td></tr>
<td class='center'>&gt;= 0.1.0</td>
</tr>
<tr>
<td>clustering</td>
<td class='center'>&gt;= 0.14.0</td>
<td class='center'>Not yet supported</td>
<td class='center'>&gt;= 4.2.0</td>
<td class='center'>Not yet supported</td>
<td class='center'>Not yet supported</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -409,8 +418,9 @@ <h3 class='space-bottom1'><a href='#sources-image' title='link to image'>image</
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
Expand All @@ -419,6 +429,7 @@ <h3 class='space-bottom1'><a href='#sources-image' title='link to image'>image</
<td class='center'>&gt;= 0.10.0</td>
<td class='center'><a href="https://github.com/mapbox/mapbox-gl-native/issues/1350">Not yet supported</a></td>
<td class='center'><a href="https://github.com/mapbox/mapbox-gl-native/issues/1350">Not yet supported</a></td>
<td class='center'><a href="https://github.com/mapbox/mapbox-gl-native/issues/1350">Not yet supported</a></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -462,8 +473,9 @@ <h3 class='space-bottom1'><a href='#sources-video' title='link to video'>video</
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
Expand All @@ -472,6 +484,7 @@ <h3 class='space-bottom1'><a href='#sources-video' title='link to video'>video</
<td>&gt;= 0.10.0</td>
<td><a href="https://github.com/mapbox/mapbox-gl-native/issues/601">Not yet supported</a></td>
<td><a href="https://github.com/mapbox/mapbox-gl-native/issues/601">Not yet supported</a></td>
<td><a href="https://github.com/mapbox/mapbox-gl-native/issues/601">Not yet supported</a></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -803,28 +816,32 @@ <h3 class='space-bottom1'><a href='#types-function' title='link to function'>Fun
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
<tr>
<td>basic functionality</td>
<td class='center'>&gt;= 0.10.0</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 2.0.1</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 0.1.0</td>
</tr>
<tr>
<td><code>identity</code> type</td>
<td class='center'>&gt;= 0.26.0</td>
<td class='center'>Not yet supported</td>
<td class='center'>Not yet supported</td>
<td class='center'>Not yet supported</td>
</tr>
<tr>
<td><code>colorSpace</code></td>
<td class='center'>&gt;= 0.26.0</td>
<td class='center'>Not yet supported</td>
<td class='center'>Not yet supported</td>
<td class='center'>Not yet supported</td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -1032,22 +1049,25 @@ <h4>Combining Filters</h4>
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
<tr>
<td>basic functionality</td>
<td class='center'>&gt;= 0.10.0</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 2.0.1</td>
<td class='center'>&gt;= 2.0.0</td>
<td class='center'>&gt;= 0.1.0</td>
</tr>
<tr>
<td><code>has</code>/<code>!has</code></td>
<td class='center'>&gt;= 0.19.0</td>
<td class='center'>&gt;= 3.3.0</td>
<td class='center'>&gt;= 4.1.0</td>
<td class='center'>&gt;= 3.3.0</td>
<td class='center'>&gt;= 0.1.0</td>
</tr>
</tbody>
</table>
Expand Down
6 changes: 4 additions & 2 deletions docs/_generate/item.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,17 +75,19 @@
<tr class='fill-light'>
<th>SDK Support</th>
<td class='center'>Mapbox GL JS</td>
<td class='center'>iOS SDK</td>
<td class='center'>Android SDK</td>
<td class='center'>iOS SDK</td>
<td class='center'>macOS SDK</td>
</tr>
</thead>
<tbody>
<% _.each(Object.keys(prop['sdk-support']), function(key) { %>
<tr>
<td><%= md(key) %></td>
<td class='center'><%- support(key, 'js') %></td>
<td class='center'><%- support(key, 'ios') %></td>
<td class='center'><%- support(key, 'android') %></td>
<td class='center'><%- support(key, 'ios') %></td>
<td class='center'><%- support(key, 'macos') %></td>
</tr>
<% }); %>
</tbody>
Expand Down
Loading

0 comments on commit 25d721b

Please sign in to comment.