Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ID

weave.bookmark

Sub-tags


Name

Type

Cardinality

Default

Description

extent

boolean

0..1

true

Should the current extent be includable in the bookmark

layersboolean0..1trueShould the current ToC content be includable in the bookmark
redlinesboolean0..1trueShould the current redlines be includable in the bookmark
entityboolean0..1trueShould the current active entity be includable in the bookmark
selectionboolean0..1trueShould the selection for the active entity be includable in the bookmark





categoriesboolean0..1true

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, refardless of it being set to true or false.

groupsboolean0..1true

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.






baseUrlURL0..1
Overwrite base URL when generating a shred bookmark, will use the URL used to start the client if not specified





createboolean0..1trueShould the "Create Bookmark" option be included in the menu
publishboolean0..1trueShould the "Create Publish Bookmark" option be included in the menu, default to false if user is anonymous
shareboolean0..1trueShould the "Create Shared Bookmark" option be included in the menu, default to false if user is anonymous
publishedboolean0..1trueShould the published bookmarks be included in the menu
manageboolean0..1trueShould the "Manage Bookmarks" option be included in the menu





warningboolean0..1trueShould delete actions be verified
groupedboolean0..1false

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

...

Code Block
languagexml
titleDefault bookmark tool (if the bookmark config contains settings for categories and/or group they will be used, if it doesn't then they won't be used)
<item action="weave.bookmark"/>

...

Code Block
languagexml
titleDisable the use of categories in the tool (only of use if you've configured a data definition for categories but don't want to use it)
<item action="weave.bookmark" categories="false"/>

...

Code Block
languagexml
titleDisable any folders in bookmarks (only of use if you've defined data definition for categories and groups in the bookmar config but don't want to use them)
<item action="weave.bookmark" categories="false" groups="false"/>

...