Documentation Center

Admin.XMLCollectiveSpacesConfiguration.xml

The Admin.XMLCollectiveSpacesConfiguration.xml file is used to configure the behavior of the Collective Spaces user interface: Draft Space and Review Space.

Changelog

File versionContent Manager versionNotes
1.014.0.0Introduction of the file
1.014.0.1No changes
1.014.0.2Adding Review Space configuration section
1.014.0.3Adding Common Settings Annotation Resolution Comment and Relationship Table
1.015.0.0Adding setting to the reviewspacesettings section

Overview

The Collective Spaces user interface (Draft Space and Review Space) enable authors to write, and reviewers to review, content, respectively.

To access this configuration file in Organize Space, select the Settings tab, then the XML Settings subtab, and then the Collective Spaces subsubtab.

XML elements

The XML elements perform the following functions :

<commonsettings>
Contains settings that apply to both interfaces. This section can contain the following optional configurations:
  • The annotationresolutioncomment element has a required attribute (with yes/no value) and can be used to specify whether the user that is resolving an annotation should provide a value in the resolution comment field or not. When this element is not provided, the default no is used.
  • The relationshiptable element has an enabled attribute (with yes/no value) and can be used to specify whether relationship tables in the DITA maps should be shown or not. When this element is not provided, the default no is used.
Here is an example of a commonsettings section:
<draftspacesettings>
  <annotationresolutioncomment required="yes"/>
  <relationshiptable enabled="yes"/>
</draftspacesettings>
<draftspacesettings>
Contains settings for Draft Space, including the following:
  • The imageupload section configure image uploads. The imageupload element has an enabled attribute, to enable (value yes) or prevent (value no) uploading of images. If allowed, then by default, images are uploaded in the resolution set as Preview resolution. To override this default, include a preferredresolution subelement, with its ishvaluetype attribute set to element, value or id and with its value set to the element name, value or identifier, respectively, of your preferred resolution.
  • Draft Space can also make use of a statusestofocus section to configure which status(es) an actionable item can have. The statusestofocus element contains one or more status elements, each with an ishvaluetype attribute set to element, value or id and with its value set to the element name, value or identifier, respectively.

Here is an example of a draftspacesettings section:

<draftspacesettings>
  <imageupload enables="yes">
    <preferredresolution ishvaluetype="element">VRESHIGH</preferredresolution>
  </imageupload>
</draftspacesettings>
<reviewspacesettings>
Contains settings for Review Space, including the following:
  • The statusestofocus section configures which status(es) a reviewable item can have. The element contains one or more status elements, each with an ishvaluetype attribute set to element, value or id and with its value set to the element name, value or identifier, respectively. Only items with one of the configured statuses still need to be reviewed.

    The values of the statuses are listed under the sibling subsubtab Statuses. Note that statuses included in this configuration cannot be deleted from the list.

  • The attributespanel element configures the appearance of the Attributes pane in Review Space's side panel. The pane displays the XML attributes of the current DITA element.

    To display the pane, add the element to the configuration file with the enabled attribute's value set to yes. If this element is not included or it is included but explicitly set to no, the pane will be hidden.

Here is an example of a reviewspacesettings section:
<reviewspacesettings>
  <statusestofocus>
    <status ishvaluetype="element">VSTATUSTOBEREVIEWED</status>
    <status ishvaluetype="value">Legal review needed</status>
    <status ishvaluetype="id">5655</status>
  </statusestofocus>
  <attributespanel enabled ="yes"/>
</reviewspacesettings>