This content is archived. See latest version here.

Last updated: Mar 25 2013

Introduction

This document describes the syntax used when explaining the various configuration sections and elements of EPiServer CMS. Each configuration sub-element is described in two different ways: a pseudo XML structure showing the hierarchy and including all attributes, and a set of tables describing each element's attributes in more detail.

Please refer to Configuration Overview section for a general description of the configuration structure in EPiServer CMS.

Pseudo XML Structure

  • (Obsolete elements and attributes) written within parentheses.
  • The type of the attribute value is listed as the value, in other words stringAttribute="string".
  • Elements and attributes are listed in alphabetical order.
  • Element collections are indicated by "..." at the same level as the repeatable element.

Example:

XML
<someElement>
   <optionalCollectionElement>
      <add optionalAttribute="valueType"
           requiredAttribute="valueType" />
      ...
   </optionalCollectionElement>
   <optionalElement (obsoleteAttribute="valueType")
                    optionalAttribute="valueType"
                    requiredAttribute="valueType" />
   <requiredElement (obsoleteAttribute="valueType")
                    optionalAttribute="valueType"
                    requiredAttribute="valueType" />
</someElement>

Attribute Tables

More detailed descriptions of attributes are displayed in table format, one table for each element.

  • Attributes are listed with name, default value and description.
  • Attributes are listed in alphabetical order.
  • An empty Default Value column indicates that there is no default value.

Example:

<requiredElement/>Element Attributes

Name Default Value Description
(obsoleteAttribute)   Description of obsoleteAttribute.
optionalAttribute A default value Description of optionalAttribute.
requiredAttribute Another default >value Required. Description of requiredAttribute.

Comments