Added new version details

Dorset-Council-UK · Apr 11, 2024 · bd04f41 · bd04f41
1 parent 6aec47e
commit bd04f41
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/docs/db/versions.md b/docs/db/versions.md
@@ -30,6 +30,10 @@ The `Versions` table contains all the basic information about a version of GIFra
 - `FeedbackURL` - An optional URL to a feedback form. A link will be put in the header of GIFramework Maps if this URL is filled in. If left blank, no feedback link will be generated.
 - `TourDetailsId` - The `Id` of a `TourDetails` to use in this version. Leave blank for no tour.
 - `ShowLogin` - A boolean indicating whether to show a login button on the version. If a user is already logged in, the account box will still always show, regardless of this setting
+- `VersionNotes` - An optional text area to record any notes about the version. These are only seen by admin and cannot be seen by users.
+- `FeaturedVersion` - A boolean indicating whether to show a version in the 'Featured versions' area on the versions home page. Leaving this unchecked will put the version with 'All versions' underneath.
+- `VersionImageURL` - An optional URL to an image that will show on a version's card on the version home page. If a URL is not supplied, a default image of the world will be used.
+- `Hidden` - A boolean indicating whether to hide a version from the versions home page (this will not delete a version or stop it being accessed directly by its URL).
 
 #### Slugs
 

diff --git a/docs/db/web-service-definitions.md b/docs/db/web-service-definitions.md
@@ -18,7 +18,6 @@ This table contains the details of each web service that is available to users.
 - `Type` - The type of service. Currently only `WMS` is supported
 - `Version` - The version of the service. Leave blank and it will use version 1.1.0
 - `Category` - A category to group the list by. All services with the same category will be grouped in the select list presented to users
-- `SortOrder` - The order the service appears in the list. Services are first grouped by category, then ordered
 - `ProxyMapRequests` - A boolean indicating whether all `GetMap` requests for layers added by this service will be proxied by the [application proxy](../db/proxy.md)
 - `ProxyMetaRequests` - A boolean indicating whether all metadata and feature requests for this service will be proxied by the [application proxy](../db/proxy.md)
 

diff --git a/docs/gui/system.md b/docs/gui/system.md
@@ -36,7 +36,6 @@ Select **Manage web layer service definitions** then **Add new web layer service
 - Type - the type of service. Currently only WMS is supported
 - Version - the version of the service. Leave blank and it will use version 1.1.0
 - Category - a category to group the list by. All services with the same category will be grouped in the select list presented to users
-- Sort order - the order the service appears in the list. Services are first grouped by category, then ordered
 - Whether you want to enable proxy map requests - only tick this if the layer can't be used with [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
 - Whether you want to enable proxy metadata requests - only tick this if the layer can't be used with [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
 

diff --git a/docs/gui/versions.md b/docs/gui/versions.md
@@ -16,9 +16,12 @@ Select **Create new version** and fill in the details:
 - Welcome message (optional) - the [welcome message](../gui/welcome-messages.md) you want your version to use
 - Tour (optional) -  the [tour](../gui/tours.md) you want your version to use
 - Show login option - choose whether you want to show an option for users to login
+- Show as a featured version - choose whether you want the version to be featured at the top of the version home page. Leaving this unchecked will put the version with all other versions underneath
+- Hide from version home page - choose if you want to hide the version on the version home page (if you hide a version, it can still be accessed directly by its URL)
 - Help URL (optional) - include a link to custom documentation
 - Feedback URL (optional) - include a link to a feedback form
 - Redirection URL (optional) - a URL to redirect the user to instead of loading the version. Can be useful if a version changes slug, or you want to point people elsewhere
+- Version image URL (optional) - include a URL to an image to use on the version home page. Leaving this blank will use a default image of the world instead
 - Purge cache - ticking this box will purge the cache and allow your version to be available for testing or use straight away
 
 On the right side of the screen, you'll see options for: