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..1trueDisable the use of categories
groupsboolean0..1trueDisable the use of groups





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

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
languagexml
<?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
languagexml
titleDefault bookmark tool
<item action="weave.bookmark"/>

...

Code Block
languagexml
titleBookmarks with single level of folders (removing the categories)
<item action="weave.bookmark" categories="false"/>

...