A Bookmark represents a map extent and map state that is saved and retrievable. A Bookmark stores the map extent and map layers that are displayed when the Bookmark was created; A Bookmark may also store any Redlines that exist on the map, the existing Active Layer, as well as the existing Active Layer's selection is used to store the state of a Weave map. The following map properties are stored as part of the map state : map extent, visible layers, active entity, existing redlines and selected features (from version 2.5 29). Effectively, Bookmarks may be used to highlight specific areas on your map that you want others to be able to easily access.The Standard Bookmark tool allows Bookmarks to be created, published, shared and managed; It is declared in the client When a bookmark is created, the user gives the bookmark a name and nominates the map properties that are to be stored with the bookmark :
Once created, the bookmark is added to the set of bookmarks listed in the Bookmarks Menu, and is therefore able to be returned to via subsequent nomination from the menu:
Bookmarks are therefore a useful way of storing previous map analysis, and they are useful for making specific extents and data on the map, readily accessible.
Including the Standard Bookmark tool in a Weave client adds the Bookmarks Menu control to the client interface, thus providing the Create, Publish, Share and Manage Bookmarks menu options. The Standard Bookmark tool is declared with the XML :<item action="weave.bookmark" />
Bookmarks are either private to the user who created them, or they may be published, to which will thus be make them available to all users of the subject Weave client, to access.
When a user selects the Create Bookmark menu option, a private bookmark is created; The user then assigns the bookmark a name, and a new bookmark entry is then added to the user’s Bookmark menu.
A user interface guide to using the Create Bookmark menu option is available here : https://cohgawiki.atlassian.net/wiki/spaces/WUG/pages/3248145/Create+BookmarkThe Publish Bookmark menu option is used to create a bookmark that is available to all users of the subject Weave client.
The Publish Bookmark menu option allows a nominated bookmark to be published.
Published bookmarks may be optionally organised using Categories and Groups; Categories and groupsGroups effectively allow published bookmarks to be organised in to a hierarchical structure within the Bookmarks menu.
The Share Bookmark menu option is used to create a URL representing a bookmark. The created URL will open Weave and display the saved properties of the bookmark (map extent, layers, active entity, selection and redlines).This option is therefore useful for sharing a Weave bookmark analysis outside the Weave environment. For example, via an email.
The ability to share a bookmark was introduced to Weave in version 2.5.29.
The Manage Bookmarks menu option opens a form that is used to modify the properties of existing Private, Published and Shared bookmarks.
Bookmarks and their properties are stored within a browser’s profile settings, for a subject user.
A user interface guide to using the Create Bookmark menu option is available here : https://cohgawiki.atlassian.net/wiki/spaces/WUG/pages/3248145/Create+Bookmark
ID
weave.bookmark
Sub-tags
Name | Type | Cardinality | Default | Description |
|---|---|---|---|---|
extent | boolean | 0..1 | true | Should the current extent be includable in the bookmark? |
| layers | boolean | 0..1 | true | Should the current ToC content be includable in the bookmark? |
| redlines | boolean | 0..1 | true | Should the current redlines be includable in the bookmark? |
| entity | boolean | 0..1 | true | Should the current active entity be includable in the bookmark? |
| selection | boolean | 0..1 | true | Should the selection for the active entity be includable in the bookmark? |
| categories | boolean | 0..1 | true | Disable the use of categories. You only need to set this attribute (to false) if you have configured the bookmarks to include categories but you want to include one of the bookmark tools in a client without the categories. If you have not configured a data definition for the categories in the bookmark config then this flag will not do anything, regardless of it being set to true or false. |
| groups | boolean | 0..1 | true | Disable the use of groups, you only need to set this attribute (to false) if you have configured the bookmarks to include groups but you want to include one of the bookmark tools in a client without the groups. If you have not configured a data definition for the groups in the bookmark config then this flag will not do anything, regardless of it being set to true or false. |
| baseUrl | URL | 0..1 | Overwrite base URL when generating a shared bookmark. It will use the URL used to start the client if not specified. | |
| create | boolean | 0..1 | true | Should the "Create Bookmark" option be included in the menu? |
| publish | boolean | 0..1 | true - if the user is logged in | Should the "Publish Bookmark" option be included in the menu? Note that this also determines if the publishing functions are included in the Bookmark Manager unless the publisher flag is used to override it. |
| publisher | boolean | 0..1 | taken from | Should the publishing functionality be included in the Bookmark Manager? |
| published | boolean | 0..1 | true | Should the published bookmarks themselves be included in the menu? |
| share | boolean | 0..1 | true - if the user is logged in false - if the user is anonymous | Should the "Share Bookmark" option be included in the menu? |
| manage | boolean | 0..1 | true - if the user has persistent storage available false - if the user does not have persistent storage available | Should the "Manage Bookmarks" option be included in the menu? |
| warning | boolean | 0..1 | true | Should delete actions be verified? |
| grouped | boolean | 0..1 | false | Changes the way groups are displayed This pre-dates the addition of the |
- Persistent storage - If the user is logged in they will have persistent storage available. The information is sent to the server for storage against their user id, and so their bookmarks will be available from any browser the user logs in from. If, however, the user is not logged in, they may still have persistent storage available if their web browser supports it, which these days is more than likely. But it means that their bookmarks will only be available if they use the same browser that they created the bookmark in.
...
The following is an example of two inline data definitions that will contain the data definition used for the bookmark samples following it. They do not have to be inline data definitions, any data definition type will work, but their use here makes it easier to follow this example.
Bookmark grouping data definitions
...