Difference between revisions of "Property Groups definition"

Revision as of 08:53, 18 July 2011

Sometimes you want to add more information to a document, for example, you may want to add an internal code to the document for organization purposes and a description. OpenKM uses two files to describe this metadata: PropertyGroups.cnd and PropertyGroups.xml. The first one describes the properties to be added to the document node. This definition is used by Jackrabbit to retrieve and set these values. The second one is used by OpenKM to render the values described in the previous file.

For OpenKM 5.0 the property groups DTD is property-groups-1.1.dtd. For OpenKM 4.1 is property-groups-1.0.dtd.

See this sample:

PropertyGroups.cnd

<okm = 'http://www.openkm.org/1.0'>
<okg = 'http://www.openkm.org/group/1.0'>
<okp = 'http://www.openkm.org/group/property/1.0'>

[okg:consulting] mixin
- okp:consulting.code (string) = '' autocreated
- okp:consulting.comment (string) = '' autocreated

PropertyGroups.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 1.1//EN"
                                 "http://www.openkm.com/dtd/property-groups-1.1.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Code" type="text" name="okp:consulting.code" value="COD-0000" />
    <textarea label="Comment" name="okp:consulting.comment" value=""/>
  </property-group>
</property-groups>

Here we can see an XML which describes the "Consulting" property group with a couple of properties. In the description, we can see an INPUT where the user should type an internal code (with a default value of "COD-0000" and a comment which describes the document content.

As you can see in the XML DOCTYPE, there is a formal definition at http://www.openkm.com/dtd/property-groups-1.1.dtd.

If your OpenKM server can't access to Internet, you can download this DTD and copy to a conveniente place at you server. Remember to update your PropertyGroups.xml with the TDT location. <!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 1.1//EN" "file:///path/to/property-groups-1.1.dtd">

But let's see which components it can handle:

Input

Used to enter free form text:

• label: The text which describes the component. Required.
• name: This value is used to access the value typed by the user. Required.
• type: This value constrain value type. Allowed types: text, date, link or folder.
• value: Here you can specify a default value for this component.
• width: The width of the component. Defaults to browser default HTML input width.
• height: The height of the component. Defaults to browser default HTML input height.

TextArea

Similar to Input but for bigger text:

• label: The text which describes the component. Required.
• name: This value is used to access the value typed by the user. Required.
• value: Here you can specify a default value for this component.
• width: The width of the component. Defaults to 300px.
• height: The height of the component. Defaults to 100px.

Select

In this case, the value can be selected from a list of predefined one. Every select component can contain an arbitrary number of options bigger than one.

• label: The text which describes the component. Required.
• name: This value is used to access the value selected by the user. Required.
• type: Actually can be only "simple". Simple means that only one option can be selected at a time. Defaults to "simple".
• width: The width of the component. Defaults to browser default HTML select width.
• height: The height of the component. Defaults to browser default HTML select height.

Option

• label: The text which describes the component. Required.
• value: This is the value of the option to be selected. Required.
• selected: Can be "true" or "false". Indicates if the option is selected by default or not. Defaults to "false".