diff options
| author | Jordan Kiley <jmkiley@users.noreply.github.com> | 2017-12-04 16:40:14 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-04 16:40:14 -0800 |
| commit | 8f3cc3dbc4fb0f46f0e2eb00d0b644063c43a582 (patch) | |
| tree | ce40e3163668e2ac8835e43177c0cafe6afa1eb3 | |
| parent | cb5dc2eed8e773e6064419f2d40c969b6ec22fdb (diff) | |
| download | qtlocation-mapboxgl-8f3cc3dbc4fb0f46f0e2eb00d0b644063c43a582.tar.gz | |
[ios, macos] Rename the iOS and macOS SDKs (#10610)
36 files changed, 119 insertions, 113 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 5034146cae..4ce6fe25be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,6 @@ Each Mapbox GL Native SDK has a separate changelog that highlights changes relevant to their respective platforms: * [Mapbox Android SDK](platform/android/CHANGELOG.md) -* [Mapbox iOS SDK](platform/ios/CHANGELOG.md) -* [Mapbox macOS SDK](platform/macos/CHANGELOG.md) +* [Mapbox Maps SDK for iOS](platform/ios/CHANGELOG.md) +* [Mapbox Maps SDK for macOS](platform/macos/CHANGELOG.md) * [node-mapbox-gl-native](platform/node/CHANGELOG.md) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 964ac01a88..f996a17730 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,8 @@ If you want to contribute code: 1. Pull requests are gladly accepted. If there are any changes that developers using one of the GL SDKs should be aware of, please update the **master** section of the relevant changelog(s): * [Mapbox Android SDK](platform/android/CHANGELOG.md) - * [Mapbox iOS SDK](platform/ios/CHANGELOG.md) - * [Mapbox macOS SDK](platform/macos/CHANGELOG.md) + * [Mapbox Maps SDK for iOS](platform/ios/CHANGELOG.md) + * [Mapbox Maps SDK for macOS](platform/macos/CHANGELOG.md) * [node-mapbox-gl-native](platform/node/CHANGELOG.md) 1. Prefix your commit messages with the platform(s) your changes affect: `[core]`, `[android]`, `[ios]`, `[macos]`, `[node]`, or `[qt]`. diff --git a/INSTALL.md b/INSTALL.md index f67de6f3f6..fb619770a1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -57,8 +57,8 @@ dependencies: See the relevant SDK documentation for next steps: * [Maps SDK for Android](platform/android/) -* [Mapbox iOS SDK](platform/ios/) -* [Mapbox macOS SDK](platform/macos/) +* [Maps SDK for iOS](platform/ios/) +* [Maps SDK for iOS](platform/macos/) * [Mapbox Qt SDK](platform/qt/) * [Mapbox GL Native on Linux](platform/linux/) * [node-mapbox-gl-native](platform/node/) @@ -10,8 +10,8 @@ This repository hosts the cross-platform Mapbox GL Native library, plus convenie | --------------------------------------- | ---------------------------------- | ---------------------------------------- | | [Mapbox GL Native](INSTALL.md) | C++14 | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) [](https://coveralls.io/github/mapbox/mapbox-gl-native?branch=master) | | [Mapbox Maps SDK for Android](platform/android/) | Java | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | -| [Mapbox iOS SDK](platform/ios/) | Objective-C or Swift | [](https://www.bitrise.io/app/7514e4cf3da2cc57) | -| [Mapbox macOS SDK](platform/macos/) | Objective-C, Swift, or AppleScript | [](https://www.bitrise.io/app/155ef7da24b38dcd) | +| [Mapbox Maps SDK for iOS](platform/ios/) | Objective-C or Swift | [](https://www.bitrise.io/app/7514e4cf3da2cc57) | +| [Mapbox Maps SDK for macOS](platform/macos/) | Objective-C, Swift, or AppleScript | [](https://www.bitrise.io/app/155ef7da24b38dcd) | | [node-mapbox-gl-native](platform/node/) | Node.js | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | | [Mapbox Qt SDK](platform/qt) | C++03 | [](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) | diff --git a/platform/darwin/src/MGLAccountManager.m b/platform/darwin/src/MGLAccountManager.m index 0f5d033031..7e55779d04 100644 --- a/platform/darwin/src/MGLAccountManager.m +++ b/platform/darwin/src/MGLAccountManager.m @@ -55,7 +55,7 @@ } + (BOOL)mapboxMetricsEnabledSettingShownInApp { - NSLog(@"mapboxMetricsEnabledSettingShownInApp is no longer necessary; the Mapbox iOS SDK has changed to always provide a telemetry setting in-app."); + NSLog(@"mapboxMetricsEnabledSettingShownInApp is no longer necessary; the Mapbox Maps SDK for iOS has changed to always provide a telemetry setting in-app."); return YES; } diff --git a/platform/darwin/src/NSBundle+MGLAdditions.m b/platform/darwin/src/NSBundle+MGLAdditions.m index f383a50300..f55059324e 100644 --- a/platform/darwin/src/NSBundle+MGLAdditions.m +++ b/platform/darwin/src/NSBundle+MGLAdditions.m @@ -15,7 +15,7 @@ bundle = [self bundleWithPath:bundlePath]; } else { [NSException raise:@"MGLBundleNotFoundException" format: - @"The Mapbox framework bundle could not be found. If using the Mapbox iOS SDK as a static framework, make sure that Mapbox.bundle is copied into the root of the app bundle."]; + @"The Mapbox framework bundle could not be found. If using the Mapbox Maps SDK for iOS as a static framework, make sure that Mapbox.bundle is copied into the root of the app bundle."]; } } diff --git a/platform/ios/CHANGELOG.md b/platform/ios/CHANGELOG.md index c25b9adacd..fba48e6e84 100644 --- a/platform/ios/CHANGELOG.md +++ b/platform/ios/CHANGELOG.md @@ -1,9 +1,13 @@ -# Changelog for Mapbox iOS SDK +# Changelog for Mapbox Maps SDK for iOS Mapbox welcomes participation and contributions from everyone. Please read [CONTRIBUTING.md](../../CONTRIBUTING.md) to get started. ## master +### Packaging + +* Renamed this SDK from Mapbox iOS SDK to Mapbox Maps SDK for iOS. ([#10610](https://github.com/mapbox/mapbox-gl-native/pull/10610)) + ### Annotations and user interaction * Increased the default maximum zoom level from 20 to 22. ([#9835](https://github.com/mapbox/mapbox-gl-native/pull/9835)) diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md index 43d7ef3c75..40d45e2e56 100644 --- a/platform/ios/DEVELOPING.md +++ b/platform/ios/DEVELOPING.md @@ -1,12 +1,12 @@ -# Contributing to the Mapbox iOS SDK +# Contributing to the Mapbox Maps SDK for iOS -This document explains how to build the Mapbox iOS SDK from source. It is intended for advanced developers who wish to contribute to Mapbox GL and the Mapbox iOS SDK. +This document explains how to build the Mapbox Maps SDK for iOS from source. It is intended for advanced developers who wish to contribute to Mapbox GL and the Mapbox Maps SDK for iOS. ## Requirements -The Mapbox iOS SDK and iosapp demo application require iOS 8.0 or above. +The Mapbox Maps SDK for iOS and iosapp demo application require iOS 8.0 or above. -The Mapbox iOS SDK requires Xcode 8.0 or above. +The Mapbox Maps SDK for iOS requires Xcode 8.0 or above. ## Building the SDK @@ -70,44 +70,44 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter 1. Ensure that the symbol is pure Objective-C and does not rely on any language features specific to Objective-C++ or the C11 dialect of C – so no namespaced types or classes named with emoji! 🙃 Most projects that depend on this SDK are either written in pure Objective-C (GNU99 dialect) or Swift, which cannot yet bridge C++ types. 1. Name the symbol according to [Cocoa naming conventions](https://developer.apple.com/library/prerelease/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html#//apple_ref/doc/uid/10000146i). Use the `MGL` class prefix to avoid conflicts with client code. If the symbol has an analogue in MapKit, name the symbol according to MapKit. -1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the Mapbox iOS SDK website](https://www.mapbox.com/ios-sdk/api/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools. +1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the website for this SDK](https://www.mapbox.com/ios-sdk/api/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools. ### Making a type or constant public -To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the iOS SDK’s public interface: +To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the iOS maps SDK’s public interface: 1. _(Optional.)_ Add the macro `MGL_EXPORT` prior to the declaration for classes and global constants when adding them in shared headers located in `platform/darwin`. To use this macro, include `MGLFoundation.h`. You can check whether all public symbols are exported correctly by running `make check-public-symbols`. 1. _(Optional.)_ Add the type or constant’s name to the relevant category in the `custom_categories` section of [the jazzy configuration file](./jazzy.yml). This is required for classes and protocols and also recommended for any other type that is strongly associated with a particular class or protocol. If you leave out this step, the symbol will appear in an “Other” section in the generated HTML documentation’s table of contents. -1. _(Optional.)_ If the symbol would also be publicly exposed in the macOS SDK, consult [the companion macOS document](../macos/DEVELOPING.md#making-a-type-or-constant-public) for further instructions. +1. _(Optional.)_ If the symbol would also be publicly exposed in the macOS maps SDK, consult [the companion macOS document](../macos/DEVELOPING.md#making-a-type-or-constant-public) for further instructions. ### Adding a source code file -To add an Objective-C header or implementation file to the iOS SDK: +To add an Objective-C header or implementation file to the iOS maps SDK: 1. Add the file to the Headers or Compile Sources build phase, as appropriate, of both the “dynamic” and “static” targets. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector. 1. Audit new headers for nullability. Typically, you will wrap a header with `NS_ASSUME_NONNULL_BEGIN` and `NS_ASSUME_NONNULL_END`. 1. _(Optional.)_ If it’s a public header, change its visibility from Project to Public and import it in [the iOS SDK’s umbrella header](./src/Mapbox.h). -1. _(Optional.)_ If the file would also be used by the macOS SDK, make sure it’s in [platform/darwin/src/](../darwin/src/), then consult [the companion macOS document](../macos/DEVELOPING.md#adding-a-source-code-file) for further instructions. +1. _(Optional.)_ If the file would also be used by the macOS maps SDK, make sure it’s in [platform/darwin/src/](../darwin/src/), then consult [the companion macOS document](../macos/DEVELOPING.md#adding-a-source-code-file) for further instructions. ### Adding a resource -To add a resource (such as an image, SSL certificate, property list, or strings table) to the iOS SDK: +To add a resource (such as an image, SSL certificate, property list, or strings table) to the iOS maps SDK: 1. Add the header to the Copy Bundle Resources build phase of both the “dynamic” and “bundle” targets. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector. -1. _(Optional.)_ If the resource would also be used by the macOS SDK, make sure it’s in [platform/darwin/resources/](../darwin/resources/), then consult [the companion macOS document](../macos/DEVELOPING.md#adding-a-resource) for further instructions. +1. _(Optional.)_ If the resource would also be used by the macOS maps SDK, make sure it’s in [platform/darwin/resources/](../darwin/resources/), then consult [the companion macOS document](../macos/DEVELOPING.md#adding-a-resource) for further instructions. ### Adding user-facing text -To add or update text that the user may see in the iOS SDK: +To add or update text that the user may see in the iOS maps SDK: 1. Make sure the implementation file imports [NSBundle+MGLAdditions.h](../darwin/src/NSBundle+MGLAdditions.h). 1. Use the `NSLocalizedStringWithDefaultValue()` macro: * `key` is a unique identifier that won’t change if the user-facing text ever needs to change. - * `tbl` is `Foundation` in code shared between the iOS and macOS SDKs, or `nil` otherwise. + * `tbl` is `Foundation` in code shared between the iOS and macOS maps SDKs, or `nil` otherwise. * `bundle` is `nil`; the redefined macro looks for the SDK bundle at runtime and ignores this argument. * `val` is the English string. 1. _(Optional.)_ When dealing with a number followed by a pluralized word, do not split the string. Instead, use a format string and make `val` ambiguous, like `%d file(s)`. Then pluralize for English in the appropriate [.stringsdict file](https://developer.apple.com/library/ios/documentation/MacOSX/Conceptual/BPInternational/StringsdictFileFormat/StringsdictFileFormat.html). See [platform/darwin/resources/en.lproj/Foundation.stringsdict](../darwin/resources/en.lproj/Foundation.stringsdict) for an example. Localizers should do likewise for their languages. -1. Run `make genstrings` and commit any changes it makes to .strings files. The make rule also updates the macOS SDK’s strings tables. +1. Run `make genstrings` and commit any changes it makes to .strings files. The make rule also updates the macOS maps SDK’s strings tables. ### Adding a localization diff --git a/platform/ios/INSTALL.md b/platform/ios/INSTALL.md index e8c821ecee..9a85dfe6fb 100644 --- a/platform/ios/INSTALL.md +++ b/platform/ios/INSTALL.md @@ -1,16 +1,16 @@ -# Integrating custom builds of the Mapbox iOS SDK into your application +# Integrating custom builds of the Mapbox Maps SDK for iOS into your application -This document explains how to build a development version of Mapbox iOS SDK for use in your own Cocoa Touch application. To use a production-ready version of the SDK, see the [Mapbox iOS SDK installation page](https://www.mapbox.com/install/ios/). +This document explains how to build a development version of Mapbox Maps SDK for iOS for use in your own Cocoa Touch application. To use a production-ready version of the SDK, see the [Mapbox Maps SDK for iOS installation page](https://www.mapbox.com/install/ios/). ### Requirements -The Mapbox iOS SDK is intended to run on iOS 8.0 and above on the following devices and their simulators: +The Mapbox Maps SDK for iOS is intended to run on iOS 8.0 and above on the following devices and their simulators: * iPhone 4S and above (5, 5c, 5s, 6, 6 Plus) * iPad 2 and above (3, 4, Mini, Air, Mini 2, Air 2) * iPod touch 5th generation and above -The Mapbox iOS SDK requires Xcode 8.0 or higher. To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. +The Mapbox Maps SDK for iOS requires Xcode 8.0 or higher. To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. ### Building the SDK @@ -32,7 +32,7 @@ See the [packaging documentation](DEVELOPING.md#packaging-builds) for other buil ### Installation -There are several ways to install custom builds of the Mapbox iOS SDK: +There are several ways to install custom builds of the Mapbox Maps SDK for iOS: #### Dynamic framework @@ -113,7 +113,7 @@ If using the static framework, add `$(inherited)` to your target’s Other Linke #### Carthage -For instructions on installing stable release versions of the Mapbox iOS SDK with Carthage, see [our website](https://www.mapbox.com/install/ios/carthage/). If you require a build without symbols pre-stripped, use [this feed URL](https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK-symbols.json) with Carthage. +For instructions on installing stable release versions of the Mapbox Maps SDK for iOS with Carthage, see [our website](https://www.mapbox.com/install/ios/carthage/). If you require a build without symbols pre-stripped, use [this feed URL](https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK-symbols.json) with Carthage. ##### Testing pre-releases with Carthage diff --git a/platform/ios/README.md b/platform/ios/README.md index de70c4e891..23171e294e 100644 --- a/platform/ios/README.md +++ b/platform/ios/README.md @@ -1,4 +1,4 @@ -# [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/) +# [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) [](https://www.bitrise.io/app/7514e4cf3da2cc57) @@ -6,8 +6,8 @@ A library based on [Mapbox GL Native](../../README.md) for embedding interactive This repository is for day-to-day development of the SDK. Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. For production applications, please consider installing an official, production-ready version instead. -* [Integrate the Mapbox iOS SDK into your application](https://www.mapbox.com/install/ios/). +* [Integrate the Mapbox Maps SDK for iOS into your application](https://www.mapbox.com/install/ios/). * [Learn about custom builds](INSTALL.md) -* [Contribute to the Mapbox iOS SDK](DEVELOPING.md) +* [Contribute to the Mapbox Maps SDK for iOS](DEVELOPING.md)  diff --git a/platform/ios/docs/doc-README.md b/platform/ios/docs/doc-README.md index ebad32e04c..7cd0376d07 100644 --- a/platform/ios/docs/doc-README.md +++ b/platform/ios/docs/doc-README.md @@ -1,9 +1,9 @@ -# [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/) +# [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) -The Mapbox iOS SDK is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 8.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL. +The Mapbox Maps SDK for iOS is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 8.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL. - + -For setup information, check out the [Mapbox iOS SDK homepage](https://www.mapbox.com/ios-sdk/). For detailed usage instructions, read “[First steps with the Mapbox iOS SDK](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). A [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/ios/CHANGELOG.md) is also available. +For setup information, check out the [Mapbox Maps SDK for iOS homepage](https://www.mapbox.com/ios-sdk/). For detailed usage instructions, read “[First steps with the Mapbox Maps SDK for iOS](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). A [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/ios/CHANGELOG.md) is also available. If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native/issues/). diff --git a/platform/ios/docs/guides/Gesture Recognizers.md b/platform/ios/docs/guides/Gesture Recognizers.md index 08e4c150e1..26237e3cfa 100644 --- a/platform/ios/docs/guides/Gesture Recognizers.md +++ b/platform/ios/docs/guides/Gesture Recognizers.md @@ -1,6 +1,6 @@ # User Interactions -The Mapbox iOS SDK provides a set of built-in gesture recognizers. You can customize or supplement these gestures according to your use case. You see what gesture recognizers are on your `MGLMapView` by accessing the `gestureRecognizers` property on your map. +The Mapbox Maps SDK for iOS provides a set of built-in gesture recognizers. You can customize or supplement these gestures according to your use case. You see what gesture recognizers are on your `MGLMapView` by accessing the `gestureRecognizers` property on your map. ## Configuring user interaction diff --git a/platform/ios/docs/guides/Info.plist Keys.md b/platform/ios/docs/guides/Info.plist Keys.md index c5c7cf1d85..e74e28b76b 100644 --- a/platform/ios/docs/guides/Info.plist Keys.md +++ b/platform/ios/docs/guides/Info.plist Keys.md @@ -1,6 +1,6 @@ # Info.plist Keys -The Mapbox iOS SDK supports custom `Info.plist` keys in your application in order to configure various settings. +The Mapbox Maps SDK for iOS supports custom `Info.plist` keys in your application in order to configure various settings. ## MGLMapboxAccessToken diff --git a/platform/ios/docs/pod-README.md b/platform/ios/docs/pod-README.md index 2e5a78841c..f94073bd9f 100644 --- a/platform/ios/docs/pod-README.md +++ b/platform/ios/docs/pod-README.md @@ -1,16 +1,16 @@ -# [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/) +# [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) -The Mapbox iOS SDK is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 8.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL. +The Mapbox Maps SDK for iOS is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 8.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL. -For more information, check out the [Mapbox iOS SDK homepage](https://www.mapbox.com/ios-sdk/) and the [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/ios/CHANGELOG.md) online. +For more information, check out the [Mapbox Maps SDK for iOS homepage](https://www.mapbox.com/ios-sdk/) and the [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/platform/ios/CHANGELOG.md) online. []() ## Installation -The Mapbox iOS SDK may be installed as either a dynamic framework or a static framework. (To reduce the download size, the static framework is omitted from some distributions; you may need to download the full package from the [release page](https://github.com/mapbox/mapbox-gl-native/releases/).) +The Mapbox Maps SDK for iOS may be installed as either a dynamic framework or a static framework. (To reduce the download size, the static framework is omitted from some distributions; you may need to download the full package from the [release page](https://github.com/mapbox/mapbox-gl-native/releases/).) -Integrating the Mapbox iOS SDK requires Xcode 8.0 or higher. To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. +Integrating the Mapbox Maps SDK for iOS requires Xcode 8.0 or higher. To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. {{DYNAMIC}} @@ -94,6 +94,6 @@ class ViewController: UIViewController { } ``` -Full API documentation is included in this package, within the `documentation` folder. For more details, read “[First steps with the Mapbox iOS SDK](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). +Full API documentation is included in this package, within the `documentation` folder. For more details, read “[First steps with the Mapbox Maps SDK for iOS](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). If you have any questions, please see [our help page](https://www.mapbox.com/help/). We welcome your [bug reports, feature requests, and contributions](https://github.com/mapbox/mapbox-gl-native/issues/). diff --git a/platform/ios/resources/Base.lproj/Localizable.strings b/platform/ios/resources/Base.lproj/Localizable.strings index 039ef4c4b1..22ed9278bc 100644 --- a/platform/ios/resources/Base.lproj/Localizable.strings +++ b/platform/ios/resources/Base.lproj/Localizable.strings @@ -74,10 +74,10 @@ "ROAD_REF_A11Y_FMT" = "Route %@"; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK version %@ is now available:"; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS version %@ is now available:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "The map failed to load because the style can’t be found or is incompatible."; diff --git a/platform/ios/resources/bg.lproj/Localizable.strings b/platform/ios/resources/bg.lproj/Localizable.strings index 7098589b6b..e9b35e4438 100644 --- a/platform/ios/resources/bg.lproj/Localizable.strings +++ b/platform/ios/resources/bg.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Показва повече инфо"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Картата не се зареди поради повреден стил."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Сега е налична Mapbox iOS SDK версия %@:"; +"SDK_UPDATE_AVAILABLE" = "Сега е налична Mapbox Maps SDK for iOS версия %@:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Картата не се зареди поради неоткрит или несъвместим стил."; diff --git a/platform/ios/resources/ca.lproj/Localizable.strings b/platform/ios/resources/ca.lproj/Localizable.strings index ae655f282d..a5c06f739e 100644 --- a/platform/ios/resources/ca.lproj/Localizable.strings +++ b/platform/ios/resources/ca.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Mostra més informació"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "El mapa no s’ha carregat perquè s’ha corromput l’estil."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "La versió %@ del Mapbox iOS SDK està disponible:"; +"SDK_UPDATE_AVAILABLE" = "La versió %@ del Mapbox Maps SDK for iOS està disponible:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "El mapa no s’ha carregat perquè no es troba l’estil o bé és incompatible."; diff --git a/platform/ios/resources/de.lproj/Localizable.strings b/platform/ios/resources/de.lproj/Localizable.strings index e8180ea17c..f3e5dfe2f1 100644 --- a/platform/ios/resources/de.lproj/Localizable.strings +++ b/platform/ios/resources/de.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Mehr Infos anzeigen"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Die Karte konnte nicht geladen werden, da diese Form beschädigt ist."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK Version %@ ist ab sofort verfügbar."; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS Version %@ ist ab sofort verfügbar."; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Die Karte konnte nicht geladen werden, da diese Form nicht gefunden werden kann oder nicht kompatibel ist."; diff --git a/platform/ios/resources/es.lproj/Localizable.strings b/platform/ios/resources/es.lproj/Localizable.strings index 75f799fcd9..52cf7831f3 100644 --- a/platform/ios/resources/es.lproj/Localizable.strings +++ b/platform/ios/resources/es.lproj/Localizable.strings @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "No se pudo cargar el mapa debido a que el estilo está dañado."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "La versión %@ de Mapbox iOS SDK está disponible:"; +"SDK_UPDATE_AVAILABLE" = "La versión %@ de Mapbox Maps SDK for iOS está disponible:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "No se pudo cargar el mapa debido a que no se encuentra el estilo o está incompleto."; diff --git a/platform/ios/resources/fr.lproj/Localizable.strings b/platform/ios/resources/fr.lproj/Localizable.strings index 7fc85568c7..7c02663d47 100644 --- a/platform/ios/resources/fr.lproj/Localizable.strings +++ b/platform/ios/resources/fr.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Voir plus d’informations"; /* No comment provided by engineer. */ @@ -53,7 +53,7 @@ "PARSE_STYLE_FAILED_DESC" = "La carte n’a pas pu être chargée car le style est corrompu."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ "SDK_UPDATE_AVAILABLE" = "La version %@ du SDK Mapbox pour iOS est maintenant disponible :"; diff --git a/platform/ios/resources/hu.lproj/Localizable.strings b/platform/ios/resources/hu.lproj/Localizable.strings index a4d1b1c3ae..e4c9882600 100644 --- a/platform/ios/resources/hu.lproj/Localizable.strings +++ b/platform/ios/resources/hu.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Több infót mutat"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Nem sikerült betölteni a térképet, mert a stílus sérült."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK %@ mostantól elérhető:"; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS %@ mostantól elérhető:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Nem sikerült betölteni a térképet, mert a stílus nem található vagy inkompatibilis."; diff --git a/platform/ios/resources/ja.lproj/Localizable.strings b/platform/ios/resources/ja.lproj/Localizable.strings index b8fde1cdb2..0bcb706cae 100644 --- a/platform/ios/resources/ja.lproj/Localizable.strings +++ b/platform/ios/resources/ja.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "詳細を伝える"; /* No comment provided by engineer. */ @@ -41,10 +41,10 @@ "MAP_A11Y_VALUE" = "ズーム %1$d倍\n%2$ld ピン現れる"; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "現在Mapbox iOS SDK %1$@が入手できる："; +"SDK_UPDATE_AVAILABLE" = "現在Mapbox Maps SDK for iOS %1$@が入手できる："; /* Telemetry prompt message */ "TELEMETRY_DISABLED_MSG" = "You can help make OpenStreetMap and Mapbox maps better by contributing anonymous usage data."; diff --git a/platform/ios/resources/lt.lproj/Localizable.strings b/platform/ios/resources/lt.lproj/Localizable.strings index 3ac683fe40..e8424434b9 100644 --- a/platform/ios/resources/lt.lproj/Localizable.strings +++ b/platform/ios/resources/lt.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Rodo daugiau informacijos"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Nepavyko užkrauti žemėlapio, nes stilius yra netinkamo formato."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK versija %@ jau prieinama."; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS versija %@ jau prieinama."; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Nepavyko užkrauti žemėlapio, nes neįmanoma rasti stiliaus arba jis nėra suderinamas."; diff --git a/platform/ios/resources/pt-BR.lproj/Localizable.strings b/platform/ios/resources/pt-BR.lproj/Localizable.strings index 53c3d3a12d..4e7e998ab3 100644 --- a/platform/ios/resources/pt-BR.lproj/Localizable.strings +++ b/platform/ios/resources/pt-BR.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Mostrar mais informações"; /* No comment provided by engineer. */ @@ -53,7 +53,7 @@ "PARSE_STYLE_FAILED_DESC" = "Falha ao carregar mapa porque o estilo está corrompido."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ "SDK_UPDATE_AVAILABLE" = "SDK Mapbox para iOS versão %@ está disponível:"; diff --git a/platform/ios/resources/ru.lproj/Localizable.strings b/platform/ios/resources/ru.lproj/Localizable.strings index 40f59a3356..6d5ea9025e 100644 --- a/platform/ios/resources/ru.lproj/Localizable.strings +++ b/platform/ios/resources/ru.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Показать больше информации"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Не удалось загрузить карту из-за ошибки в стиле."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK версии %@теперь доступен."; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS версии %@теперь доступен."; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Не удалось загрузить карту так как стиль не найден или несовместим."; diff --git a/platform/ios/resources/sv.lproj/Localizable.strings b/platform/ios/resources/sv.lproj/Localizable.strings index b10b1b06ed..df4f3554ff 100644 --- a/platform/ios/resources/sv.lproj/Localizable.strings +++ b/platform/ios/resources/sv.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Visa mer information"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Kartan kunde inte laddas på grund av att stilen är skadad."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK version %@ är nu tillgängligt:"; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS version %@ är nu tillgängligt:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Kartan kunde inte laddas på grund av ett okänt fel."; diff --git a/platform/ios/resources/uk.lproj/Localizable.strings b/platform/ios/resources/uk.lproj/Localizable.strings index 8392f945b8..79b9779cc6 100644 --- a/platform/ios/resources/uk.lproj/Localizable.strings +++ b/platform/ios/resources/uk.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Показує більше інформації"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Неможливо завантажити мапу, через помилки в стилі."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Доступна версія %@ Mapbox iOS SDK:"; +"SDK_UPDATE_AVAILABLE" = "Доступна версія %@ Mapbox Maps SDK for iOS:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Неможливо завантажити мапу, бо неможливо знайти стиль або він несумісний."; diff --git a/platform/ios/resources/vi.lproj/Localizable.strings b/platform/ios/resources/vi.lproj/Localizable.strings index 8a35d5d5d6..ec76339440 100644 --- a/platform/ios/resources/vi.lproj/Localizable.strings +++ b/platform/ios/resources/vi.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "Hiển thị thêm thông tin"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "Bản đồ bị thất bại khi tải vì bảng kiểu bị hỏng."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK mới ra phiên bản %@:"; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS mới ra phiên bản %@:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "Bản đồ bị thất bại khi tải vì không tìm thấy bảng kiểu hoặc bảng kiểu không tương thích."; diff --git a/platform/ios/resources/zh-Hans.lproj/Localizable.strings b/platform/ios/resources/zh-Hans.lproj/Localizable.strings index 5167e93c1b..1a3453e209 100644 --- a/platform/ios/resources/zh-Hans.lproj/Localizable.strings +++ b/platform/ios/resources/zh-Hans.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "显示信息"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "The map failed to load because the style is corrupted."; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK version %@ is now available:"; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS version %@ is now available:"; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "The map failed to load because the style can’t be found or is incompatible."; diff --git a/platform/ios/resources/zh-Hant.lproj/Localizable.strings b/platform/ios/resources/zh-Hant.lproj/Localizable.strings index 585ff3dd27..d660a3d1ae 100644 --- a/platform/ios/resources/zh-Hant.lproj/Localizable.strings +++ b/platform/ios/resources/zh-Hant.lproj/Localizable.strings @@ -1,4 +1,4 @@ -/* Accessibility hint */ +/* Accessibility hint */ "ANNOTATION_A11Y_HINT" = "顯示信息"; /* No comment provided by engineer. */ @@ -53,10 +53,10 @@ "PARSE_STYLE_FAILED_DESC" = "樣式表有毀損，無法載入地圖。"; /* Action sheet title */ -"SDK_NAME" = "Mapbox iOS SDK"; +"SDK_NAME" = "Mapbox Maps SDK for iOS"; /* Developer-only SDK update notification; {latest version, in format x.x.x} */ -"SDK_UPDATE_AVAILABLE" = "Mapbox iOS SDK %@版現已開放下載："; +"SDK_UPDATE_AVAILABLE" = "Mapbox Maps SDK for iOS %@版現已開放下載："; /* User-friendly error description */ "STYLE_NOT_FOUND_DESC" = "找不到樣式表或樣式表不兼容，無法載入地圖。"; diff --git a/platform/ios/src/MGLMapView.mm b/platform/ios/src/MGLMapView.mm index 8154525334..87b1a1c14e 100644 --- a/platform/ios/src/MGLMapView.mm +++ b/platform/ios/src/MGLMapView.mm @@ -1975,7 +1975,7 @@ public: - (void)showAttribution:(__unused id)sender { - NSString *title = NSLocalizedStringWithDefaultValue(@"SDK_NAME", nil, nil, @"Mapbox iOS SDK", @"Action sheet title"); + NSString *title = NSLocalizedStringWithDefaultValue(@"SDK_NAME", nil, nil, @"Mapbox Maps SDK for iOS", @"Action sheet title"); UIAlertController *attributionController = [UIAlertController alertControllerWithTitle:title message:nil preferredStyle:UIAlertControllerStyleActionSheet]; diff --git a/platform/ios/src/MGLSDKUpdateChecker.mm b/platform/ios/src/MGLSDKUpdateChecker.mm index ab4ef7be86..bb61e2b595 100644 --- a/platform/ios/src/MGLSDKUpdateChecker.mm +++ b/platform/ios/src/MGLSDKUpdateChecker.mm @@ -29,7 +29,7 @@ NSString *latestVersion = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]; latestVersion = [latestVersion stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]; if (![currentVersion isEqualToString:latestVersion]) { - NSString *updateAvailable = [NSString stringWithFormat:NSLocalizedStringWithDefaultValue(@"SDK_UPDATE_AVAILABLE", nil, nil, @"Mapbox iOS SDK version %@ is now available:", @"Developer-only SDK update notification; {latest version, in format x.x.x}"), latestVersion]; + NSString *updateAvailable = [NSString stringWithFormat:NSLocalizedStringWithDefaultValue(@"SDK_UPDATE_AVAILABLE", nil, nil, @"Mapbox Maps SDK for iOS version %@ is now available:", @"Developer-only SDK update notification; {latest version, in format x.x.x}"), latestVersion]; NSLog(@"%@ https://github.com/mapbox/mapbox-gl-native/releases/tag/ios-v%@", updateAvailable, latestVersion); } }] resume]; diff --git a/platform/macos/CHANGELOG.md b/platform/macos/CHANGELOG.md index 4a5172be64..4ea1eafb89 100644 --- a/platform/macos/CHANGELOG.md +++ b/platform/macos/CHANGELOG.md @@ -2,6 +2,8 @@ ## master +* Renamed this SDK from Mapbox macOS SDK to Mapbox Maps SDK for macOS. ([#10610](https://github.com/mapbox/mapbox-gl-native/pull/10610)) + ### Annotations and user interaction * Increased the default maximum zoom level from 20 to 22. ([#9835](https://github.com/mapbox/mapbox-gl-native/pull/9835)) diff --git a/platform/macos/DEVELOPING.md b/platform/macos/DEVELOPING.md index fecde1fb38..562f1291c2 100644 --- a/platform/macos/DEVELOPING.md +++ b/platform/macos/DEVELOPING.md @@ -1,12 +1,12 @@ -# Contributing to the Mapbox macOS SDK +# Contributing to the Mapbox Maps SDK for macOS -This document explains how to build the Mapbox macOS SDK from source. It is intended for advanced developers who wish to contribute to Mapbox GL and the Mapbox iOS SDK. +This document explains how to build the Mapbox Maps SDK for macOS from source. It is intended for advanced developers who wish to contribute to Mapbox GL and the Mapbox Maps SDK for iOS. ## Requirements -The Mapbox macOS SDK and the macosapp demo application run on macOS 10.10.0 or above. +The Mapbox Maps SDK for macOS and the macosapp demo application run on macOS 10.10.0 or above. -The Mapbox macOS SDK requires Xcode 8.0 or above. +The Mapbox Maps SDK for macOS requires Xcode 8.0 or above. ## Building the SDK @@ -44,7 +44,7 @@ The products of these build commands can be found in the `build/macos/pkg` folde ### Making any symbol public -To add any Objective-C type, constant, or member to the iOS SDK’s public interface: +To add any Objective-C type, constant, or member to the macOS maps SDK’s public interface: 1. Ensure that the symbol is pure Objective-C and does not rely on any language features specific to Objective-C++ or the C11 dialect of C – so no namespaced types or classes named with emoji! 🙃 Most projects that depend on this SDK are either written in pure Objective-C (GNU99 dialect) or Swift, which cannot yet bridge C++ types. 1. Name the symbol according to [Cocoa naming conventions](https://developer.apple.com/library/prerelease/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html#//apple_ref/doc/uid/10000146i). Use the `MGL` class prefix to avoid conflicts with client code. If the symbol has an analogue in MapKit, name the symbol according to MapKit. @@ -52,40 +52,40 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter ### Making a type or constant public -To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the macOS SDK’s public interface: +To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the macOS maps SDK’s public interface: 1. _(Optional.)_ Add the macro `MGL_EXPORT` prior to the declaration for classes and global constants. To use this macro, include `MGLFoundation.h`. You can check whether all public symbols are exported correctly by running `make check-public-symbols`. 1. _(Optional.)_ Add the type or constant’s name to the relevant category in the `custom_categories` section of [the jazzy configuration file](./jazzy.yml). This is required for classes and protocols and also recommended for any other type that is strongly associated with a particular class or protocol. If you leave out this step, the symbol will appear in an “Other” section in the generated HTML documentation’s table of contents. -1. _(Optional.)_ If the symbol would also be publicly exposed in the iOS SDK, consult [the companion iOS document](../ios/DEVELOPING.md#making-a-type-or-constant-public) for further instructions. +1. _(Optional.)_ If the symbol would also be publicly exposed in the iOS maps SDK, consult [the companion iOS document](../ios/DEVELOPING.md#making-a-type-or-constant-public) for further instructions. ### Adding a source code file -To add an Objective-C header or implementation file to the macOS SDK: +To add an Objective-C header or implementation file to the macOS maps SDK: 1. Add the file to the “dynamic” target’s Headers or Compile Sources build phase, as appropriate. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector. 1. Audit new headers for nullability. Typically, you will wrap a header with `NS_ASSUME_NONNULL_BEGIN` and `NS_ASSUME_NONNULL_END`. 1. _(Optional.)_ If it’s a public header, change its visibility from Project to Public and import it in [the macOS SDK’s umbrella header](./src/Mapbox.h). -1. _(Optional.)_ If the file would also be used by the iOS SDK, make sure it’s in [platform/darwin/src/](../darwin/src/), then consult [the companion iOS document](../ios/DEVELOPING.md#adding-a-source-code-file) for further instructions. +1. _(Optional.)_ If the file would also be used by the iOS maps SDK, make sure it’s in [platform/darwin/src/](../darwin/src/), then consult [the companion iOS document](../ios/DEVELOPING.md#adding-a-source-code-file) for further instructions. ### Adding a resource -To add a resource (such as an image, SSL certificate, property list, or strings table) to the macOS SDK: +To add a resource (such as an image, SSL certificate, property list, or strings table) to the macOS maps SDK: 1. Add the header to the Copy Bundle Resources build phase of the “dynamic” target. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector. -1. _(Optional.)_ If the resource would also be used by the iOS SDK, make sure it’s in [platform/darwin/resources/](../darwin/resources/), then consult [the companion iOS document](../ios/DEVELOPING.md#adding-a-resource) for further instructions. +1. _(Optional.)_ If the resource would also be used by the iOS maps SDK, make sure it’s in [platform/darwin/resources/](../darwin/resources/), then consult [the companion iOS document](../ios/DEVELOPING.md#adding-a-resource) for further instructions. ### Adding user-facing text -To add or update text that the user may see in the macOS SDK: +To add or update text that the user may see in the macOS maps SDK: 1. Make sure the implementation file imports [NSBundle+MGLAdditions.h](../darwin/src/NSBundle+MGLAdditions.h). 1. Use the `NSLocalizedStringWithDefaultValue()` macro: * `key` is a unique identifier that won’t change if the user-facing text ever needs to change. - * `tbl` is `Foundation` in code shared between the iOS and macOS SDKs, or `nil` otherwise. + * `tbl` is `Foundation` in code shared between the iOS and macOS maps SDKs, or `nil` otherwise. * `bundle` is `nil`; the redefined macro looks for the SDK bundle at runtime and ignores this argument. * `val` is the English string. 1. _(Optional.)_ When dealing with a number followed by a pluralized word, do not split the string. Instead, use a format string and make `val` ambiguous, like `%d file(s)`. Then pluralize for English in the appropriate [.stringsdict file](https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPInternational/StringsdictFileFormat/StringsdictFileFormat.html). See [platform/darwin/resources/en.lproj/Foundation.stringsdict](../darwin/resources/en.lproj/Foundation.stringsdict) for an example. Localizers should do likewise for their languages. -1. Run `make genstrings` and commit any changes it makes to .strings files. The make rule also updates the iOS SDK’s strings tables. +1. Run `make genstrings` and commit any changes it makes to .strings files. The make rule also updates the iOS maps SDK’s strings tables. ### Adding a localization @@ -141,6 +141,6 @@ The demo applications use Mapbox vector tiles, which require a Mapbox account an ## Using macosapp -Through the macOS SDK, the demo application supports a variety of standard gestures and keyboard shortcuts. For more details, open Mapbox GL Help from the Help menu. +Through the macOS maps SDK, the demo application supports a variety of standard gestures and keyboard shortcuts. For more details, open Mapbox GL Help from the Help menu. -You can also [integrate the Mapbox macOS SDK into your own Cocoa application](INSTALL.md). +You can also [integrate the Mapbox Maps SDK for macOS into your own Cocoa application](INSTALL.md). diff --git a/platform/macos/INSTALL.md b/platform/macos/INSTALL.md index cbb9d7d8a6..c723d3e062 100644 --- a/platform/macos/INSTALL.md +++ b/platform/macos/INSTALL.md @@ -1,10 +1,10 @@ -# Integrating a custom build of the Mapbox macOS SDK into your application +# Integrating a custom build of the Mapbox Maps SDK for macOS into your application -This document explains how to build a development version of the Mapbox macOS SDK from source and integrate it into your own Cocoa application. This process is for advanced developers who want to get a glimpse of the SDK’s development between releases. To use a production-ready version of the SDK, see the [Mapbox macOS SDK homepage](https://mapbox.github.io/mapbox-gl-native/macos/). +This document explains how to build a development version of the Mapbox Maps SDK for macOS from source and integrate it into your own Cocoa application. This process is for advanced developers who want to get a glimpse of the SDK’s development between releases. To use a production-ready version of the SDK, see the [Mapbox Maps SDK for macOS homepage](https://mapbox.github.io/mapbox-gl-native/macos/). ### Requirements -The Mapbox macOS SDK requires the macOS 10.10.0 SDK (or above) and Xcode 8.0 (or above). To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. +The Mapbox Maps SDK for macOS requires the macOS 10.10.0 SDK (or above) and Xcode 8.0 (or above). To use this SDK with Xcode 7.3.1, download and use a symbols build from the [releases](https://github.com/mapbox/mapbox-gl-native/releases) page. ### Building the SDK from source @@ -71,4 +71,4 @@ script AppDelegate end script ``` -For further instructions, consult the [macOS SDK documentation](https://mapbox.github.io/mapbox-gl-native/macos/) or run `make xdocument` to generate the documentation. The [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/)’s [API documentation](https://www.mapbox.com/ios-sdk/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) apply to the Mapbox macOS SDK with few differences, mostly around unimplemented features like user location tracking. +For further instructions, consult the [macOS SDK documentation](https://mapbox.github.io/mapbox-gl-native/macos/) or run `make xdocument` to generate the documentation. The [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/)’s [API documentation](https://www.mapbox.com/ios-sdk/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) apply to the Mapbox Maps SDK for macOS with few differences, mostly around unimplemented features like user location tracking. diff --git a/platform/macos/docs/guides/Info.plist Keys.md b/platform/macos/docs/guides/Info.plist Keys.md index f61ad8c7a7..2c75ca88c7 100644 --- a/platform/macos/docs/guides/Info.plist Keys.md +++ b/platform/macos/docs/guides/Info.plist Keys.md @@ -1,6 +1,6 @@ # Info.plist Keys -The Mapbox macOS SDK supports custom `Info.plist` keys in your application in order to configure various settings. +The Mapbox Maps SDK for macOS supports custom `Info.plist` keys in your application in order to configure various settings. ## MGLMapboxAccessToken |