OpenUI5 Documentation Update 10.10.2024

SAP · Oct 10, 2024 · faedc3c · faedc3c
1 parent 42b96ab
commit faedc3c
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 50 deletions.
diff --git a/docs/0index.md b/docs/0index.md
@@ -322,7 +322,7 @@ OpenUI5 Version for the OpenUI5 Demo Kit
                 -   [Configuration Options and URL Parameters](Configuration_Options_and_URL_Parameters_91f2d03.md)
                 -   [Deprecated and Experimental Configuration Options](Deprecated_and_Experimental_Configuration_Options_b474a71.md)
                 -   [Deprecated Configuration API](Deprecated_Configuration_API_2acafbf.md)
-                -   [Compatibility Version Information \(deprecated\)](Compatibility_Version_Information_deprecated_9feb96d.md)
+                -   [Compatibility Version Information](Compatibility_Version_Information_9feb96d.md)
         -   [Structuring: Components and Descriptor](Structuring_Components_and_Descriptor_dc9e11c.md)
             -   [Components](Components_958ead5.md)
                 -   [Component Controller](Component_Controller_27ce0e4.md)

diff --git a/...Version_Information_deprecated_9feb96d.md → ...patibility_Version_Information_9feb96d.md b/...Version_Information_deprecated_9feb96d.md → ...patibility_Version_Information_9feb96d.md
@@ -8,22 +8,28 @@
 
 view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/9feb96da02c2429bb1afcf6534d77c79) | [demo kit latest release](https://sdk.openui5.org/topic/9feb96da02c2429bb1afcf6534d77c79)</div>
 
-## Compatibility Version Information \(deprecated\)
+## Compatibility Version Information
 
-Compatibility version flags allow applications to react to incompatible changes in OpenUI5.
+Compatibility version flags were introduced to allow applications to react to incompatible changes in OpenUI5.
 
 > ### Caution:  
-> The concept of compatibility versions has been abandoned as of version 1.28. Therefore, there will be no new compatibility version flags in the future. If you start building a new application please set `data-sap-ui-compat-version="edge"` on your OpenUI5 bootstrap tag.
+> The concept of compatibility versions has been abandoned as of OpenUI5 version 1.28. Therefore, no new compatibility version flags will be introduced in the future. If you start building a new application, please set `data-sap-ui-compat-version="edge"` on your OpenUI5 bootstrap tag. This ensures that the newest behavior of all features is applied.
 
-As described in the compatibility rules, changes to OpenUI5 features are compatible, see [Compatibility Rules](Compatibility_Rules_91f0873.md). In some cases, however, it may make sense to change the behavior of a feature, for example, to change the default values or to use an optimized implementation and these changes may lead to incompatibilities.
+***
+
+<a name="loio9feb96da02c2429bb1afcf6534d77c79__section_dxf_c4r_zcc"/>
+
+### Previous Function of the Compatibility Version Flag \(deprecated\)
+
+As described in the compatibility rules, changes to OpenUI5 features are compatible; see [Compatibility Rules](Compatibility_Rules_91f0873.md) for more information. In some cases, however, it used to make sense to change the behavior of a feature, for example, in order to change the default values or to use an optimized implementation. These changes could result in incompatibilities.
 
 > ### Note:  
 > We recommend adopting new feature versions as soon as possible.
 
-The compatibility version configuration works as follows:
+The compatibility version configuration worked as follows:
 
--   A version flag is introduced if a feature change is incompatible.
--   The version flag has to be defined in the OpenUI5 bootstrap tag either globally \(`data-sap-ui-compat-version` or individually for each feature \(for example `data-sap-ui-compat-version-xyz`\). Example with `compat-version "1.18"`:
+-   A version flag was introduced if a feature change was incompatible.
+-   The version flag had to be defined in the OpenUI5 bootstrap tag, either globally \(via `data-sap-ui-compat-version`\) or individually for each feature \(for example `data-sap-ui-compat-version-xyz`\). Example with `compat-version "1.18"`:
 
     ```html
     <script id="sap-ui-bootstrap" 
@@ -37,9 +43,9 @@ The compatibility version configuration works as follows:
     </script> 
     ```
 
--   If no version is defined, the default behavior of the feature applies.
--   If an explicit version is specified, the behavior of the specified version is applied.
--   If a version edge is specified, the newest behavior of the feature is applied.
+-   If no compatibility version is defined, the default behavior of the feature applies.
+-   If an explicit version is specified, the behavior of the specified version is applied \(deprecated\).
+-   If **`edge`** is specified as the compatibility version, the newest behavior of the feature is applied.
 -   A fallback mechanism is implemented. The following table is an example of possible configuration options for feature "xyz":
 
 
@@ -92,6 +98,8 @@ The compatibility version configuration works as follows:
     <td valign="top">
 
     1.16
+
+    \(deprecated\)
 
     </td>
     <td valign="top">
@@ -136,6 +144,8 @@ The compatibility version configuration works as follows:
     <td valign="top">
 
     1.18
+
+    \(deprecated\)
 
     </td>
     <td valign="top">

diff --git a/docs/Configuration_Options_and_URL_Parameters_91f2d03.md b/docs/Configuration_Options_and_URL_Parameters_91f2d03.md
@@ -1141,6 +1141,35 @@ This configuration setting enables the module loader to load both modules and li
 <tr>
 <td valign="top">
 
+`compat-version` 
+
+</td>
+<td valign="top">
+
+Type: `string`
+
+Default value: `1.14`
+
+> ### Note:  
+> Applications must set this option to `edge`. **Other version definitions are deprecated.**
+
+For more information, see [Compatibility Version Information](Compatibility_Version_Information_9feb96d.md).
+
+</td>
+<td valign="top">
+
+![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
+
+</td>
+<td valign="top">
+
+![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
+
+</td>
+</tr>
+<tr>
+<td valign="top">
+
 `excludejquerycompat`
 
 </td>

diff --git a/docs/Configuration_of_the_OpenUI5_Runtime_91f08de.md b/docs/Configuration_of_the_OpenUI5_Runtime_91f08de.md
@@ -232,7 +232,6 @@ The following tables showdeprecated and experimental configuration options.
 		migration path away from the deprecated legacy APIs and towards their future-proof alternatives, provided the functionality is still meant for
 		productive usage.")**  
 This page describes important aspects of the deprecation of the `sap.ui.core.Configuration` API facade. It shows a migration path away from the deprecated legacy APIs and towards their future-proof alternatives, provided the functionality is still meant for productive usage.
--   **[Compatibility Version Information \(deprecated\)](Compatibility_Version_Information_deprecated_9feb96d.md "Compatibility version flags allow applications to react to incompatible changes in
-			OpenUI5.")**  
-Compatibility version flags allow applications to react to incompatible changes in OpenUI5.
+-   **[Compatibility Version Information](Compatibility_Version_Information_9feb96d.md "Compatibility version flags were introduced to allow applications to react to incompatible changes in OpenUI5.")**  
+Compatibility version flags were introduced to allow applications to react to incompatible changes in OpenUI5.
 
diff --git a/docs/Deprecated_and_Experimental_Configuration_Options_b474a71.md b/docs/Deprecated_and_Experimental_Configuration_Options_b474a71.md
@@ -174,37 +174,6 @@ This configuration parameter defines whether the simple or the complex binding s
 <tr>
 <td valign="top">
 
-`compat-version`
-
-\(deprecated\)
-
-</td>
-<td valign="top">
-
-Type: `string`
-
-Default value: `1.14`
-
-> ### Note:  
-> Applications must set this option to `edge`. **Other version definitions are deprecated.**
-
-For more information, see [Compatibility Version Information \(deprecated\)](Compatibility_Version_Information_deprecated_9feb96d.md).
-
-</td>
-<td valign="top">
-
-![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
-
-</td>
-<td valign="top">
-
-![NO](images/loiodfb38de82f6d46dab60cb1397e3ed8ae_LowRes.png)
-
-</td>
-</tr>
-<tr>
-<td valign="top">
-
 `format-settings`
 
 \(deprecated\)

diff --git a/docs/Step_2_Bootstrap_fe12df2.md b/docs/Step_2_Bootstrap_fe12df2.md
@@ -110,7 +110,7 @@ In the next steps, the structure of a UI5 module will be explained in detail.
 **Related Information**  
 
 
-[Compatibility Version Information \(deprecated\)](Compatibility_Version_Information_deprecated_9feb96d.md "Compatibility version flags allow applications to react to incompatible changes in OpenUI5.")
+[Compatibility Version Information](Compatibility_Version_Information_9feb96d.md "Compatibility version flags were introduced to allow applications to react to incompatible changes in OpenUI5.")
 
 [Bootstrapping: Loading and Initializing](Bootstrapping_Loading_and_Initializing_a04b0d1.md "To use OpenUI5 features in your HTML page, you have to load and initialize the SAPUI5 library.")
 

diff --git a/docs/index.json b/docs/index.json
@@ -997,8 +997,8 @@
 									"Deprecated Configuration API": {
 										"link": "Deprecated_Configuration_API_2acafbf.md"
 									},
-									"Compatibility Version Information \\(deprecated\\)": {
-										"link": "Compatibility_Version_Information_deprecated_9feb96d.md"
+									"Compatibility Version Information": {
+										"link": "Compatibility_Version_Information_9feb96d.md"
 									}
 								}
 							}

diff --git a/docs/index.md b/docs/index.md
@@ -322,7 +322,7 @@ OpenUI5 Version for the OpenUI5 Demo Kit
                 -   [Configuration Options and URL Parameters](Configuration_Options_and_URL_Parameters_91f2d03.md)
                 -   [Deprecated and Experimental Configuration Options](Deprecated_and_Experimental_Configuration_Options_b474a71.md)
                 -   [Deprecated Configuration API](Deprecated_Configuration_API_2acafbf.md)
-                -   [Compatibility Version Information \(deprecated\)](Compatibility_Version_Information_deprecated_9feb96d.md)
+                -   [Compatibility Version Information](Compatibility_Version_Information_9feb96d.md)
         -   [Structuring: Components and Descriptor](Structuring_Components_and_Descriptor_dc9e11c.md)
             -   [Components](Components_958ead5.md)
                 -   [Component Controller](Component_Controller_27ce0e4.md)

diff --git a/docs/sidebar.md b/docs/sidebar.md
@@ -316,7 +316,7 @@
                 -   [Configuration Options and URL Parameters](Configuration_Options_and_URL_Parameters_91f2d03.md)
                 -   [Deprecated and Experimental Configuration Options](Deprecated_and_Experimental_Configuration_Options_b474a71.md)
                 -   [Deprecated Configuration API](Deprecated_Configuration_API_2acafbf.md)
-                -   [Compatibility Version Information \(deprecated\)](Compatibility_Version_Information_deprecated_9feb96d.md)
+                -   [Compatibility Version Information](Compatibility_Version_Information_9feb96d.md)
         -   [Structuring: Components and Descriptor](Structuring_Components_and_Descriptor_dc9e11c.md)
             -   [Components](Components_958ead5.md)
                 -   [Component Controller](Component_Controller_27ce0e4.md)