-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #142 from rekjuh/develop
Minor edits to texts of Contribute, Download, Discover pages + URLs to Getting Started
- Loading branch information
Showing
7 changed files
with
96 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,89 @@ | ||
| # Adding map layers manually | ||
| # Adding and deleting data providers | ||
|
|
||
| Before adding any map layers there must be at least one dataprovider and one theme. Look at Dataprovider and Theme for information. | ||
| Before you can add any map layers to the service, you must have at least one data provider and theme. | ||
|
|
||
| Open map layers, press + -symbol and choose Add a new map layer. Choose the type for the map layer. | ||
| Add data provider from **Map Layers**. Click the **+** symbol and **Add data provider**. Give the data provider a name in all the desired languages and a description if needed. Then click **Add**. | ||
|
|
||
| Input the map layer’s interface URL and if necessary username and password. Choose the interface version. Later, it’s told which version is used for which interface. | ||
| Data providers can be edited when map layers are sorted by Data Provider. Click the pen icon on the right and do the necessary changes. Remember to **Save** the changes. | ||
|
|
||
| Fill in the unique name of the map layer, which comes from the interface. Give the map layer a name and optionally a description for every desired language. | ||
| Click the **Delete** button if you want to remove a data provider. There must not be any map layers in the data provider's group for it to be able to be deleted. | ||
|
|
||
| Choose a dataprovider and theme from Select groups for the map layer. | ||
| # Adding and deleting themes | ||
|
|
||
| Opacity and scale are changed in the Visualization tab. Different map layer types have differences in visualization that are expanded on later. | ||
| Before you can add any map layers to the service, you must have at least one theme and data provider. | ||
|
|
||
| Metadata input is in the Additional tab if the map layer has any. | ||
| Add theme from **Map Layers**. Click **+** and **Add theme**. Give the theme a name in all the desired languages and a description if needed. Finally click the **Add** button. | ||
|
|
||
| Permissions are given to roles that are given to users and not to the users directly. Always give the admin role at least viewing permission and other roles the desired permissions. These are view, view in embedded map, publish and download. | ||
| Theme can be edited when map layers are sorted by theme. Click the pen icon on the right and do the necessary changes. Remember to **Save** the changes. | ||
|
|
||
| When done with configuration, press the Add-button at the bottom of the window. If the Close-button or X-button are pressed, the window will close and not save anything. Sometimes there might be some error popups, but they are not always problems that hinder the adding or viewing of the map, but it’s recommended to read its content and do the necessary adjustments. | ||
| If you want to remove a theme, click **Delete**. There must not be any map layers in the theme for it to be able to be deleted. | ||
|
|
||
| # Editing and deleting of map layers | ||
| # Adding map layers | ||
|
|
||
| Map layers can be edited by pressing the pen icon before its name. | ||
| Before adding any map layers there must be at least one data provider and one theme. Look at **Data provider** and **Theme** for information. | ||
|
|
||
| Edit the map layer as you like and press the save button at the bottom. If you don’t want to keep the changes, you can press the close button at the bottom or the x at the top right corner. | ||
| Open map layers, click the **+** symbol and choose **Add a new map layer**. Choose a type for the map layer. | ||
|
|
||
| If you want to completely delete a map layer, press the Delete button. Sometimes it's only necessary to remove permissions from map layers from roles other than admin. Before deleting a map layer it’s good to think if someone is using the map layer in a published map or will it be needed later. | ||
| Add the map layer’s API URL and, if necessary, an username and password Choose the version of the interface. For vector data the common version is 1.1.0. | ||
|
|
||
| Pressing the Add a new layer from the same service button opens a list of all the map layers of that same interface where it is easier to add map layers. Check that all of the information is correct before adding the map layer. | ||
| Fill in the unique name of the map layer which comes from the interface. You can add a description in every desired language. | ||
|
|
||
| # Different map layer types | ||
| Choose a data provider and theme from **Select groups for the map layer**. | ||
|
|
||
| WFS/OAPIF layers are vector type layers. Their common version is 1.1.0. Vector type layers can be defined to have a style made in the editor or added with JSON code. The style can be modified for point, line and area depending on the map layer. | ||
| Clicking the **Add a new layer** from the same service button opens a list of all the map layers of that same interface. Check that all of the information is correct before adding the map layer. | ||
|
|
||
| # Data provider | ||
| # Changing visualisation of a map layer | ||
|
|
||
| Add data provider from Map Layers and pressing + symbol and Add dataprovider. Give the data provider a name with all the desired languages and a description if needed. Lastly press the Add button. | ||
| Opacity and scale are changed in the **Visualization tab**. Different map layer types have differences in visualization. | ||
|
|
||
| Data providers can be edited when map layers are sorted by Data Provider. Press the pen icon on the right and do the necessary changes. Lastly press the Save button. | ||
| Vector type layers can be defined to have a style made in the editor or added with JSON code. The style can be modified for point, line and polygon (area) depending on the map layer. Vector type layers include WFS / OAPIF layers. | ||
|
|
||
| Press the Delete button if you want to remove the data provider. There must not be any map layers in the data provider for it to be able to be deleted. | ||
| Raster type layers include WMS layers. They come from the API usually "as is", meaning that their visualisation cannot usually be changed. | ||
|
|
||
| # Theme | ||
| # Adding metadata to the map layer | ||
|
|
||
| Add theme from Map Layers and pressing + symbol and Add theme. Give the theme a name with all the desired languages and a description if needed. Lastly press the Add button | ||
| Metadata input can be found in the **Additional tab**. Oskari displays metadata from a separate metadata page. | ||
|
|
||
| Theme can be edited when map layers are sorted by Theme. Press the pen icon on the right and do the necessary changes. Lastly press the Save button. | ||
| # Editing and deleting of map layers | ||
|
|
||
| Press the Delete button if you want to remove the theme. There must not be any map layers in the theme for it to be able to be deleted. | ||
| A map layer can be edited by clicking the pen icon before its name. | ||
|
|
||
| # Announcements | ||
| Edit the map layer as you like and finally click **Save** at the bottom of the window. If you don’t want to keep the changes just close the window by clicking **Close** at the bottom of the window or **X** at the top right corner of the window. | ||
|
|
||
| Announcements show current, upcoming and outdated announcements together with making new ones. | ||
| If you want to completely delete a map layer, click the **Delete** button. Sometimes deleting isn't necessary, and you can just remove viewing permissions to the desired map layer from roles other than admin. | ||
|
|
||
| There are two types of announcements: banner and pop-up. When adding a new announcement, you must specify the time and what type of announcement it is. The types are Title only, Title and contents, and Title and external link. Add a title and alternatively contents or an external link if needed for every language. | ||
| Note that someone might be using the map layer in an embedded map. By deleting the layer it will also become unavailable in the embedded map. | ||
|
|
||
| You can preview, edit or delete announcements from the icons at the right of the window. Remember to press the Save button when you have done the desired changes. | ||
| # Users | ||
|
|
||
| # Layer rights | ||
| In the **Users** tab you can see a list of all users. This is where you can search for users, modify their information or delete them. When editing the data, you can change the user's nickname, first and last name and email, but these should not be touched without the user's permission/knowledge. This is where roles are added to the users. | ||
|
|
||
| In layer rights, you can update the rights of the roles for each layer. If there are several pages of different layers, it is possible to search for the layer for which you want to update the rights. | ||
| ## Roles | ||
|
|
||
| # Users | ||
| Users are given **roles** and different roles can be given different **permissions** to the map layers. The same role can be given to various users, making it possible to have user groups with the same permissions. | ||
|
|
||
| In the Users tab, you can see a list of all users. This is where you can search for users, modify their information or delete them. When editing the data, you can change the user's nickname, first and last name, and email, but these should not be touched without the user's permission/knowledge. This is where roles are added to the users. | ||
| The permissions that can be granted to map layers are view, view in an embedded map, publish and download. | ||
|
|
||
| In the Roles tab, you can add new roles and edit the names of old ones, as well as delete roles. Among the users of the role, you can see a list of users who own a certain role. By default, the roles have an admin-level role and a user-level role. | ||
| In the **Roles** tab you can create new roles, edit the names of old ones, as well as delete roles. By default, the roles have an admin role or an user role. | ||
|
|
||
| Users by role tab show which users has a specific role | ||
| **Users by role** tab show which users has a specific role. | ||
|
|
||
| # Administration | ||
| When you have configured a new role click the **Add** button at the bottom of the window. The changes will not be saved if you click the **Close** or **X** buttons. Should there be any pop up windows warning of an error, act accordingly to resolve the issues. | ||
|
|
||
| In administration, you can set different views and the default view.(?) | ||
| # Layer rights | ||
|
|
||
| In layer rights, you can update the rights of the roles for each layer. If there are several pages of different layers, it is possible to search for the layer for which you want to update the rights. | ||
|
|
||
| # Layer monitoring | ||
|
|
||
| In layer monitoring, you can see a list of all levels and their information about ID, name, data provider, type, total screens and incorrect screens. By clicking on the name of the information, you can arrange the information in descending/ascending order. Here you can also edit the level or delete it. | ||
|
|
||
| By clicking on the name of the map layer, you can see more detailed information about its openings. Here you can see the number of successful and failed openings, at what time interval these have occurred and the map layer on the map where the error occurred. | ||
|
|
||
| # Announcements | ||
|
|
||
| **Announcements** tab shows current, upcoming and outdated announcements together with making new ones. | ||
|
|
||
| There are two types of announcements: banner and pop-up. When adding a new announcement, you must specify the time for the announcement and what type of announcement it is. The types are Title only, Title and contents, and Title and external link. Add a title and possible other contents for every language your map service uses. | ||
|
|
||
| You can preview, edit or delete announcements from the icons at the right of the window. Remember to click the **Save** button when you have done the desired changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,23 @@ | ||
| # How do I get the license for Oskari? | ||
| # How much does Oskari cost? | ||
|
|
||
| The source code for Oskari is open source. It is being kept flexible in order to broaden it with new components, use it with different service platforms and for changing the software libraries if needed. The UI supports multilingualism and there are already multiple languages translated. All source code is being published with [MIT/EUPL licenses](https://github.com/oskariorg/oskari-docs/blob/master/documents/LICENSE-MIT.txt). | ||
| The open source code is available free of charge. | ||
|
|
||
| # How much does Oskari cost? | ||
| # How do I get the license for Oskari? | ||
|
|
||
| The source code for Oskari is open source. It is being kept flexible in order to broaden it with new components, use it with different service platforms and for changing the software libraries if needed. | ||
|
|
||
| The open source code is available free of charge! Oskari saves time and money. | ||
| The UI has multilingual support and there are already multiple languages translated. All source code is being published with [MIT/EUPL licenses](https://github.com/oskariorg/oskari-docs/blob/master/documents/LICENSE-MIT.txt). | ||
|
|
||
| # How do I create embedded maps from Oskari? | ||
|
|
||
| If you don’t want to set up Oskari installation, don’t worry you can still enjoy the ride. You can build fancy & tailored map views based on Published maps functionality in Oskari. This requires an Oskari installation that has enabled the Published map functionality. If you are registered to the Oskari site you want to use, add the map layers you need to the map and click Published maps. Follow the instructions and embedd the iframe code you get in the end to your website. | ||
| If you don’t want to set up your own Oskari installation, you can build map views with the **Published maps** functionality in Oskari. This requires an Oskari installation that has enabled the Published map functionality. | ||
|
|
||
| If you are registered to the Oskari site you want to use, add the map layers you need to the map and click **Published maps**. Follow the instructions. You will get and iframe code that you can embed to your web site. | ||
|
|
||
| # Why are there no layers in an embedded map? | ||
|
|
||
| Check access rights. It might be that users with guest-role (most of the people looking at embedded maps) don't have permission to see layers included in the embedded map. | ||
|
|
||
| # How do I tailor my embedded maps? | ||
|
|
||
| Embedded maps can be tweaked to be in contact with your web site and provide more information to users using code snippets called RPC (Remote Process Call). So you can get the map to talk with your site. See the RPC example codes or follow the workshop example. | ||
| Embedded maps can be tweaked to be in contact with your web site and provide more information to users using code snippets called RPC (Remote Process Call). See [the RPC example codes.](https://oskari.org/examples/rpc-api/) |
Oops, something went wrong.