diff --git a/docs/assets/file/config.json b/docs/assets/file/config.json index 8086cf1a9..781d1a417 100644 --- a/docs/assets/file/config.json +++ b/docs/assets/file/config.json @@ -626,10 +626,19 @@ "booking": true, "bookmark_mode": { "enabled": true, - "display": { - "bss": true, - "journeys": true, - "stations": true + "tabs": { + "bss": { + "display": true, + "title_res": "" + }, + "journeys": { + "display": true, + "title_res": "" + }, + "stations": { + "display": true, + "title_res": "" + } } }, "default_location": { @@ -668,9 +677,21 @@ }, "schedule_mode": true, "tabs": { - "transports": true, + "transports": { + "enabled": true, + "sections": { + "stations_title_res": "", + "bss_stations_title_res": "", + "car_parking_title_res": "" + } + }, "journeys": true, - "addresses": true + "addresses": { + "enabled": true, + "sections": { + "places_title_res": "" + } + } } }, "journey": { @@ -735,6 +756,11 @@ } }, "go_from_go_to": true, + "line_name": { + "allowed_commercial_modes": [ + "" + ] + }, "max_history": 10, "networks_filter": true, "next_departures": { @@ -756,8 +782,11 @@ "disruption_contributors": [ "" ], - "networks_filter": true, - "transport_networks": true + "filters": true, + "transport_networks": true, + "forbidden_networks": [ + "" + ] } } -} \ No newline at end of file +} diff --git a/docs/bookmark/ios/index.md b/docs/bookmark/ios/index.md index fc8426bc2..2ee8a306b 100644 --- a/docs/bookmark/ios/index.md +++ b/docs/bookmark/ios/index.md @@ -65,7 +65,7 @@ You can also call the `initialize()` method with the global JSON configuration f do { try Bookmark.shared.initialize( token: "your_token", - configurationJsonFile: "aroundme_configuration.json" + configurationJsonFile: "bookmark_configuration.json" ) } catch { Logger.error("%@", String( diff --git a/docs/getting_started.md b/docs/getting_started.md index 5b0473a0f..0ce469ead 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -340,16 +340,23 @@ The following are the possible configuration parameters: | Name | Required | Description | Type | Example | | --- |:---:| --- | :---: | :---: | -| `enabled` | :material-close: | Enable/disable to add and remove an item as favorite | `Boolean` | `true` | -| `display` | :material-close: | Display options of favorite items on screen | [`Bookmark mode display options (Around Me)`](#bookmark-mode-display-options-around-me) | - | +| `enabled` | :material-check: | Enable/disable to add and remove an item as favorite | `Boolean` | `true` | +| `tabs` | :material-close: | | [`Bookmark mode tabs (Around me)`](#bookmark-mode-tabs-around-me) | - | + +##### Bookmark mode tabs (Around me) + +| Name | Required | Description | Type | Example | +| --- |:---:| --- | :---: | :---: | +| `bss` | :material-close: | Favorite bss tab configuration | [`Bookmark mode tab (Around me)`](#bookmark-mode-tab-around-me) | - | +| `journeys` | :material-close: | Favorite journeys tab configuration | [`Bookmark mode tab (Around me)`](#bookmark-mode-tab-around-me) | - | +| `stations` | :material-close: | Favorite stations tab configuration | [`Bookmark mode tab (Around me)`](#bookmark-mode-tab-around-me) | - | -##### Bookmark mode display options (Around Me) +##### Bookmark mode tab (Around me) | Name | Required | Description | Type | Example | | --- |:---:| --- | :---: | :---: | -| `bss` | :material-close: | Display/hide favorite bss tab | `Boolean` | `true` | -| `journeys` | :material-close: | Display/hide favorite journeys tab | `Boolean` | `true` | -| `stations` | :material-close: | Display/hide favorite stations tab | `Boolean` | `true` | +| `display` | :material-check: | Display/hide favorite tab | `Boolean` | `true` | +| `title_res` | :material-close: | Title resource name | `String` | `"tab_title"` | ##### Default location @@ -364,7 +371,7 @@ The following are the possible configuration parameters: | --- |:---:| --- | :---: | :---: | | `go_from_go_to` | :material-close: | Show/hide the go from/go to buttons | `Boolean` | `true` | | `next_departures` | :material-close: | Show/hide the next departures | [`Next departures`](#next-departures) | - | -| `park_availability`| :material-close: | Show/hide the bss and car parking availability | [`Park Availability`](#park-availability) | +| `park_availability`| :material-close: | Show/hide the bss and car parking availability | [`Park Availability`](#park-availability) | - | | `schedule_mode` | :material-close: | Show/hide the "See all schedules" button | `Boolean` | `true` | | `tabs` | :material-close: | Enable/disable tabs | [`Bookmark tabs`](#bookmark-tabs) | - | @@ -372,9 +379,30 @@ The following are the possible configuration parameters: | Name | Required | Description | Type | Example | | --- |:---:| --- | :---: | :---: | -| `transports` | :material-check: | Enable/disable transport tab | `Boolean` | `true` | -| `journeys` | :material-check: | Enable/disable journeys tab | `Boolean` | `true` | -| `addresses` | :material-check: | Enable/disable addresses tab | `Boolean` | `true` | +| `transports` | :material-close: | Transport tab configuration | [`Bookmark transports tab`](#bookmark-transports-tab) | - | +| `journeys` | :material-close: | Enable/disable journeys tab | `Boolean` | `true` | +| `addresses` | :material-close: | Addresses tab configuration | [`Bookmark addresses tab`](#bookmark-addresses-tab) | - | + +##### Bookmark transports tab + +| Name | Required | Description | Type | Example | +| --- |:---:| --- | :---: | :---: | +| `stations_title_res` | :material-close: | 'Stations' title resource name | `String` | `"stops"` | +| `bss_stations_title_res` | :material-close: | 'Bike sharing service stations' title resource name | `String` | `"bike_rental"` | +| `car_parking_title_res` | :material-close: | 'P+R parkings' title resource name | `String` | `"relay_parkings"` | + +##### Bookmark addresses tab + +| Name | Required | Description | Type | Example | +| --- |:---:| --- | :---: | :---: | +| `enabled` | :material-check: | Enable/disable addresses tab | `Boolean` | `true` | +| `sections` | :material-close: | Custom titles for the sections of this tab | [`Bookmark addresses tab sections`](#bookmark-addresses-tab-sections) | - | + +##### Bookmark addresses tab sections + +| Name | Required | Description | Type | Example | +| --- |:---:| --- | :---: | :---: | +| `places_title_res` | :material-close: | 'Places' title resource name | `String` | `"convenient_places"` | #### Journey features @@ -436,6 +464,7 @@ The following are the possible configuration parameters: | --- |:---:| --- | :---: | | `bookmark_mode` | :material-close: | Enable/disable the bookmarks feature | [`Bookmark mode`](#bookmark-mode-schedule) | | `go_from_go_to` | :material-close: | Show/hide the go from/go to buttons | `Boolean` | `true` | +| `line_name` | :material-close: | Show the name of the line | [`Line name`](#line-name-schedule) | | `max_history` | :material-close: | Define the max history items | `Int` | | `networks_filter` | :material-close: | Show/hide the networks selector | `Boolean` | | `next_departures` | :material-close: | Show/hide the next departures | [`Next departures`](#next-departures) | @@ -456,6 +485,12 @@ The following are the possible configuration parameters: | --- |:---:| --- | :---: | :---: | | `home` | :material-close: | Display/hide favorite items on home screen | `Boolean` | `true` | +##### Line Name (Schedule) + +| Name | Required | Description | Type | Example | +| --- |:---:| --- | :---: | :---: | +| `allowed_commerical_modes` | :material-close: | Define the list of commercial mode id allowed to show their name | `String[]` | `["commercial_mode:Train"]` | + #### Traffic features | Name | Required | Description | Type | Example | @@ -463,7 +498,8 @@ The following are the possible configuration parameters: | `alert_subscription` | :material-close: | Alert subscription environment configuration | [`Alert subscription`](#alert-subscription) | - | | `application_periods` | :material-close: | Show/hide the disruption application date | `Boolean` | | `disruption_contributors` | :material-close: | Define the list of disruption contributors id | `String[]` | `["shortterm.tr_idfm"]` | -| `networks_filter` | :material-close: | Show/hide the networks selector | `Boolean` | +| `filters` | :material-close: | Show/hide the filters selector | `Boolean` | +| `forbidden_networks` | :material-close: | Define the list of forbidden networkds | `String[]` | `["network:ABCD"]` | | `transport_networks` | :material-close: | Enable/disable showing network on lines | `Boolean` | - | ##### Alert subscription @@ -537,9 +573,9 @@ The following are the possible configuration parameters: | Name | Required | Description | Type | Platform | Example | | --- |:---:| --- | :---: | :---: | :---: | -| `font_res` | :material-check: | The font resource name | `String` | Android | `source_sans_pro_semi_bold` | -| `ttf_file` | :material-check: | The TTF file name | `String` | iOS | `"SourceSansPro"` | -| `font_name` | :material-check: | The font name | `String` | iOS | `"SourceSansPro-Bold"` | +| `font_res` | :material-check: | Font resource name | `String` | Android | `source_sans_pro_semi_bold` | +| `ttf_file` | :material-check: | TTF file name | `String` | iOS | `"SourceSansPro"` | +| `font_name` | :material-check: | Font name | `String` | iOS | `"SourceSansPro-Bold"` | ### Line resource