[TASK] Update "workspaces" documentation 96/48696/8
authorFrancois Suter <francois@typo3.org>
Mon, 27 Jun 2016 16:28:50 +0000 (18:28 +0200)
committerFrancois Suter <francois@typo3.org>
Tue, 2 Aug 2016 08:46:46 +0000 (10:46 +0200)
Update documentation of extension "workspaces".
Move all TSconfig related options here (over from TSconfig reference).
Update rendering configuration (for docs.typo3.org).

Resolves: #76799
Releases: 7.6, master
Change-Id: Ife7e4536fba82dcdd2a5eb8c1ae9a4fecc0d3fae
Reviewed-on: https://review.typo3.org/48696
Reviewed-by: Francois Suter <francois@typo3.org>
Tested-by: Francois Suter <francois@typo3.org>
47 files changed:
typo3/sysext/workspaces/Documentation/Administration/Configuration/Index.rst
typo3/sysext/workspaces/Documentation/Administration/CustomWorkspace/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Administration/Index.rst
typo3/sysext/workspaces/Documentation/Administration/Scheduler/Index.rst [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Administration/Versioning/Index.rst
typo3/sysext/workspaces/Documentation/Administration/Workspaces/Index.rst
typo3/sysext/workspaces/Documentation/CustomWorkspace/Index.rst [deleted file]
typo3/sysext/workspaces/Documentation/Images/ChangeInTheNextStage.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/ChangeRejected.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/CreateCustomWorkspace.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceGeneralTab.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceMountpointsTab.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceNotificationsTab.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceOtherTab.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspacePublishingTab.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabGeneral.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabNotifications.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceUsersTab.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/IndividualActions.png
typo3/sysext/workspaces/Documentation/Images/IndividualControlButtons.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/LiveWorkspacesPermission.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/MassActionsMenu.png
typo3/sysext/workspaces/Documentation/Images/ModifiedPageHighlight.png
typo3/sysext/workspaces/Documentation/Images/PageViewIcon.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/PreviewLink.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SaveAndViewButton.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/SendToAnotherStage.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SendToNextStage.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/SendToNextStageMessage.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/SendToStageMessage.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/SettingWorkspacesPermissions.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/TuningCustomWorkspace.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/VersionsInListView.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/WorkspaceIndicator.png
typo3/sysext/workspaces/Documentation/Images/WorkspaceLogging.png
typo3/sysext/workspaces/Documentation/Images/WorkspaceMenu.png
typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleChangeDetails.png [new file with mode: 0644]
typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleOverview.png
typo3/sysext/workspaces/Documentation/Images/WorkspacePreviewIcon.png [deleted file]
typo3/sysext/workspaces/Documentation/Images/WorkspaceSplitPreview.png
typo3/sysext/workspaces/Documentation/Includes.txt
typo3/sysext/workspaces/Documentation/Index.rst
typo3/sysext/workspaces/Documentation/Introduction/Index.rst
typo3/sysext/workspaces/Documentation/Settings.cfg
typo3/sysext/workspaces/Documentation/Settings.yml [deleted file]
typo3/sysext/workspaces/Documentation/Targets.rst
typo3/sysext/workspaces/Documentation/UsersGuide/Index.rst

index 385c0e6..01fc0b3 100644 (file)
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: ../../Includes.txt
 
 
 
 Configuration Options
 ^^^^^^^^^^^^^^^^^^^^^
 
-You can use Page TS Config to configure the look and text of the stage
-notification emails
+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.
+
+
+.. only:: html
+
+   .. contents::
+      :local:
+      :depth: 3
+
+
+.. _pagetsconfig:
+
+Page TSconfig
+"""""""""""""
+
+.. _pagetsconfig-workspaces:
+
+workspaces
+~~~~~~~~~~
+
+
+.. _pagetsconfig-workspaces-splitpreviewmodes:
+
+splitPreviewModes
+*****************
+
+Data type
+  String
+
+Description
+  Comma-separated list of allowed values for preview modes. Possible
+  values are "slider", "vbox" and "hbox".
+
+  **Example**
+
+  .. code-block:: typoscript
+
+     workspaces.splitPreviewModes = slider
+
+  will restrict the preview mode to "slider".
+
+Default
+  slider, vbox, hbox
+
+.. _pagetsconfig-options-workspaces:
+
+options.workspaces
+~~~~~~~~~~~~~~~~~~
+
+
+.. _pagetsconfig-options-workspaces-previewpageid:
+
+previewPageId
+*************
+
+Data type
+  Integer / fieldReference per table
+
+Description
+  Page uid used for previewing records on a workspace.
+
+  **Examples**
+
+  .. code-block:: typoscript
+
+     # 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
+
+
+.. _pagetsconfig-options-workspaces-enablemassactions:
 
+enableMassActions
+*****************
 
-.. _stagenotificationemail-subject:
+Data type
+  Boolean
+
+Description
+  If set to "0", the mass actions menu will not be available to users.
+
+Default
+  1
+
+
+.. _pagetsconfig-txversion-workspaces:
+
+tx_version.workspaces
+~~~~~~~~~~~~~~~~~~~~~
+
+
+.. _pagetsconfig-txversion-workspaces-stagenotificationemail-subject:
 
 stageNotificationEmail.subject
-""""""""""""""""""""""""""""""
+******************************
 
 (:code:`tx_version.workspaces.stageNotificationEmail.subject`)
 
-.. container:: table-row
-
-   Property
-         stageNotificationEmail.subject
+Data type
+  String / Localized string reference (using :code:`LLL:` syntax).
 
-   Description
+Description
          The default subject for the stage notification email.
 
-         Note that there are various markers you can use in the subject or
-         message:
+         The following markers can be used for replacement:
 
-         ###SITE\_NAME###
+         - :code:`###SITE_NAME###`
 
-         ###SITE\_URL###
+         - :code:`###SITE_URL###`
 
-         ###WORKSPACE\_TITLE###
+         - :code:`###WORKSPACE_TITLE###`
 
-         ###WORKSPACE\_UID###
+         - :code:`###WORKSPACE_UID###`
 
-         ###ELEMENT\_NAME###
+         - :code:`###ELEMENT_NAME###`
 
-         ###NEXT\_STAGE###
+         - :code:`###NEXT_STAGE###`
 
-         ###COMMENT###
+         - :code:`###COMMENT###`
 
-         ###USER\_REALNAME###
+         - :code:`###USER_REALNAME###`
 
-         ###USER\_USERNAME###
+         - :code:`###USER_USERNAME###`
 
-         ###RECORD\_PATH###
+         - :code:`###RECORD_PATH###`
 
-         ###RECORD\_TITLE###
+         - :code:`###RECORD_TITLE###`
 
-   Default
-         LLL:EXT:version/Resources/Private/Language/emails.xml:subject
+Default
+  LLL:EXT:version/Resources/Private/Language/emails.xml:subject
 
 
 
-.. _stagenotificationemail-message:
+.. _pagetsconfig-txversion-workspaces-stagenotificationemail-message:
 
 stageNotificationEmail.message
-""""""""""""""""""""""""""""""
+******************************
 
 (:code:`tx_version.workspaces.stageNotificationEmail.message`)
 
-.. container:: table-row
+Data type
+  String / Localized string reference (using :code:`LLL:` syntax).
 
-   Property
-         stageNotificationEmail.message
+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
+
+
+.. _usertsconfig:
+
+User TSconfig
+"""""""""""""
+
+
+.. _usertsconfig-options-workspaces:
+
+options.workspaces
+~~~~~~~~~~~~~~~~~~
+
+
+.. _usertsconfig-options-workspaces-previewlinkttlhours:
+
+previewLinkTTLHours
+*******************
+
+Data type
+  Integer
+
+Description
+  Number of hours until expiry of preview links to workspaces.
+
+Default
+  48
+
+
+.. _usertsconfig-options-workspaces-swapmode:
+
+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.
+
+
+.. _usertsconfig-options-workspaces-changestagemode:
+
+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).
 
-   Description
-         The default message for the stage notification email. Look at the
-         Description of the subject for markers you can use
+  "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.
 
-   Default
-         LLL:EXT:version/Resources/Private/Language/emails.xml:message
 
+.. _usertsconfig-options-workspaces-considerreferences:
 
+considerReferences
+******************
 
-.. _stagenotificationemail-additionalheaders:
+Data type
+  Boolean
 
-stageNotificationEmail.additionalHeaders
-""""""""""""""""""""""""""""""""""""""""
+Description
+  If elements which are part of an interdependent structure (e.g. Inline
+  Relational Record Editing) are swapped, published or sent to a stage
+  alone, the whole related parent/child structure is taken into account
+  automatically.
 
-(:code:`tx_version.workspaces.stageNotificationEmail.additionalHeaders`)
+Default
+  1
 
-.. container:: table-row
+allowed\_languages
+******************
 
    Property
-         stageNotificationEmail.additionalHeaders
+         workspaces.allowed\_languages.[workspaceId]
 
-   Description
-         Additional Headers to be sent with the notification email.
+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
-"""""""
+  **Example**
 
-.. code-block:: typoscript
+  .. code-block:: typoscript
 
-   tx_version.workspaces.stageNotificationEmail.subject = Stage changed for ###ELEMENT_NAME###
+     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.
diff --git a/typo3/sysext/workspaces/Documentation/Administration/CustomWorkspace/Index.rst b/typo3/sysext/workspaces/Documentation/Administration/CustomWorkspace/Index.rst
new file mode 100644 (file)
index 0000000..cf2211f
--- /dev/null
@@ -0,0 +1,219 @@
+.. include:: ../../Includes.txt
+
+
+.. _custom-workspace:
+
+Creating a custom workspace
+---------------------------
+
+Except for the LIVE workspace (i.e. the default TYPO3 CMS working
+environment), some custom workspaces must be created before
+anyone can start using the features described in this document.
+
+By default a custom workspace contains three stages, which represent
+steps in the validation process: "editing", "ready to publish" and
+"publishing execute". Additional stages can be added.
+
+This chapter describes all properties of a workspace, as they
+appear in the editing form, grouped by tab.
+
+.. _custom-workspace-general:
+
+General
+^^^^^^^
+
+.. figure:: ../../Images/CustomWorkspaceGeneralTab.png
+   :alt: The General tab of a custom workspace
+
+   Entering the general information about the workspace
+
+
+As with most records in the TYPO3 CMS universe, this is just about
+setting a clear title and a helpful description.
+
+.. _custom-workspace-users:
+
+Users
+^^^^^
+
+.. figure:: ../../Images/CustomWorkspaceUsersTab.png
+   :alt: The Users tab of a custom workspace
+
+   Setting up owners and members of the workspace
+
+
+This tab is about setting up user permissions. The "Owners" have
+all possible rights over the workspace, including publication to
+live. "Members" also have all the rights, although they may be prevented
+from publishing with the "Only workspace owner can publish" setting
+(see the :ref:`Other tab <custom-workspace-other>`).
+
+.. note::
+
+   As usual, it is recommended to work with groups rather
+   than individual users. "Admin" users have access to all
+   workspaces and all operations within workspaces.
+
+.. note::
+
+   Users must be given explicit access to the LIVE workspace.
+   This is done at the level backend users or backend groups.
+
+   .. figure:: ../../Images/LiveWorkspacesPermission.png
+      :alt: Access to the live workspace
+
+      Giving acces to the LIVE workspace to a backend group
+
+
+.. _custom-workspace-notifications:
+
+Notification settings
+^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: ../../Images/CustomWorkspaceNotificationsTab.png
+   :alt: The Notification settings tab of a custom workspace
+
+   Fine-grained definition for the notification process
+
+
+Each time a given change or set of changes moves from one stage
+to another (either forward or backward in the review process),
+people can be notified about this status change. This tab is
+about defining the behavior of the notification process.
+
+With "Stage change notification by email" you can choose
+who gets notified. This can be either all users involved
+in the workspace (no matter the stage) or only the users
+involved with the stage the changes are being sent to.
+
+Subsequently you can configure settings for the three predefined stages.
+
+.. note::
+
+   The screenshot is cropped. The settings are the same for each
+   stage.
+
+The "Settings dialog" is about the popup window which appears after
+each review process. If the "show dialog" box is not checked, the
+popup will not even appear and notifications will be sent according
+to the predefined settings. When the "changeable preselection" box
+is checked, the preselected list of users to notify can be modified
+on the fly before sending the change notification.
+
+The "Preselection" setting makes it possible to choose which users
+should be preselected by default in the notification popup.
+Furthermore specific users can be added to the list of notified
+people using the "Default notification mail recipients" field.
+
+
+.. _custom-workspace-mounts:
+
+Mountpoints
+^^^^^^^^^^^
+
+.. figure:: ../../Images/CustomWorkspaceMountpointsTab.png
+   :alt: The Mountpoints tab of a custom workspace
+
+   Setting alternate mountpoint for the workspace
+
+
+A workspace can be restricted to one or more mountpoints. These
+need not be the same as the mountpoints from the users and groups
+that are allowed access to this workspace.
+
+If no mountpoints are defined, the mountpoints from the users
+and the groups they belong to are used.
+
+
+.. _custom-workspace-publish:
+
+Publishing
+^^^^^^^^^^
+
+.. figure:: ../../Images/CustomWorkspacePublishingTab.png
+   :alt: The Publishing tab of a custom workspace
+
+   Choosing a publication date for the custom workspace
+
+
+If a "Publish" date is set, the content of the workspace
+will be automatically published on the given date. This requires
+the "Workspaces auto-publication" Scheduler task to be activated.
+
+.. note::
+
+   Only the content which is "Ready to publish" is actually
+   published.
+
+
+.. _custom-workspace-staging:
+
+Staging
+^^^^^^^
+
+Any number of custom stages can be created. Each corresponds
+to an additional step in the review process. Custom stages
+can be ordered at will. However they all come after the default
+"Editing" stage and before the default "Ready to publish"
+stage.
+
+.. figure:: ../../Images/CustomWorkspaceStagingTabGeneral.png
+   :alt: The Staging tab of a custom workspace
+
+   Setting the general information of a custom stage
+
+
+In the "General" tab of a custom stage, a restricted set of users
+can be chosen from among "Owners" and "Members". They are called
+"Responsible persons".
+
+.. figure:: ../../Images/CustomWorkspaceStagingTabNotifications.png
+   :alt: The Staging tab of a custom workspace
+
+   Defining the notification settings of a custom stage
+
+
+The notitication settings for a custom stage are mostly the same
+as for the default stages, except that the "Responsible persons"
+can also be chosen in the predefined list of users to notify
+and that a "Default mail comment" can be defined for that stage.
+
+.. note::
+
+   In this context "Editors" means the people that have been
+   involved in the change originally.
+
+
+.. _custom-workspace-other:
+
+Other
+^^^^^
+
+.. figure:: ../../Images/CustomWorkspaceOtherTab.png
+   :alt: The Other tab of a custom workspace
+
+   Miscellaneous settings for a custom workspace
+
+
+The "Other" tab is comprised of various settings affecting
+the behavior of the custom workspace.
+
+The "Freeze editing" flag actually blocks all operations in
+the workspace until it is turned off again.
+
+It is possible to allow editing of non-versionable records
+in the custom workspace. These records will be edited "live",
+i.e. any changes to them performed in the workspace will be
+directly visible on the web site, rather than going through
+the review process.
+
+"Swap modes" defines if swapping should take place or not
+upon automatic publishing.
+
+The "Publish access" setting further refines publishing rights.
+If the "Publish only content in publish stage" box is checked,
+modified content cannot be forcefully published by workspace owners at
+whatever stage. It has to reach the "Ready to publish" stage.
+Also publication can be restricted to the owners of the
+workspace (i.e. members may not publish).
+
index 7b8516b..865a3e9 100644 (file)
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: ../Includes.txt
 
 
 
@@ -20,5 +15,6 @@ Administration
 
    Versioning/Index
    Workspaces/Index
+   CustomWorkspace/Index
    Configuration/Index
-
+   Scheduler/Index
diff --git a/typo3/sysext/workspaces/Documentation/Administration/Scheduler/Index.rst b/typo3/sysext/workspaces/Documentation/Administration/Scheduler/Index.rst
new file mode 100644 (file)
index 0000000..d624cb2
--- /dev/null
@@ -0,0 +1,19 @@
+.. include:: ../../Includes.txt
+
+
+.. _scheduler:
+
+Scheduler tasks
+^^^^^^^^^^^^^^^
+
+The "workspaces" extension provides two Scheduler tasks.
+
+Workspaces auto-publication
+  This task checks if any workspace has a scheduled publishing date.
+  If yes and if that date is passed, then all changes that have reached
+  the "Ready to publish" stage are published to the Live workspace.
+
+Workspaces cleanup preview links
+  When :ref:`preview links <users-guide-preview-link>` are generated,
+  they are stored in the database (in table "sys_preview"). This task
+  will delete any link which has expired.
index 4891513..3f88dc8 100644 (file)
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: ../../Includes.txt
 
 
 
 Versioning
 ^^^^^^^^^^
 
-TYPO3 offers versioning of the database elements it manages. This
+TYPO3 CMS offers versioning of the database elements it manages. This
 versioning system allows you to work on future versions of content
 without affecting the live content. It is used by workflow systems to
 offer a process for such content, going from creation, editing to
 review and publishing.
 
 Versioning is available in the core API by default, but to gain access
-to management tools you must install the system extensions versioning
-and workspaces.
+to management tools you must install the system extensions "version"
+and "workspaces".
 
 
 .. _technical-details:
@@ -28,19 +23,21 @@ and workspaces.
 Technical Details
 """""""""""""""""
 
-Versioning must be enabled on a per-table basis in the [ctrl] section
-of the $TCA array entry for a table. In addition a fixed set of fields
-has to exist for the management of versions. All of these technical
-details are specified in the document "TYPO3 Core API" where you will
-also find other in-depth information.
+Versioning must be enabled on a per-table basis in the
+:ref:`"ctrl" section of the TCA array <t3tca:ctrl>` for the given table.
+In addition a fixed set of fields has to exist for the management of versions.
+All of these technical details are specified in the
+:ref:`description of the "versioningWS" TCA property <t3tca:ctrl-reference-versioningws>`.
+All other versioning and workspace-related properties are also
+described there.
 
-Future and past versions of records in TYPO3 remain in the same table
-as the live version. However, all "offline" versions will have a pid
-value of "-1" which identifies them as "offline". Further they have a
-field, "t3ver\_oid" which points to their live ("online") version.
+Future and past versions of records in TYPO3 CMS remain in the same table
+as the live version. However, all "offline" versions have a pid
+value of "-1" to set them apart. Furthermore they have a database
+field called "t3ver\_oid" which points to their live ("online") counterpart.
 
 When a future/past version is swapped with the live version it is done
-by  *swapping all field values except the uid and pid* fields (and of
+by *swapping all field values except the uid and pid* fields (and of
 course versioning related fields are manipulated according to their
 function). It means that online content is always identified by the
 same id as before and therefore all references are kept intact.
@@ -49,25 +46,24 @@ Versioning is easy for existing elements. However, moving, creating
 and deleting poses other problems. This is solved the following way:
 
 - Deleting elements is done by actually creating a new version of the
-  element  *and* setting a flag in the new version (t3ver\_state=2) that
-  indicates the live element must be deleted upon swapping the versions.
-  Thus deletion is "scheduled" to happen when the versions are swapped.
+  element *and* setting a flag in the new version (:code:`t3ver_state = 2`) that
+  indicates the live element must be deleted upon publishing the versions.
 
 - Creating elements is done by first creating a placeholder element
-  which is in fact live but carrying a flag (t3ver\_state=1) that makes
-  it invisible online. Then a new version of this placeholder is made
-  which is what is modified until published.
+  which is in fact live but carrying a flag (:code:`t3ver_state = 1`) that makes
+  it invisible online. Then a new version of this placeholder with the flag
+  (:code:`t3ver_state = -1`) is made which is what is modified until published.
 
 - Moving elements is done by first creating a placeholder element which
-  is in fact live but carrying a flag (t3ver\_state=3) that makes it
+  is in fact live but carrying a flag (:code:`t3ver_state = 3`) that makes it
   invisible online. It also has a field, "t3ver\_move\_id", holding the
   uid of the record to move (source record). In addition, a new version
-  of the source record is made and has "t3ver\_state" = 4 (move-to
-  pointer). This version is simply necessary in order for the versioning
+  of the source record is made with :code:`t3ver_state = 4` (move-to
+  pointer). This version is necessary in order for the versioning
   system to have something to publish for the move operation. So in
   summary, two records are created for a move operation in a workspace:
-  The placeholder (online, with state=3 and t3ver\_move\_id set) and a
-  new version (state=4) of the online source record (the one being
+  The placeholder (online, with :code:`t3ver_state = 3` and "t3ver\_move\_id" set) and a
+  new version (:code:`t3ver_state = 4`) of the online source record (the one being
   moved).
 
 
@@ -88,25 +84,9 @@ Unique fields
 - You can hide fields with the "unique" keyword when there are offline
   versions. This is done with the display condition:
 
-::
-
-   'displayCond' => 'VERSION:IS:false',
-
-
-.. _life-cycle:
-
-Life cycle
-~~~~~~~~~~
+.. code-block:: php
 
-- When a new version of an element is created, its publishing counter
-  (t3ver\_count) is set to zero. This means its life cycle state is
-  interpreted as "Draft"; the element is in the pipeline to be
-  published. When the element is published the life cycle state is
-  "Live" and when it is swapped out again the publishing counter will be
-  incremented and the life cycle is interpreted as "Archive". Yet, the
-  element can be continously published and unpublished and for each time
-  the publishing counter will be incremented, telling how many times an
-  element has been online.
+       'displayCond' => 'VERSION:IS:false',
 
 
 .. _permissions:
@@ -114,14 +94,14 @@ Life cycle
 Permissions
 ~~~~~~~~~~~
 
-This is an overview of how permissions are handled in relation to
-  versioning:
+This is an overview of how permissions are handled in relation to
+versioning:
 
 
 .. _display:
 
 Display
-~~~~~~~
+*******
 
 - Read permissions are evaluated based on the live version of pages (as
   the basic rule). The read permissions of the offline page version in a
@@ -134,7 +114,7 @@ Display
 .. _versioning-records:
 
 Versioning records
-~~~~~~~~~~~~~~~~~~
+******************
 
 - To create a new version the user must have read permission to the live
   record he requests to version
@@ -146,14 +126,14 @@ Versioning records
 .. _publishing-version:
 
 Publishing version
-~~~~~~~~~~~~~~~~~~
+******************
 
 - To publish, a user must have general publishing permission in the
   workspace, for instance be the owner of it or have access to the Live
   workspace.
 
 - In addition, the user must have read and edit access to the offline
-  version being published plus edit access to the  *live version* that a
+  version being published plus edit access to the *live version* that a
   publishing action will substitute!
 
 - The permissions of a new version of a page follows the page when
@@ -163,25 +143,25 @@ Publishing version
 .. _editing-records:
 
 Editing records
-~~~~~~~~~~~~~~~
+***************
 
 - For all editing it is required that the stage of the versioned record
   (or root point) allows editing.
 
 - Page records:
-  
+
   - Permission to edit is always evaluated based on the pages own
     permission settings and not the live records.
 
 - Records from non-pages tables:
-  
+
   - Always based on the live parent page.
 
 
 .. _new-records:
 
 New records
-~~~~~~~~~~~
+***********
 
 - When new records are created with a version and live place holder the
   permissions depend on the live page under which the record is created.
@@ -190,34 +170,33 @@ New records
 .. _moving-records:
 
 Moving records
-~~~~~~~~~~~~~~
+**************
 
-- Records can be moved as long as the source and destination root points
-  has a stage that allows it.
+- Records can be moved as long as the source and destination root point
+  to a stage that allows it.
 
-- New records created with a place holder element can be moved freely
+- New records created with a placeholder element can be moved freely
   around.
 
 - Generally, the stage of a moved record has to allow for editing plus
-  regular permissions for moving are observed.
+  regular permissions for moving.
 
 
 .. _deleting-records:
 
 Deleting records
-~~~~~~~~~~~~~~~~
+****************
 
 - If a record supports versioning it will be marked for deletion if all
   usual requirements are fulfilled at the time of the delete request:
-  Delete access to record, no subpages if recursive deletion is not
+  delete access to record, no subpages if recursive deletion is not
   enabled and no disallowed table records are found. As soon as the
   record is marked for deletion any change to the record and subpages
   that would otherwise prevent deletion for the user will not be
-  effective: The record  *will* be deleted upon publication!
+  effective. The record *will* be deleted upon publication!
 
 - If you try to delete a Live record for which a version is found in the
   workspace, that version is deleted instead.
 
 - Detaching versions from a workspace and raising stage of versions can
   be done as long as the user has edit permission to the record.
-
index 0d66c66..dd6cf56 100644 (file)
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: ../../Includes.txt
 
 
 .. _workspaces:
 Workspaces
 ^^^^^^^^^^
 
+Workspaces are the user interface that sits on top of the
+versioning concept, to make it easier for users to manage
+versions.
 
-.. _usability:
-
-Problems with versioning usability
-""""""""""""""""""""""""""""""""""
-
-One problem with raw versioning is that it easily requires a lot of
-administration and awareness from users. For instance, an author has
-to consciously create a new version of a page or content element
-before he must edit it. Maybe he forgets. So either he makes a change
-live or - if TYPO3 is configured for it - he will be denied access to
-editing but frustrated over an error message. Further, keeping track
-of versions across the system might be difficult since changes are
-often made at various places and should be published together.
-
-Some of these problems are fixed when elements are always processed
-with a workflow that keeps track of them. But a workflow process might
-be too rigid for scenarios where a group of editors are concerned with
-the site content broadly and not the narrow scope of an element
-centred workflow.
-
-Furthermore, the preview of future content is hard to implement unless
-you require people to request a preview of each individual new version
-- but most often they like to see the combined impact of all future
-versions!
-
-
-.. _solution:
-
-The perfect solution
-""""""""""""""""""""
-
-The concept of workspaces is the answer. Workspaces puts versioning
-into action in a very usable and transparent way offering all the
-flexibility from live editing but without sacrificing the important
-control of content publishing and review.
+Furthermore workspaces make it possible to create a number
+of stages for validation of any given change, thus providing
+a complete review process before publication. Users at all
+stages can be notified about changes in the review process.
 
-A workspace is a state in the backend of TYPO3. Basically there are
+A workspace is a state in the backend of TYPO3 CMS. Basically there are
 two types of workspaces:
 
-- LIVE workspace: This is exactly the state TYPO3 has always been in.
+- LIVE workspace: this is exactly the state TYPO3 CMS has always been in.
   Any change you make will be instantly live. Nothing has changed, it
   just got a name.
 
-- Custom workspaces: When a user selects a custom workspace new rules
-  apply to anything he does in the backend:
+  Access to the Live workspace must be explicitly granted to backend
+  users and groups (in the "Mounts and Workspaces" tab).
 
-  - Any change he tries to make will not affect the live website. It's a
+- Custom workspaces: when users select a custom workspace new rules
+  apply to anything they do in the backend:
+
+  - Safety: any change they try to make will not affect the live website. It's a
     safe playground.
 
-  - Transparent versioning: He can edit pages and elements because a new
+  - Transparent versioning: they can edit pages and elements because a new
     version is made automatically and attached to the workspace. No
     training needed, no administrative overhead!
 
-  - Previewing: Visiting the frontend website will display it as it will
-    appear when all versions in the workspace is eventually published.
+  - Previewing: visiting the frontend website will display it as it will
+    appear when all versions in the workspace are eventually published.
 
-  - Overview of changes: The workspace manager module gives a clear
-    overview of all changes that has been made inside the workspace across
-    the site. This gives unparalleled control before publishing the
+  - Overview of changes: the workspace manager module gives a clear
+    overview of all changes that have been made inside the workspace across
+    the site. This gives unparalleled control before making the
     content live.
 
-  - Constraints: Only tables that support versioning can be edited. All
-    management of files in fileadmin/ is disabled by default because they
-    may affect the live website and thus would break the principle of
-    "safe playground". Records that do not support versioning can be
-    allowed to be edited explicitly and file mounts can be defined inside
-    of which files  *can* be managed.
-
-  - Can be configured additionally with owners, members and reviewers plus
-    database- and file mounts plus other settings. A custom workspace is a
-    great way to do team-based maintenance of (a section of) the website
-    including a basic implementation of workflow states with editor-
-    reviewer-publisher.
-
-
-.. tip::
-
-   **Analogy**
+  - Constraints: only tables that support versioning can be edited.
 
-   The concept of workspaces can be compared with how SVN works for
-   programmers; You check out the current source to your local computer
-   (= entering a draft workspace), then you can change any script you
-   like on your local computer (= transparent editing in the workspace),
-   run tests of the changed code scripts (= previewing the workspace in
-   the frontend), compare the changes you made with the source in SVN (=
-   using the Workspace Manager modules overview to review the complete
-   amount of changes made) and eventually you commit the changes to SVN
-   (= publishing the content of the workspace).
+  - Flexibility: custom workspaces can be configured with owners, members
+    and reviewers plus database mounts and more. A custom workspace can
+    thus offer a more targeted editing area than backend users and groups.
+    Plus a review process as simple or complete as needed.
 
 
 .. _publishing-and-swapping:
@@ -115,325 +64,24 @@ which pushes the live item out of any workspace and "into the
 archive".
 
 The swapping mode is useful if you have a temporary campaign, say a
-christmas special frontpage and website section. You create the
-christmas edition in a custom workspace and two weeks before christmas
-you swap in the christmas edition. All normal pages and elements that
-were unpublished are now in the workspace, waiting for christmas to
+Christmas special frontpage and website section. You create the
+Christmas edition in a custom workspace and two weeks before Christmas
+you swap in the Christmas edition. All normal pages and elements that
+were unpublished are now in the workspace, waiting for Christmas to
 pass by and eventually the old frontpage etc. will be swapped back in.
-The christmas edition is now back in the workspace and ready for next
+The Christmas edition is now back in the workspace and ready for next
 year.
 
 
-.. _more-on-workspace-types:
-
-More on Workspace types
-"""""""""""""""""""""""
-
-Here is a clearer description of the various workspace types, their
-differences and applications:
-
-
-
-.. _access:
-
-**Access**
-~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Access**
-
-   Live workspace
-         Users and groups must be specifically allowed access to the Live
-         workspace.
-
-         (Checkboxes in user/group record)
-
-   Custom workspaces
-         Granted through the workspace configuration which includes:
-
-         \- A list of editors (users and/or groups)
-
-         \- A list of reviewers (users and/or groups)
-
-         \- Owner users (initial creator)
-
-
-
-.. _editing:
-
-**Editing**
-~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Editing**
-
-   Live workspace
-         Live content
-
-   Custom workspaces
-         Draft versions of live content
-
-         *Option: To allow editing of tables without versioning available.*
-
-
-
-.. _db-mounts:
-
-**DB mounts**
-~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **DB mounts**
-
-   Live workspace
-         From user profile
-
-   Custom workspaces
-         Specific DB mounts can be specified in which case they will overrule
-         DB mounts from user profiles.
-
-         Specific DB mounts are required to be within the DB mounts from the
-         user profile (for security reasons)
-
-         If no DB mounts specified for workspace, user profile mounts are used
-         (default)
-
-
-
-.. _file-mounts:
-
-**File mounts**
-~~~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **File mounts**
-
-   Live workspace
-         From user profile
-
-   Custom workspaces
-         By default, all file manipulation access is banned! (Otherwise
-         violation of "draft principle")
-
-         Optionally, file mounts can be specified for convenience reasons.
-
-
-
-.. _scheduled-publishing:
-
-**Scheduled publishing**
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Scheduled publishing**
-
-   Live workspace
-         N/A
-
-   Custom workspaces
-         The workspaces extension comes with a scheduler task that allows the
-         use of the scheduler to publish your whole workspace on a certain day
-         and time. You can also specify an unpublish time which requires the
-         use of swapping as publishing type.
-
-
-
-.. _reviewing:
-
-**Reviewing**
-~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Reviewing**
-
-   Live workspace
-         Only through a separate workflow system.
-
-   Custom workspaces
-         **Members** can raise content from "Editing" stage to the next
-         configured stage. If no custom stages are configured the next stage is
-         "Ready to publish". Members can only edit content when its in "Editing
-         stage".
-
-         **Persons responsible for a certain stage (Reviewers)** can edit
-         content in the "Editing" stage and additionally in the stage they are
-         responsible for. They can push content from "Editing" and from their
-         stage to the next stage.
-
-         **Owners** can operate all states of course. Owners are the only ones
-         to edit content when in "Publish" mode. Thus "Publish" mode provides
-         protection for content awaiting publication.
-
-         Options available for automatic email notification between the roles.
-
-
-
-.. _publishing:
-
-**Publishing**
-~~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Publishing**
-
-         (For all: Requires edit access to live element)
-
-   Live workspace
-         No limitations. Content can be edited live and even content from other
-         workspaces can be published through the versioning API regardless of
-         stage.
-
-   Custom workspaces
-         Workspace owners can publish (even without access to Live workspace).
-
-         Reviewers/Members cannot publish  *unless* they have access to online
-         workspace as well (this default behavior can be disabled).
-
-         Option: Restrict publishing to elements in "Publish" stage only.
-
-         Option: Restrict publishing to workspace owner.
-
-
-
-.. _settings:
-
-**Settings**
-~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Settings**
-
-   Live workspace
-         N/A
-
-   Custom workspaces
-         Users with permission to create a custom workspace can do so.
-
-         Workspace owners can add other owners, reviewers and editors and
-         change all workspace properties.
-
-
-
-.. _auto-versioning:
-
-**Auto versioning**
-~~~~~~~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Auto versioning**
-
-   Live workspace
-         N/A
-
-   Custom workspaces
-         Yes, but can be disabled so a conscious versioning actions is
-         required.
-
-
-
-.. _swapping:
-
-**Swapping**
-~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Swapping**
-
-   Live workspace
-         N/A
-
-   Custom workspaces
-         Yes, but can be disabled.
-
-
-
-.. _other-notes:
-
-**Other notes**
-~~~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Other notes**
-
-   Live workspace
-
-
-   Custom workspaces
-         Custom workspaces have a freeze flag that will shut down any
-         update/edit/copy/move/delete etc. command in the workspace until it is
-         unset again.
-
-
-
-.. _module-access:
-
-**Module access**
-~~~~~~~~~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Module access**
-
-   Live workspace
-         All backend modules can specify $MCONF['workspaces'] =
-         "[online,offline,custom]" to limit access based on the current
-         workspace of user.
-
-
-
-.. _usage:
-
-**Usage**
-~~~~~~~~~
-
-.. container:: table-row
-
-   Topic
-         **Usage**
-
-   Live workspace
-         Administrative purposes. First creation of site.
-
-   Custom workspaces
-         Specific projects on a site branch. Simple review-cycles. Informal
-         team-work on site maintenance.
-
-
-
-Generally, "admin" users have access to all functionality as usual.
-
-.. note::
-
-   **Supporting workspaces in extensions**
+.. _extensions-and-workspaces:
 
-   Since workspaces imply transparent support all over the backend and
-   frontend it means that extensions must be programmed with this in
-   mind. Although the ideal is complete transparency in backend and
-   perfect previews in the frontend this is almost impossible to obtain.
-   But a high level of consistency can be obtained by using API functions
-   in TYPO3. These functions and the challenges they are designed to
-   address are discussed in :ref:`TYPO3 Core API <t3api:workspaces>`.
+Extensions and workspaces
+"""""""""""""""""""""""""
 
+Workspaces imply transparent support all over the backend and
+frontend and extensions must be programmed with this in
+mind. Although the ideal is complete transparency in backend and
+perfect previews in the frontend, this is almost impossible to obtain.
+Nevertheless a high level of consistency can be obtained by using the API
+provided by TYPO3 CMS. These functions and the challenges they are designed to
+address are discussed in :ref:`TYPO3 Core API <t3api:workspaces>`.
diff --git a/typo3/sysext/workspaces/Documentation/CustomWorkspace/Index.rst b/typo3/sysext/workspaces/Documentation/CustomWorkspace/Index.rst
deleted file mode 100644 (file)
index 884f2e0..0000000
+++ /dev/null
@@ -1,48 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
-
-
-.. _custom-workspace:
-
-Creating a custom workspace
----------------------------
-
-- Go via the Web > List module to the root page of your web site (ID 0)
-
-- Click on the "new record" icon:
-
-.. figure:: ../Images/CreateCustomWorkspace.png
-   :alt: Create new workspace
-
-   Starting the creation of a new custom workspace
-
-
-- Choose "Workspace" in the wizard
-
-- Fill in the form – most fields are self-explaining (for the user
-  rights see chapter above)
-
-- Add as many stages as you may need (Without any custom stages you will
-  have "Edit" and "Ready to Publish")
-
-- Either you just define responsible persons or you further define the
-  default notification recipients (these are checked by default in the
-  change stage window)
-
-- By disabling the checkbox "Allow notification settings during stage
-  change" you are able to hide the recipient suggestions in the change
-  stage window
-
-.. figure:: ../Images/TuningCustomWorkspace.png
-   :alt: Tuning a custom workspace
-
-   Tuning the notification settings for the custom workspace
-
-
-- Save and finished :-)
-
-
diff --git a/typo3/sysext/workspaces/Documentation/Images/ChangeInTheNextStage.png b/typo3/sysext/workspaces/Documentation/Images/ChangeInTheNextStage.png
deleted file mode 100644 (file)
index 9938550..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/ChangeInTheNextStage.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/ChangeRejected.png b/typo3/sysext/workspaces/Documentation/Images/ChangeRejected.png
deleted file mode 100644 (file)
index ddd43af..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/ChangeRejected.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CreateCustomWorkspace.png b/typo3/sysext/workspaces/Documentation/Images/CreateCustomWorkspace.png
deleted file mode 100644 (file)
index b46af65..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/CreateCustomWorkspace.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceGeneralTab.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceGeneralTab.png
new file mode 100644 (file)
index 0000000..e27d9a0
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceGeneralTab.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceMountpointsTab.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceMountpointsTab.png
new file mode 100644 (file)
index 0000000..3220f7a
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceMountpointsTab.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceNotificationsTab.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceNotificationsTab.png
new file mode 100644 (file)
index 0000000..eb73a7d
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceNotificationsTab.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceOtherTab.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceOtherTab.png
new file mode 100644 (file)
index 0000000..ba126ef
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceOtherTab.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspacePublishingTab.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspacePublishingTab.png
new file mode 100644 (file)
index 0000000..f57e64d
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspacePublishingTab.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabGeneral.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabGeneral.png
new file mode 100644 (file)
index 0000000..c60c139
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabGeneral.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabNotifications.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabNotifications.png
new file mode 100644 (file)
index 0000000..06fe974
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceStagingTabNotifications.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceUsersTab.png b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceUsersTab.png
new file mode 100644 (file)
index 0000000..ee5b1e5
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/CustomWorkspaceUsersTab.png differ
index ec17c8b..98e3ec9 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/IndividualActions.png and b/typo3/sysext/workspaces/Documentation/Images/IndividualActions.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/IndividualControlButtons.png b/typo3/sysext/workspaces/Documentation/Images/IndividualControlButtons.png
deleted file mode 100644 (file)
index 427284a..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/IndividualControlButtons.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/LiveWorkspacesPermission.png b/typo3/sysext/workspaces/Documentation/Images/LiveWorkspacesPermission.png
new file mode 100644 (file)
index 0000000..4d0e29e
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/LiveWorkspacesPermission.png differ
index 8c41927..473b236 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/MassActionsMenu.png and b/typo3/sysext/workspaces/Documentation/Images/MassActionsMenu.png differ
index dd57376..12a0804 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/ModifiedPageHighlight.png and b/typo3/sysext/workspaces/Documentation/Images/ModifiedPageHighlight.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/PageViewIcon.png b/typo3/sysext/workspaces/Documentation/Images/PageViewIcon.png
deleted file mode 100644 (file)
index 81f85f5..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/PageViewIcon.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/PreviewLink.png b/typo3/sysext/workspaces/Documentation/Images/PreviewLink.png
new file mode 100644 (file)
index 0000000..7cc9fb6
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/PreviewLink.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/SaveAndViewButton.png b/typo3/sysext/workspaces/Documentation/Images/SaveAndViewButton.png
deleted file mode 100644 (file)
index 6cd1296..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/SaveAndViewButton.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/SendToAnotherStage.png b/typo3/sysext/workspaces/Documentation/Images/SendToAnotherStage.png
new file mode 100644 (file)
index 0000000..738d8f7
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/SendToAnotherStage.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/SendToNextStage.png b/typo3/sysext/workspaces/Documentation/Images/SendToNextStage.png
deleted file mode 100644 (file)
index 2afa539..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/SendToNextStage.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/SendToNextStageMessage.png b/typo3/sysext/workspaces/Documentation/Images/SendToNextStageMessage.png
deleted file mode 100644 (file)
index 42e9d89..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/SendToNextStageMessage.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/SendToStageMessage.png b/typo3/sysext/workspaces/Documentation/Images/SendToStageMessage.png
new file mode 100644 (file)
index 0000000..7b924b7
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/SendToStageMessage.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/SettingWorkspacesPermissions.png b/typo3/sysext/workspaces/Documentation/Images/SettingWorkspacesPermissions.png
deleted file mode 100644 (file)
index 321a6fb..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/SettingWorkspacesPermissions.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/TuningCustomWorkspace.png b/typo3/sysext/workspaces/Documentation/Images/TuningCustomWorkspace.png
deleted file mode 100644 (file)
index 4da8e4f..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/TuningCustomWorkspace.png and /dev/null differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/VersionsInListView.png b/typo3/sysext/workspaces/Documentation/Images/VersionsInListView.png
deleted file mode 100644 (file)
index f5d243a..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/VersionsInListView.png and /dev/null differ
index 699ba75..0d4d9b4 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/WorkspaceIndicator.png and b/typo3/sysext/workspaces/Documentation/Images/WorkspaceIndicator.png differ
index bde2e6f..861ba82 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/WorkspaceLogging.png and b/typo3/sysext/workspaces/Documentation/Images/WorkspaceLogging.png differ
index 124f162..2627e16 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/WorkspaceMenu.png and b/typo3/sysext/workspaces/Documentation/Images/WorkspaceMenu.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleChangeDetails.png b/typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleChangeDetails.png
new file mode 100644 (file)
index 0000000..fcc8ede
Binary files /dev/null and b/typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleChangeDetails.png differ
index b356782..7505866 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleOverview.png and b/typo3/sysext/workspaces/Documentation/Images/WorkspaceModuleOverview.png differ
diff --git a/typo3/sysext/workspaces/Documentation/Images/WorkspacePreviewIcon.png b/typo3/sysext/workspaces/Documentation/Images/WorkspacePreviewIcon.png
deleted file mode 100644 (file)
index c7051c7..0000000
Binary files a/typo3/sysext/workspaces/Documentation/Images/WorkspacePreviewIcon.png and /dev/null differ
index bfda40e..3e9e543 100644 (file)
Binary files a/typo3/sysext/workspaces/Documentation/Images/WorkspaceSplitPreview.png and b/typo3/sysext/workspaces/Documentation/Images/WorkspaceSplitPreview.png differ
index 38aa398..90b4521 100644 (file)
@@ -1,21 +1,14 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. This is 'Includes.txt'. It is included at the very top of each and
+   every ReST source file in THIS documentation project (= manual).
 
-.. This is 'Includes.txt'. It is included at the very top of each and
-   every ReST source file in this documentation project (= manual).
+.. role:: aspect (emphasis)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: typoscript(code)
 
+.. role:: ts(typoscript)
+   :class: typoscript
 
-.. ==================================================
-.. DEFINE SOME TEXTROLES
-.. --------------------------------------------------
-
-.. role::   typoscript(code)
-
-.. role::   ts(typoscript)
-   :class:  typoscript
-
-.. role::   php(code)
-
+.. default-role:: code
 .. highlight:: php
index cc66478..855aa1f 100644 (file)
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: Includes.txt
+.. include:: Includes.txt
 
 
 .. _start:
@@ -22,13 +17,13 @@ Workspaces and Versioning
       en
 
 :Description:
-      Workspace functionality for TYPO3.
+      Workspace functionality for TYPO3 CMS.
 
 :Keywords:
       worspaces
 
 :Copyright:
-      2000-2014
+      2000-2016
 
 :Author:
       TYPO3 CMS Core Development Team
@@ -58,6 +53,5 @@ a GNU/GPL CMS/Framework available from `www.typo3.org
    Introduction/Index
    Administration/Index
    UsersGuide/Index
-   CustomWorkspace/Index
    Targets
 
index 414a623..988fc94 100644 (file)
@@ -18,12 +18,12 @@ Introduction
 About this document
 ^^^^^^^^^^^^^^^^^^^
 
-This document explains how versioning and workspaces function in TYPO3
+This document explains how versioning and workspaces function in TYPO3 CMS
 and how they are set up. The first part explains the technical
 background for administrators or developers who want to make their
 extensions version aware. The second part is for users of workspaces,
 a short guide about what is possible and how to use workspaces. The
-last parts shows how to create a custom workspace.
+last part shows how to create a custom workspace.
 
 
 .. _credits:
@@ -43,10 +43,6 @@ Feedback
 ^^^^^^^^
 
 If you find a bug either in this manual or in the workspaces /
-versioning extensions please use our bug tracker at
-`http://forge.typo3.org/projects/typo3v4-workspaces/issues
-<http://forge.typo3.org/projects/typo3v4-workspaces/issues>`_
-
-If you have a question please ask on the projects mailing list / news
-group: typo3.project.workflow
+versioning extensions please use the bug tracker at
+https://forge.typo3.org/projects/typo3cms-core/issues.
 
index 9a43049..3e6adb4 100644 (file)
@@ -1,11 +1,19 @@
 [general]
 
 project     = Workspaces Management
-version     = 7
-release     = 7
+version     = 8
+release     = 8
 t3author    = Workspaces Team
 copyright   = 1997-2016
 
 description = This is the documentation of TYPO3's system
       extension 'workspaces' which adds the functionality of
       custom stages to TYPO3.
+
+[intersphinx_mapping]
+
+; in this manual we actually use:
+
+t3api        = http://docs.typo3.org/typo3cms/CoreApiReference/
+t3tca        = http://docs.typo3.org/typo3cms/TCAReference/
+t3inside     = https://docs.typo3.org/typo3cms/InsideTypo3Reference/
diff --git a/typo3/sysext/workspaces/Documentation/Settings.yml b/typo3/sysext/workspaces/Documentation/Settings.yml
deleted file mode 100644 (file)
index 48625c1..0000000
+++ /dev/null
@@ -1,11 +0,0 @@
-# This is the project specific Settings.yml file.
-# Place Sphinx specific build information here.
-# Settings given here will replace the settings of 'conf.py'.
-
----
-conf.py:
-  copyright: 1997-2016
-  project: Workspaces Management
-  version: 7
-  release: 7
-...
index c7c43c0..ba01986 100644 (file)
@@ -1,13 +1,10 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: Includes.txt
 
-.. include:: Includes.txt
+.. only:: html
 
-.. _index-labels-for-crossreferencing:
+.. _Targets-for-Cross-Referencing:
 
-Index: Labels for Crossreferencing
-==================================
+Targets for Cross-Referencing
+=============================
 
 .. ref-targets-list::
index 4575469..34c323e 100644 (file)
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: ../Includes.txt
 
 
 .. _users-guide:
@@ -11,7 +6,7 @@
 Users Guide
 -----------
 
-This section shortly covers the workspace related features in the
+This section covers the workspace-related features in the
 backend.
 
 Most significantly workspaces have a selector box in the upper right
@@ -24,25 +19,19 @@ corner of the backend.
 
 
 In this selector box you can choose between the workspaces available.
-The whole backend reloads each time he changes workspace. This is
-necessary because the backend might be differently composed depending
-on the workspace the user is in.
+The whole backend reloads each time one changes workspace.
 
-You can easily see in which workspace you are currently in when
-looking at the top frame of your backend:
+As a visual reminder that you are currently in a workspace, a section
+of the top bar changes to a different color:
 
 .. figure:: ../Images/WorkspaceIndicator.png
    :alt: Workspace indicator
 
-   Current workspace highlighted in the top bar
-
+   Activation of a workspace highlighted in the top bar
 
-When the background is orange colored you are in a workspace. The
-workspace name is appended to your username (in this case **@News**).
 
-When you are in a draft workspace (any workspace that is not live) and
-start editing a page or create a new page a new version of that page
-is automatically created for you.
+As soon as you start editing inside a workspace, new versions
+get created for you.
 
 A page which has a change in the current workspace is highlighted in
 the page tree:
@@ -53,7 +42,7 @@ the page tree:
    Modified page highlighted in the page tree
 
 
-The module  **Web > Workspaces** allows you to monitor changes in a
+The module **WEB > Workspaces** allows you to monitor changes in a
 workspace:
 
 .. figure:: ../Images/WorkspaceModuleOverview.png
@@ -62,37 +51,50 @@ workspace:
    An overview of the changes in the workspaces module
 
 
-This view shows you the live version and the workspace version. If you
-open the detail view of a change you can see a comparison view which
-helps you to understand what has changed in the draft version.
+First of all you get an overview of all changes in the current
+workspace and the current page (or below, if so defined). This is
+also the control center for reviewing, editing and sending any change
+to another stage. All these operations are detailed below. The icons
+correspond to the following operations:
 
-(In the example the text was added in the workspace version). You can
-also raise the stage of the content for review, you can publish,
-preview etc.
+#. *Show changes*: opens the detailed view
 
-**Previewing content** in the workspace is easy. You can use the eye
-icon anywhere while working in a workspace, for example from the page
-module or with the save & view button.
+#. *Swap*: swaps the workspace and live version of that record
 
-.. figure:: ../Images/PageViewIcon.png
-   :alt: View page button
+#. *Preview element*: opens the preview window
 
-   Previewing the page from the Web > Page module
+#. *Edit element*: edits the record
 
-.. figure:: ../Images/WorkspaceModuleOverview.png
-   :alt: Save and view content
+#. *Open version of page*: switches to the **WEB > Page** module
+
+#. *Discard*: discards the change
+
+#. selects the record. Once a records is selected, the two action
+   menus at the bottom left become active.
 
-   Clicking save & view will trigger a preview
+The third menu at the bottom of the view is called the "mass action"
+menu (:ref:`detailed below <users-guide-mass-action>`).
 
+You can also switch workspace by clicking on the corresponding tab.
 
-You can also directly use the workspaces module:
+The detailed view opens in a popup with the full history information.
 
-.. figure:: ../Images/WorkspacePreviewIcon.png
-   :alt: Preview from workspaces module
+.. figure:: ../Images/WorkspaceModuleChangeDetails.png
+   :alt: Viewing details of a change
 
-   Calling the preview from the workspaces module
+   Viewing all details about a change
 
 
+.. _users-guide-preview:
+
+Previewing content
+^^^^^^^^^^^^^^^^^^
+
+When in a workspace, as soon as you hit the "View webpage" button
+or use the "Save and view page" action, you will access the workspace
+preview. This is also possible straight from the *Workspaces* module,
+when clicking on the "Preview element" button.
+
 The workspaces preview is a simultaneous view of the live and
 workspace version. The default selection is to show the workspace
 version and to display a slider with which it is possible to change
@@ -105,65 +107,79 @@ right corner you can change the mode to - for example - vertical split:
    Changing the workspaces split preview
 
 
-The custom Workspace is adequately described in the content sensitive
-help so no more details will be given here.
+Clicking on the "List view" tab leads you to the same view as the
+*Workspaces* module.
+
 
-The workspace technology offers a simple scheme for **staging content
-through review to publication**. In the Workspace Manager you can
-"raise content" to the next level and attach a comment while doing so:
+.. _users-guide-preview-link:
 
-.. figure:: ../Images/SendToNextStage.png
-   :alt: Send to next stage
+Generating a preview link
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
-   Sending a change to the next review stage
+An additional feature of workspace is that a special preview link
+can be generated. It can be shared with anyone, even with people
+who have no access whatsoever to the TYPO3 CMS installation. With
+this link, people are able to view the page as it appears in the
+given workspace.
 
-.. figure:: ../Images/SendToNextStageMessage.png
-   :alt: Next stage message
+Simply hit the "Generate page preview links" button in the docheader
+and copy the link from the popup window:
 
-   Adding a message upon sending to the next stage
+.. figure:: ../Images/PreviewLink.png
+   :alt: The preview link
 
+   The preview link appears in a popup window
 
-The stage in this case is raised to "Approval by Head of Marketing"
-and will be reflected in the interface:
 
-.. figure:: ../Images/ChangeInTheNextStage.png
-   :alt: Change into next stage
 
-   The change is now in the next stage
+.. _users-guide-review-process:
 
+Review process
+^^^^^^^^^^^^^^
 
-If the change that was made is rejected by the reviewer of the next
-stage it can be sent back with a comment, so that the "creator" of the
-content can adjust the element:
+Sending a change to another stage in the review process is
+achieved via the detailed view popup window:
 
-.. figure:: ../Images/ChangeRejected.png
-   :alt: Rejected change
+.. figure:: ../Images/SendToAnotherStage.png
+   :alt: Send to another stage
 
-   The rejected change and the ensuing discussion
+   Sending a change to the previous or next stage
 
 
-If the reviewer is ok with the change, he can send the change on to
-the next stage – either another review level or the "ready to publish"
-state. Depending on the configuration of the workspace the workspace
-owner or any member with access to the LIVE workspace can then publish
-the change. Note that it is possible for anyone that is allowed to
+The change can either be sent to the next stage or sent
+back to the previous one. Once a stage has been selected,
+another popup window appears for entering a message:
+
+.. figure:: ../Images/SendToStageMessage.png
+   :alt: Send to stage message
+
+   Adding a message upon sending to another stage
+
+
+The messages are visible as comments in the change history.
+
+Once the change reaches the "Ready to publish" stage, anyone with the
+proper rights can publish it to the LIVE version, upon which it is
+visible on the web site. Note that it is possible for anyone that is allowed to
 publish to directly publish from any stage. A change does therefore
 not necessary need to have been in all stages.
 
-Sending elements to another stage can either be done individually for
-each element with the arrow buttons in an elements row or via the
-select box in the bottom left corner. You can select multiple rows by
-using the checkbox of each row and then select the action you want to
-do:
+It is also possible to send a change to another stage by selecting it
+in the overview and using the menu at the bottom left:
+
+.. figure:: ../Images/IndividualActions.png
+   :alt: Individual stage actions
 
-.. figure:: ../Images/ChangeRejected.png
-   :alt: Rejected change
+   Sending one or more changes directly to some other stage
 
-   The rejected change and the ensuing discussion
 
+.. _users-guide-mass-action:
+
+The mass action menu
+^^^^^^^^^^^^^^^^^^^^
 
 You can also publish, swap or discard a **whole workspace** at once with
-the second select box on the bottom. This select box – called "Mass
+the third menu at the bottom. This select box – called "Mass
 Actions" - is only active when no element is selected:
 
 .. figure:: ../Images/MassActionsMenu.png
@@ -174,65 +190,22 @@ Actions" - is only active when no element is selected:
 
 .. important::
 
-   It is worth stating again that the mass actions affect the **whole workspace**,
+   The mass actions affect the **whole workspace**,
    which means even the changes that may not currently be visible in the
    workspaces module because they are not within the currently selected
    branch in the page tree.
 
 
-For each element in the list you can access **control buttons** for
-*swap*, *send to previous/next stage*, *show preview*,
-*edit element*, *open the element in the page module* and *discard changes*.
-
-.. figure:: ../Images/IndividualControlButtons.png
-   :alt: Individual control buttons
+.. _users-guide-log:
 
-   The control buttons for a given change set
+Workspace log
+^^^^^^^^^^^^^
 
 
-In the Web > List view of the live workspace you can see which elements have
-versioned counterparts:
-
-.. figure:: ../Images/VersionsInListView.png
-   :alt: Versions in the list view
-
-   Elements with several versions are clearly marked in the Web > List view
-
-
-The **system log** will also reflect operations in the workspace. The
-"User" column is tagged with the id of the workspace in which the
-action took place:
+The **system log** will also reflect operations in the workspace. In the
+"User" column the name of the workspace appears below the username:
 
 .. figure:: ../Images/WorkspaceLogging.png
    :alt: Workspaces and logging
 
    Log of workspaces-related operations
-
-
-**Setting up access to workspaces:** To give a user access to the live
-workspace you have to check the corresponding checkbox in his backend
-user record or in his backend user group record:
-
-.. figure:: ../Images/SettingWorkspacesPermissions.png
-   :alt: Workspaces permissions
-
-   Setting workspaces permissions
-
-
-For :ref:`custom workspaces <custom-workspace>` users or groups are assigned
-directly in the configuration record of the workspace:
-
-.. figure:: ../Images/CustomWorkspacesPermissions.png
-   :alt: Workspaces permissions
-
-   Setting permissions for a custom workspace
-
-
-.. tip::
-
-   In most typical cases the average backend user only works in a custom
-   workspace and therefore cannot change live content before a supervisor
-   with access to the Live workspace will enter the backend and publish
-   the workspace content.
-
-