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 <reviewspacesettings> section for configuration specific to Review Space
1.014.0.3Adding <commonsettings> section with annotationresolutioncomment and relationshiptable elements
1.015.0.0Adding attributespanel element to the reviewspacesettings section
1.115.1.1Adding reviewResolution element to the <commonsettings> 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:
Element nameDescriptionDefault fallback value if omitted
annotationresolutioncommentSpecifies through a required attribute whether the user who is resolving an annotation must provide a value in the resolution comment field (value yes) or not (value no).no
relationshiptableSpecifies through an enabled attribute whether the relationship tables in the DITA maps should be shown (value yes) or not (value no).no
reviewResolutionSpecifies the image resolution that is used in Collective Spaces whenever a user chooses the option to view an image in the review resolution.
The ishvaluetype attribute specifies whether the resolution is given as its unique identifier (value id), its element name (value element) or its name (value value). For example:
  • <reviewResolution ishvaluetype="value">High</reviewResolution> specifies that the resolution whose name is "High" must be used.
  • <reviewResolution ishvaluetype="element">VRESLOW</reviewResolution> specifies that the resolution whose element name is "VRESLOW" must be used.
The value configured for Preview resolution, as found under Settings > System > Default Settings in Organize Space.

Here is an example of a commonsettings section:

<commonsettings>
  <annotationresolutioncomment required="yes"/>
  <relationshiptable enabled="yes"/>
  <reviewResolution ishvaluetype="value">Low</reviewResolution>
</commonsettings>
<draftspacesettings>
Contains settings for Draft Space, including the following:
Element nameDescriptionDefault fallback value if omitted
imageupload and preferredresolutionThe imageupload section configures 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.

The value configured for Preview resolution, as found under Settings > System > Default Settings in Organize Space.
statusestofocus and statusThe statusestofocus section configures which status(es) an actionable item can have in Draft Space.

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:
Element nameDescriptionDefault fallback value if omitted
statusestofocus and statusThe statusestofocus section configures which status(es) a reviewable 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. 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.

 
attributespanelConfigures the appearance of the Attributes pane in Review Space's side panel, which 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.

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>