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 version | Content Manager version | Notes |
|---|---|---|
| 1.0 | 14.0.0 | Introduction of the file |
| 1.0 | 14.0.1 | No changes |
| 1.0 | 14.0.2 | Adding <reviewspacesettings> section for configuration specific to Review Space |
| 1.0 | 14.0.3 | Adding <commonsettings> section with annotationresolutioncomment and relationshiptable elements |
| 1.0 | 15.0.0 | Adding attributespanel element to the reviewspacesettings section |
| 1.1 | 15.1.1 | Adding 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 name Description Default fallback value if omitted annotationresolutioncommentSpecifies through a requiredattribute whether the user who is resolving an annotation must provide a value in the resolution comment field (valueyes) or not (valueno).norelationshiptableSpecifies through an enabledattribute whether the relationship tables in the DITA maps should be shown (valueyes) or not (valueno).noreviewResolutionSpecifies the image resolution that is used in Collective Spaces whenever a user chooses the option to view an image in the review resolution. Theishvaluetypeattribute specifies whether the resolution is given as its unique identifier (valueid), its element name (valueelement) or its name (valuevalue). 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 in Organize Space.
<draftspacesettings>-
Contains settings for Draft Space, including the following:
Element name Description Default fallback value if omitted imageuploadandpreferredresolutionThe imageuploadsection configures image uploads.The
imageuploadelement has anenabledattribute, to enable (valueyes) or prevent (valueno) uploading of images.If allowed, then by default, images are uploaded in the resolution set as Preview resolution. To override this default, include a
preferredresolutionsubelement, with itsishvaluetypeattribute set toelement,valueoridand 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 in Organize Space. statusestofocusandstatusThe statusestofocussection configures which status(es) an actionable item can have in Draft Space.The
statusestofocuselement contains one or morestatuselements, each with anishvaluetypeattribute set toelement,valueoridand with its value set to the element name, value or identifier, respectively.Here is an example of a
draftspacesettingssection:<draftspacesettings> <imageupload enables="yes"> <preferredresolution ishvaluetype="element">VRESHIGH</preferredresolution> </imageupload> </draftspacesettings>
<reviewspacesettings>-
Contains settings for Review Space, including the following:
Element name Description Default fallback value if omitted statusestofocusandstatusThe statusestofocussection configures which status(es) a reviewable item can have.The
statusestofocuselement contains one or morestatuselements, each with anishvaluetypeattribute set toelement,valueoridand 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
enabledattribute's value set toyes.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.