Geolocation Specific Content is an Oomph 18 feature. Please ensure your app supports Oomph 18 before using this feature. Oomph v18.0.2+ ONLY supports localisations within Australia. Future versions will include other countries. NOTE: In Oomph v18.0.2 the geolocation feature is INCOMPATIBLE with the language content localisation feature. They cannot be used together in the same section at this time.
Geolocalisation allows content to be provided specific to readers in certain geographical areas, Oomph then renders the appropriate content based on the user's preference. It operates in a similar manner to language localisation, but is geography based instead of language based.
A geolocation designator is specified as a country code (e.g.
AU) plus an optional principal subdivision (i.e. province or state e.g.
NSW). By default the geolocation is automatically discovered by using the GPS on the device. The GPS is enabled when a publication containing geo-specific content is first opened, and is switched off again as soon as the location has been determined to within a suitable accuracy in order to save battery. If the app is closed and re-opened while viewing the same publication, the GPS will again be enabled briefly to check if the location has changed. In the absence of a GPS signal or in Airplane mode, the last known location is remembered.
Oomph also provides an in-app override to allow the user to select a specific location manually.
The codes used for geolocation identifiers are derived from the ISO 3166 standard. Part 1 ISO 3166-1 is the country codes, part 2 ISO 3166-2 contains the subdivisions (e.g. states/provinces). More information can be found here: http://en.wikipedia.org/wiki/ISO_3166
Oomph will render geo-specific content as follows:
- Oomph will render content based on the enclosing GPS position. For example if the device is determined to be located in Goombungee, it will prefer content designated for Queensland, Australia i.e. AU-QLD.
- If state/province specific content is unavailable, it will fallback to the generic country content if it has been provided e.g. AU.
- If the GPS determines a position in a country for which no content has been specified, the base/default content will be shown.
Oomph also provides a way to locally override the automatic GPS position from within the app. This setting is available from the toolbar at the top of the screen (accessible with a single-tap) which presents the user with a menu of available location specific content.
Only the locations available within the content are shown, for example if Queensland and New South Wales localisations are available the menu will contain:
Before you produce your localised content, you should first produce the “base” or default content (as you would for pre-Oomph v18 content). This is the content that is shown when the device is in a location for which no content has been provided. For example if you provide Queensland and New South Wales localisations, a Tasmanian reader will see the base content.
You must provide base content, if you do not and only provide localised content, then the readers for whom you provide no localisations for will be shown no content!
After you've authored your base content, you can produce the localised versions. You place your localised content either under the section or widget you're localising. At each of these levels, localised content is placed within a folder, this folder has a name which matches the country code, and may optionally include a subdivision code. You do not need to include a subdivision code, you should only add it if you wish to provide additional specificity for local readers.
Consider the following folder names:
AU- Australia (includes all states)
AU-NSW- Australia, New South Wales
AU-QLD- Australia, Queensland
Full details of the country & subdivision codes can be found in understanding_geolocations above. Note that a hyphen must be used to separate the language from the region code. Do not include the hyphen if you do not specify a region, for example
AU- is invalid, use just
For example QUeensland content for the
Cover section will live in the folder
10-Cover/AU-QLD/, the first page will be
10-Cover/AU-QLD/P1-1.pdf. Similarly, Victorian content for a Vertical In Page Slideshow will be in