Versions Compared

Key

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

ID

weave.publishedbookmark

...


Name

Type

Cardinality

Default

Description

categoriesdata definitionboolean0..1Data definition providing list of first level groups for published bookmarksgroupsdata definitiontrueSet to false to disable 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..1Data definition providing list of second level groups for published bookmarkstrueSet to false to disable 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.

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

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 their use here makes it easier to follow this example.

Bookmark grouping data definitions

Code Block
languagexml
<?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>


Info

The categories and groups used for this tool are configured via separate configuration items. This tool is directly configurable enough just to turn off the use of categories and groups, to configure the categories and groups themselves requires a separate configuration, an example of which can be seem on this page Client Actions Bookmarks - Standard Bookmark Action


Examples

Bookmark action examples

Code Block
languagexml
titleDefault bookmark tool (categories and/or groups will be used if they're defined in the bookmark config, or they won't be used if they're not defined)
<item action="weave.publishedbookmark"/>

...

Code Block
languagexml
titleBookmarks with single level of groupingDisable categories folder in bookmark menu (thus is only useful if you've defined the categories data definition in the bookmark config but don't want to use it for this particular instance of the tool)
<item action="weave.publishedbookmark" categories="bookmark_categoryfalse"/>


Code Block
languagexml
titleBookmarks with two levels of groupingDisable any folders in bookmarks (this is only useful if you've defined the categories and groups data definition in the bookmark config but don't want to use them for this particular instance of this tool)
<item action="weave.publishedbookmark" categories="bookmark_categoryfalse" groups="bookmark_groupsfalse"/>