[470859] Update documentation to reflect the compartment feature state

Bug: 470859
Change-Id: I96d9494f047e632bf6c270903d4864da0c34f77c
Signed-off-by: Maxime Porhel <maxime.porhel@obeo.fr>

4 files changed, 18 insertions, 11 deletions

diff --git a/plugins/org.eclipse.sirius.diagram/model/diagram.genmodel b/plugins/org.eclipse.sirius.diagram/model/diagram.genmodel
index 6effa898af..081f6c4608 100644
--- a/plugins/org.eclipse.sirius.diagram/model/diagram.genmodel
+++ b/plugins/org.eclipse.sirius.diagram/model/diagram.genmodel
@@ -470,7 +470,7 @@
             propertyDescription="" ecoreFeature="ecore:EReference diagram.ecore#//description/ContainerMapping/allContainerMappings"/>
         <genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference diagram.ecore#//description/ContainerMapping/style"/>
         <genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference diagram.ecore#//description/ContainerMapping/conditionnalStyles"/>
-        <genFeatures createChild="false" propertyCategory="General" propertyDescription="Tell whether the container will display it's children as list elements, as shapes or as regions (experimental)."
+        <genFeatures createChild="false" propertyCategory="General" propertyDescription="Tell whether the container will display it's children as list elements, as shapes or as regions."
             ecoreFeature="ecore:EAttribute diagram.ecore#//description/ContainerMapping/childrenPresentation"/>
         <genOperations ecoreOperation="diagram.ecore#//description/ContainerMapping/getBestStyle">
           <genParameters ecoreParameter="diagram.ecore#//description/ContainerMapping/getBestStyle/modelElement"/>
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html
index 4c3b2e0347..974df55c62 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html
@@ -650,15 +650,16 @@
 			<img border="0" src="images/styles/Containers_with_compartments.png"/>
 		</p>
 		<p>
-			<em>Warning:</em> The compartment feature is new but experimental in Sirius 3.0.0. While working reliably, it has some limitations but you can rely on the improved VSM validation to ensure you are using it in supported modes. Known limitations:
+			<em>Warning:</em> The compartment feature has been introduced in Sirius 3.0.0. While working reliably, it has some limitations but you can rely on the improved VSM validation to ensure you are using it in supported modes. Known limitations:
 		</p>
 		<ul>
-			<li>Some formatting or layout-related actions might produce unexpected result (Make same size, width or height, Set style to workspace image). The limitations only concerns the visual aspects, there is no risk of corrupting the underlying models.</li>
-			<li>Only the gradient style is supported for Region container and Region mappings.</li>
+			<li>Only the gradient and image style are supported for Region container and Region mappings.</li>
 			<li>The Show/Hide, Hide filter features are disabled on regions (hide filter can be created to the compartment content but not the compartment). The Show/Hide label feature is supported.</li>
-			<li>The figure default and minimum size might change in future versions.</li>
 			<li>The move and drag and drop of regions are disabled. Reordering regions can be done by reordering their semantic elements.</li>
 			<li>The resize of compartments might evolve in future versions. The current behavior is to redistribute space between adjacent regions and to resize the first/last region when the region container is resized from top/bottom for a vertical stack and left/right for an horizontal one.</li>
+			<li>The capability to define complex or recursive stack of regions mixing both stack directions has been introduced in Sirius 3.1.0 as an 
+				<em>experimental</em> configuration. Some layout-related actions might produce unexpected result. The limitations only concerns the visual aspects, there is no risk of corrupting the underlying models.
+			</li>
 		</ul>
 		<h4 id="container_styles">Container Styles</h4>
 		<p>See the 
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile
index 0a62d5b6a4..c4108eeef3 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile
@@ -190,13 +190,12 @@ p(#compartments). *Compartments* You can enable a special "compartment mode" for
 
 !images/styles/Containers_with_compartments.png!
 
-_Warning:_ The compartment feature is new but experimental in Sirius 3.0.0. While working reliably, it has some limitations but you can rely on the improved VSM validation to ensure you are using it in supported modes. Known limitations:
-* Some formatting or layout-related actions might produce unexpected result (Make same size, width or height, Set style to workspace image). The limitations only concerns the visual aspects, there is no risk of corrupting the underlying models.
-* Only the gradient style is supported for Region container and Region mappings.
+_Warning:_ The compartment feature has been introduced in Sirius 3.0.0. While working reliably, it has some limitations but you can rely on the improved VSM validation to ensure you are using it in supported modes. Known limitations:
+* Only the gradient and image style are supported for Region container and Region mappings.
 * The Show/Hide, Hide filter features are disabled on regions (hide filter can be created to the compartment content but not the compartment). The Show/Hide label feature is supported.
-* The figure default and minimum size might change in future versions.
 * The move and drag and drop of regions are disabled. Reordering regions can be done by reordering their semantic elements.
 * The resize of compartments might evolve in future versions. The current behavior is to redistribute space between adjacent regions and to resize the first/last region when the region container is resized from top/bottom for a vertical stack and left/right for an horizontal one.
+* The capability to define complex or recursive stack of regions mixing both stack directions has been introduced in Sirius 3.1.0 as an _experimental_ configuration. Some layout-related actions might produce unexpected result. The limitations only concerns the visual aspects, there is no risk of corrupting the underlying models.
 
 h4(#container_styles). Container Styles
 
diff --git a/plugins/org.eclipse.sirius.editor.diagram/src-gen/org/eclipse/sirius/diagram/editor/properties/sections/description/containermapping/ContainerMappingChildrenPresentationPropertySection.java b/plugins/org.eclipse.sirius.editor.diagram/src-gen/org/eclipse/sirius/diagram/editor/properties/sections/description/containermapping/ContainerMappingChildrenPresentationPropertySection.java
index 2c4a983987..73ba171880 100644
--- a/plugins/org.eclipse.sirius.editor.diagram/src-gen/org/eclipse/sirius/diagram/editor/properties/sections/description/containermapping/ContainerMappingChildrenPresentationPropertySection.java
+++ b/plugins/org.eclipse.sirius.editor.diagram/src-gen/org/eclipse/sirius/diagram/editor/properties/sections/description/containermapping/ContainerMappingChildrenPresentationPropertySection.java
@@ -34,6 +34,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * @see org.eclipse.sirius.diagram.editor.properties.sections.AbstractRadioButtonPropertySection#getDefaultLabelText()
      */
+    @Override
     protected String getDefaultLabelText() {
         return "ChildrenPresentation"; //$NON-NLS-1$
     }
@@ -41,6 +42,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * @see org.eclipse.sirius.diagram.editor.properties.sections.AbstractRadioButtonPropertySection#getLabelText()
      */
+    @Override
     protected String getLabelText() {
         String labelText;
         labelText = super.getLabelText() + "*:"; //$NON-NLS-1$
@@ -53,6 +55,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * @see org.eclipse.sirius.diagram.editor.properties.sections.AbstractRadioButtonPropertySection#getFeature()
      */
+    @Override
     protected EAttribute getFeature() {
         return DescriptionPackage.eINSTANCE.getContainerMapping_ChildrenPresentation();
     }
@@ -60,6 +63,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * @see org.eclipse.sirius.diagram.editor.properties.sections.AbstractRadioButtonPropertySection#getFeatureValue(int)
      */
+    @Override
     protected Object getFeatureValue(int index) {
         return getChoiceOfValues().get(index);
     }
@@ -67,6 +71,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * @see org.eclipse.sirius.diagram.editor.properties.sections.AbstractRadioButtonPropertySection#isEqual(int)
      */
+    @Override
     protected boolean isEqual(int index) {
         return getChoiceOfValues().get(index).equals(eObject.eGet(getFeature()));
     }
@@ -74,6 +79,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * @see org.eclipse.sirius.diagram.editor.properties.sections.AbstractRadioButtonPropertySection#getEnumerationFeatureValues()
      */
+    @Override
     protected List<?> getChoiceOfValues() {
         return ContainerLayout.VALUES;
     }
@@ -81,10 +87,11 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
     /**
      * {@inheritDoc}
      */
+    @Override
     public void createControls(Composite parent, TabbedPropertySheetPage tabbedPropertySheetPage) {
         super.createControls(parent, tabbedPropertySheetPage);
 
-        nameLabel.setToolTipText("Tell whether the container will display it's children as list elements, as shapes or as regions (experimental).");
+        nameLabel.setToolTipText("Tell whether the container will display it's children as list elements, as shapes or as regions.");
 
         CLabel help = getWidgetFactory().createCLabel(composite, "");
         FormData data = new FormData();
@@ -92,7 +99,7 @@ public class ContainerMappingChildrenPresentationPropertySection extends Abstrac
         data.left = new FormAttachment(nameLabel);
         help.setLayoutData(data);
         help.setImage(getHelpIcon());
-        help.setToolTipText("Tell whether the container will display it's children as list elements, as shapes or as regions (experimental).");
+        help.setToolTipText("Tell whether the container will display it's children as list elements, as shapes or as regions.");
         nameLabel.setFont(SiriusEditor.getFontRegistry().get("required"));
 
     }