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 |
groups | boolean | 0..1 | true | Disable the use of groups |
baseUrl | URL | 0..1 | Overwrite base URL when generating a shred bookmark, 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 | Should the "Create Publish Bookmark" option be included in the menu, default to false if user is anonymous |
share | boolean | 0..1 | true | Should the "Create Shared Bookmark" option be included in the menu, default to false if user is anonymous |
published | boolean | 0..1 | true | Should the published bookmarks be included in the menu |
manage | boolean | 0..1 | true | 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 | Change the way groups are displayed This pre-dates the addition of the groups and categories properties (added in 2.5.29) and switches between grouping bookmarks based on the user id or just including the user id in the text. |
Examples
Grouping published bookmarks
...
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
The following example configuration file shows an entire file containing all the parts required to setup the bookmark category and grouping configuration which will the be used by any of the bookmark tools you add to the client. Note that this example is assuming that you'll be using both categories and groups, if you're only using one you only need to define one data definition and include that in the bookmarks:config
(either the categories
or groups
tag).
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <config xmlns="urn:com.cohga.server.config#1.0" xmlns:bookmarks="urn:com.cohga.weave.client.bookmarks#1.0" xmlns:data="urn:com.cohga.server.data.database#1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <bookmarks:config> <categories>bookmark_categories</categories> <groups>bookmark_groups</groups> </bookmarks:config> <data:datadefinition id="bookmark_categories"> <inlinedataconnection> <parameter type="string" name="label" label="Label"/> <row> <cell>Corporate</cell> </row> <row> <cell>Environment</cell> </row> <row> <cell>Front Desk</cell> </row> <row> <cell>Projects</cell> </row> </inlinedataconnection> </data:datadefinition> <data:datadefinition id="bookmark_groups"> <inlinedataconnection> <parameter type="string" name="label" label="Label"/> <row> <cell>Assets</cell> </row> <row> <cell>External</cell> </row> <row> <cell>Finance</cell> </row> <row> <cell>Internal</cell> </row> <row> <cell>Property</cell> </row> <row> <cell>Works</cell> </row> </inlinedataconnection> </data:datadefinition> </config> |
Bookmark action examples
These example are just snippets showing what would need to be added to a client config to include the bookmark tool in a client toolbar. The category and grouping information is provided by the configuration example above, but the tools can also be configured using the attributes defined in the table above.
Code Block | ||||
---|---|---|---|---|
| ||||
<item action="weave.bookmark"/> |
...
Code Block | ||||
---|---|---|---|---|
| ||||
<item action="weave.bookmark" categories="false"/> |
...