Client Actions Bookmarks - Standard Bookmark Action

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	data definition	0..1		Data definition proividing list of first level groups for published bookmarks
groups	data definition	0..1		Data definition providing list of second level groups for published bookmarks

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

Examples

Grouping published bookmarks

To group published bookmarks under sub-menus you need to create one or two data definition, depending upon how many levels you're after, that contain the list of groups that should be available.

Categories are the top level groupings and the groups are the second level.

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(?).

Bookmark grouping data definitions

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#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">

	<data:datadefinition id="bookmark_category">
		<inlinedataconnection>
			<parameter type="string" name="label" label="Label"/>
			<parameter type="string" name="value" label="Value"/>
			<row>
				<cell>Corporate</cell>
				<cell>Corporate</cell>
			</row>
			<row>
				<cell>Environment</cell>
				<cell>Environment</cell>
			</row>
			<row>
				<cell>Front Desk</cell>
				<cell>Front Desk</cell>
			</row>
			<row>
				<cell>Projects</cell>
				<cell>Projects</cell>
			</row>
		</inlinedataconnection>
	</data:datadefinition>

	<data:datadefinition id="bookmark_group">
		<inlinedataconnection>
			<parameter type="string" name="label" label="Label"/>
			<parameter type="string" name="value" label="Value"/>
			<row>
				<cell>Assets</cell>
				<cell>Assets</cell>
			</row>
			<row>
				<cell>External</cell>
				<cell>External</cell>
			</row>
			<row>
				<cell>Finance</cell>
				<cell>Finance</cell>
			</row>
			<row>
				<cell>Internal</cell>
				<cell>Internal</cell>
			</row>
			<row>
				<cell>Property</cell>
				<cell>Property</cell>
			</row>
			<row>
				<cell>Works</cell>
				<cell>Works</cell>
			</row>
		</inlinedataconnection>
	</data:datadefinition>
</config>

Bookmark action examples

Default bookmark tool

<item action="weave.bookmark"/>

Bookmarks with single level of grouping

<item action="weave.bookmark" categories="bookmark_category"/>

Bookmarks with two levels of grouping

<item action="weave.bookmark" categories="bookmark_category" groups="bookmark_groups"/>