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 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





categoriesdata definition0..1
Data definition proividing providing list of first level groups for published bookmarks
groupsdata definition0..1
Data definition providing list of second level groups for published bookmarks





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 this makes the examples clearer(?)their use here makes it easier to follow this example.

Bookmark grouping data definitions

...

Code Block
languagexml
titleBookmarks with two levels of grouping
<item action="weave.bookmark" categories="bookmark_category" groups="bookmark_groupsgroup"/>