Configuration Options¶

There are a number of User TSconfig and Page TSconfig properties related to workspaces.

Note

Some of these options are actually handled by the "version" system extension, but apply to workspaces.

Page TSconfig
User TSconfig
- options.workspaces

Page TSconfig ¶

workspaces ¶

splitPreviewModes ¶

Data type

String

Description

Comma-separated list of allowed values for preview modes. Possible values are "slider", "vbox" and "hbox".

Example

workspaces.splitPreviewModes = slider

will restrict the preview mode to "slider".

Default

slider, vbox, hbox

options.workspaces ¶

previewPageId ¶

Data type

Integer / fieldReference per table

Description

Page uid used for previewing records on a workspace.

Examples

# Using page 123 for previewing workspaces records (in general)
options.workspaces.previewPageId = 123

# Using the pid field of each record for previewing (in general)
options.workspaces.previewPageId = field:pid

# Using page 123 for previewing workspaces records (for table tx_myext_table)
options.workspaces.previewPageId.tx_myext_table = 123

# Using the pid field of each record for previewing (for table tx_myext_table)
options.workspaces.previewPageId.tx_myext_table = field:pid

tx_version.workspaces ¶

stageNotificationEmail.subject ¶

(tx_version.workspaces.stageNotificationEmail.subject)

Data type

String / Localized string reference (using LLL: syntax).

Description

The default subject for the stage notification email.

The following markers can be used for replacement:

###SITE_NAME###
###SITE_URL###
###WORKSPACE_TITLE###
###WORKSPACE_UID###
###ELEMENT_NAME###
###NEXT_STAGE###
###COMMENT###
###USER_REALNAME###
###USER_USERNAME###
###RECORD_PATH###
###RECORD_TITLE###

Default

LLL:EXT:version/Resources/Private/Language/emails.xml:subject

stageNotificationEmail.message ¶

(tx_version.workspaces.stageNotificationEmail.message)

Data type: String / Localized string reference (using LLL: syntax).
Description: The default message for the stage notification email. The same markers are available as for the subject (see above).
Default: LLL:EXT:version/Resources/Private/Language/emails.xml:message

User TSconfig ¶

options.workspaces ¶

enableMassActions ¶

Data type: Boolean
Description: If set to "0", the mass actions menu will not be available to users.
Default: 1

previewLinkTTLHours ¶

Data type: Integer
Description: Number of hours until expiry of preview links to workspaces.
Default: 48

swapMode ¶

Data type

String

Description

Possible values are:

"any" - if page or element (meaning any record on the page) is published, all content elements on the page and page itself will be published regardless of the current editing stage.

"page" - if page is published, all content elements on the page will be published as well. If element is published, its publishing does not affect other elements or page.

changeStageMode ¶

Data type

String

Description

Possible values are:

"any" - if page or element (meaning any record on the page) stage is changed (for example, from "editing" to "review"), all content elements on the page and page will change to that new stage as well (possibly bypassing intermediate stages).

"page" - if page stage is changed (for example, from "editing" to "review"), all content elements on the page will change stage as well (possibly bypassing intermediate stages). If stage is changed for element, all other elements on the page and page itself remain in the previous stage.

allowed_languages ¶

Property
workspaces.allowed_languages.[workspaceId]

Data type

(list of sys_language ids)

Description

This is a list of sys_language uids which will be allowed in a workspace. This list - if set - will override the allowed languages list in the BE user group configuration.

Example

options.workspaces.allowed_languages.3 = 1,2

In this example, the user will be restricted to languages with "uid" 1 or 2 in the workspace with "uid" 3.