OpenUI5 Documentation Update 03.12.2024

SAP · Dec 3, 2024 · 669d4bd · 669d4bd
1 parent b55c297
commit 669d4bd
Show file tree

Hide file tree

Showing 43 changed files with 174 additions and 170 deletions.
diff --git a/docs/0index.md b/docs/0index.md
@@ -336,16 +336,16 @@ OpenUI5 Version for the OpenUI5 Demo Kit
                 -   [Handling IDs in UI Components](Handling_IDs_in_UI_Components_562803c.md)
                 -   [The Owner Component](The_Owner_Component_a7a3138.md)
                 -   [Advanced Concepts for OpenUI5 Components](Advanced_Concepts_for_OpenUI5_Components_ecbc417.md)
-            -   [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md)
-                -   [Migrating from Component Metadata to Descriptor](Migrating_from_Component_Metadata_to_Descriptor_e282db2.md)
-                -   [Descriptor for Libraries](Descriptor_for_Libraries_b229914.md)
-                -   [Descriptor for Components \(Inside Libraries\)](Descriptor_for_Components_Inside_Libraries_7701636.md)
+            -   [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md)
+                -   [Migrating from Component Metadata to Manifest](Migrating_from_Component_Metadata_to_Manifest_e282db2.md)
+                -   [Manifest for Libraries](Manifest_for_Libraries_b229914.md)
+                -   [Manifest for Components \(Inside Libraries\)](Manifest_for_Components_Inside_Libraries_7701636.md)
                 -   [The resources.json File](The_resources_json_File_adcbcf8.md)
-                -   [Creating a Descriptor File for Existing Apps](Creating_a_Descriptor_File_for_Existing_Apps_3a9baba.md)
-                    -   [Migration Information for Upgrading the Descriptor File](Migration_Information_for_Upgrading_the_Descriptor_File_a110f76.md)
-                -   [Descriptor Dependencies to Libraries and Components](Descriptor_Dependencies_to_Libraries_and_Components_8521ad1.md)
+                -   [Creating a Manifest File for Existing Apps](Creating_a_Manifest_File_for_Existing_Apps_3a9baba.md)
+                    -   [Migration Information for Upgrading the Manifest File](Migration_Information_for_Upgrading_the_Manifest_File_a110f76.md)
+                -   [Manifest Dependencies to Libraries and Components](Manifest_Dependencies_to_Libraries_and_Components_8521ad1.md)
                 -   [Manifest Model Preload](Manifest_Model_Preload_26ba6a5.md)
-                -   [Enabling the Automatic SAP Fiori 2.0 Header Adaptation in the Descriptor](Enabling_the_Automatic_SAP_Fiori_2_0_Header_Adaptation_in_the_Descriptor_0635156.md)
+                -   [Enabling the Automatic SAP Fiori 2.0 Header Adaptation in the Manifest](Enabling_the_Automatic_SAP_Fiori_2_0_Header_Adaptation_in_the_Manifest_0635156.md)
         -   [Model View Controller \(MVC\)](Model_View_Controller_MVC_91f2334.md)
             -   [Models](Models_d2c8cf7.md)
             -   [Views](Views_91f27e3.md)

diff --git a/docs/App_Overview_The_Basic_Files_of_Your_App_28b59ca.md b/docs/App_Overview_The_Basic_Files_of_Your_App_28b59ca.md
@@ -80,7 +80,7 @@ All apps are started using an HTML page that loads OpenUI5 and the component. Yo
 
 [App Initialization: What Happens When an App Is Started?](App_Initialization_What_Happens_When_an_App_Is_Started_d2f5869.md "When a user starts an app (in the SAP Fiori launchpad (FLP) or using an HTML page), several steps will be performed in the background.")
 
-[Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md "The descriptor for applications, components, and libraries (in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The descriptor provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
+[Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md "The manifest (also known as descriptor for applications, components, and libraries, in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The manifest provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
 
 [Model View Controller \(MVC\)](Model_View_Controller_MVC_91f2334.md "The Model View Controller (MVC) concept is used in OpenUI5 to separate the representation of information from the user interaction. This separation facilitates development and the changing of parts independently.")
 

diff --git a/docs/Assigning_the_Model_to_the_UI_91f0d1c.md b/docs/Assigning_the_Model_to_the_UI_91f0d1c.md
@@ -99,5 +99,5 @@ Choose one of the following options:
 
 [Components](Components_958ead5.md "Components are independent and reusable parts used in OpenUI5 applications.")
 
-[Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md "The descriptor for applications, components, and libraries (in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The descriptor provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
+[Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md "The manifest (also known as descriptor for applications, components, and libraries, in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The manifest provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
 
diff --git a/docs/Best_Practices_for_Developers_28fcd55.md b/docs/Best_Practices_for_Developers_28fcd55.md
@@ -337,14 +337,14 @@ Implement strict error handling to address critical issues.
 
 -   Define the `appData/manifest/i18n` section in the `.library` file or the `sap.app/i18n` section in the `manifest.json`, so that the framework can load resource bundles in advance.
 
--   Properly define library dependencies in all places where it is required. For more information, see [Dependencies to Libraries](Descriptor_Dependencies_to_Libraries_and_Components_8521ad1.md#loio8521ad1955f340f9a6207d615c88d7fd__section_DEPLIB).
+-   Properly define library dependencies in all places where it is required. For more information, see [Dependencies to Libraries](Manifest_Dependencies_to_Libraries_and_Components_8521ad1.md#loio8521ad1955f340f9a6207d615c88d7fd__section_DEPLIB).
 
 
 **Additional Information:**
 
 -   [The library.js File](The_library_js_File_bd039ed.md)
 -   [Defining Control Properties](Defining_Control_Properties_ac56d92.md)
--   [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md)
+-   [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md)
 
 ***
 

diff --git a/docs/Cards_5b46b03.md b/docs/Cards_5b46b03.md
@@ -407,7 +407,7 @@ Example:
 
 [Components](Components_958ead5.md "Components are independent and reusable parts used in OpenUI5 applications.")
 
-[Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md "The descriptor for applications, components, and libraries (in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The descriptor provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
+[Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md "The manifest (also known as descriptor for applications, components, and libraries, in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The manifest provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
 
 [Grid Controls](Grid_Controls_32d4b9c.md "OpenUI5 provides several different grid layouts that are suitable for different use cases.")
 

diff --git a/docs/Component_Metadata_0187ea5.md b/docs/Component_Metadata_0187ea5.md
@@ -13,7 +13,7 @@ view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/0187ea
 The component class provides specific metadata for components by extending the `ManagedObject` class. The `UIComponent` class provides additional metadata for the configuration of user interfaces or the navigation between views.
 
 > ### Note:  
-> With the introduction of the descriptor for applications, components, and libraries, we recommend to migrate the component metadata to the descriptor. The descriptor is inspired by W3C’s Web Application Manifest and provides comprehensive information for applications, components and libraries. For more information, see [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md). The metadata property `manifest` must be set to `json` to indicate that the `manifest.json` file should be loaded and used:
+> With the introduction of the descriptor for applications, components, and libraries, we recommend to migrate the component metadata to the descriptor. The descriptor is inspired by W3C’s Web Application Manifest and provides comprehensive information for applications, components and libraries. For more information, see [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md). The metadata property `manifest` must be set to `json` to indicate that the `manifest.json` file should be loaded and used:
 > 
 > ```js
 > // "Component" required from module "sap/ui/core/Component"

diff --git a/docs/Components_958ead5.md b/docs/Components_958ead5.md
@@ -30,7 +30,7 @@ OpenUI5 provides the following two types of components:
 
 The `sap.ui.core.Component` class is the base class and provides the metadata for both types of components. To extend the functionality, components can inherit from their base class or from another component.
 
-Components are loaded and created via the component factory function `sap.ui.component`. You can either pass the name of the component or the URL of the descriptor file \(`manifest.json`\) to load it via the descriptor, see [Manifest First Function](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md#loiobe0cf40f61184b358b5faedaec98b2da__manifirst). We recommend loading the component using the descriptor \(if available\) - it improves performance during the initial load since the loading process can be parallelized and optimized.
+Components are loaded and created via the component factory function `sap.ui.component`. You can either pass the name of the component or the URL of the descriptor file \(`manifest.json`\) to load it via the descriptor, see [Manifest First Function](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md#loiobe0cf40f61184b358b5faedaec98b2da__manifirst). We recommend loading the component using the descriptor \(if available\) - it improves performance during the initial load since the loading process can be parallelized and optimized.
 
 After loading the descriptor, the component factory can load the dependencies \(OpenUI5 libraries and other dependent components\) in parallel next to the component preload, and also models can be preloaded.
 
@@ -42,7 +42,7 @@ After loading the descriptor, the component factory can load the dependencies \(
 
 A component is organized in a unique namespace, the namespace of the component equals the component name.
 
-Basically, a component consists of the component controller \(`Component.js`\) and a descriptor \(`manifest.json`\). Only the component controller is mandatory, but we recommend to also use the descriptor file. The descriptor then contains the component metadata, and also expresses the component dependencies and configuration \(see [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md)\). All required and optional resources of the component have to be organized in the namespace of the component.
+Basically, a component consists of the component controller \(`Component.js`\) and a descriptor \(`manifest.json`\). Only the component controller is mandatory, but we recommend to also use the descriptor file. The descriptor then contains the component metadata, and also expresses the component dependencies and configuration \(see [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md)\). All required and optional resources of the component have to be organized in the namespace of the component.
 
 > ### Note:  
 > Optional resources are, for example, `CSS`, `js`, or `i18n` files, views, and controllers.
@@ -99,7 +99,7 @@ Advanced concepts for components include routing and navigation and component da
 **Related Information**  
 
 
-[Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md "The descriptor for applications, components, and libraries (in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The descriptor provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
+[Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md "The manifest (also known as descriptor for applications, components, and libraries, in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The manifest provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
 
 [API Reference: `sap.ui.core.Component`](https://sdk.openui5.org/api/sap.ui.core.Component)
 
diff --git a/...criptor_File_for_Existing_Apps_3a9baba.md → ...anifest_File_for_Existing_Apps_3a9baba.md b/...criptor_File_for_Existing_Apps_3a9baba.md → ...anifest_File_for_Existing_Apps_3a9baba.md
@@ -8,9 +8,9 @@
 
 view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/3a9babace121497abea8f0ea66e156d9) | [demo kit latest release](https://sdk.openui5.org/topic/3a9babace121497abea8f0ea66e156d9)</div>
 
-## Creating a Descriptor File for Existing Apps
+## Creating a Manifest File for Existing Apps
 
-Detailed description of the steps needed to create a descriptor V2 for applications file for an existing transactional app created by the customer based on SAP Fiori.
+Detailed description of the steps needed to create a manifest \(also known as descriptor\) V2 for applications file for an existing transactional app created by the customer based on SAP Fiori.
 
 1.  Create the `manifest.json` file.
 
@@ -727,7 +727,8 @@ To verify that your app works as before, perform checks to make sure the followi
 -   Navigation works as before
 
 
--   **[Migration Information for Upgrading the Descriptor File](Migration_Information_for_Upgrading_the_Descriptor_File_a110f76.md "Information how to add new attributes of descriptor versions higher than V2 (OpenUI5
-		1.30) to the descriptor file.")**  
-Information how to add new attributes of descriptor versions higher than V2 \(OpenUI5 1.30\) to the descriptor file.
+-   **[Migration Information for Upgrading the Manifest File](Migration_Information_for_Upgrading_the_Manifest_File_a110f76.md "Information how to add new attributes of manifest (also known as descriptor) versions
+		higher than V2 (OpenUI5 1.30) to
+		the manifest file.")**  
+Information how to add new attributes of manifest \(also known as descriptor\) versions higher than V2 \(OpenUI5 1.30\) to the manifest file.
 
diff --git a/docs/Declarative_API_for_Initial_Components_82a0fce.md b/docs/Declarative_API_for_Initial_Components_82a0fce.md
@@ -128,7 +128,7 @@ The `ComponentSupport` module enforces asynchronous module loading of the compon
 -   `lifecycle` \{\*sap.ui.core.ComponentLifecycle\*\} \(defaults to `Container`\)
 -   `autoPrefixId` \{\*boolean\*\} \(defaults to `true`\)
 
-For details on the manifest, see [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md).
+For details on the manifest, see [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md).
 
 See also [`ComponentSupport`](https://sdk.openui5.org/api/module:sap/ui/core/ComponentSupport) and [`ComponentContainer`](https://sdk.openui5.org/api/sap.ui.core.ComponentContainer) for more information. 
 

diff --git a/docs/Deprecated_jQuery_sap_API_Replacement_a075ed8.md b/docs/Deprecated_jQuery_sap_API_Replacement_a075ed8.md
@@ -2399,7 +2399,7 @@ Complex Replacement
 
 **Apps Used Within the SAP Fiori launchpad**
 
-Register your local UI5 reuse components and UI5 libraries in the manifest.json under `sap.ui5/componentUsages` and `sap.ui5/dependencies/libs`, respectively. For more information, see [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md) and [Descriptor Dependencies to Libraries and Components](Descriptor_Dependencies_to_Libraries_and_Components_8521ad1.md).
+Register your local UI5 reuse components and UI5 libraries in the manifest.json under `sap.ui5/componentUsages` and `sap.ui5/dependencies/libs`, respectively. For more information, see [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md) and [Manifest Dependencies to Libraries and Components](Manifest_Dependencies_to_Libraries_and_Components_8521ad1.md).
 
 **Standalone Apps**
 
@@ -2435,7 +2435,7 @@ Complex Replacement
 
 **Apps Used Within the SAP Fiori launchpad**
 
-Register your local UI5 reuse components and UI5 libraries in the manifest.json under `sap.ui5/componentUsages` and `sap.ui5/dependencies/libs`, respectively. For more information, see [Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md) and [Descriptor Dependencies to Libraries and Components](Descriptor_Dependencies_to_Libraries_and_Components_8521ad1.md).
+Register your local UI5 reuse components and UI5 libraries in the manifest.json under `sap.ui5/componentUsages` and `sap.ui5/dependencies/libs`, respectively. For more information, see [Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md) and [Manifest Dependencies to Libraries and Components](Manifest_Dependencies_to_Libraries_and_Components_8521ad1.md).
 
 **Standalone Apps**
Original file line number	Diff line number	Diff line change
Expand Up		@@ -99,5 +99,5 @@ Choose one of the following options:

		[Components](Components_958ead5.md "Components are independent and reusable parts used in OpenUI5 applications.")

		[Descriptor for Applications, Components, and Libraries \(manifest.json\)](Descriptor_for_Applications_Components_and_Libraries_manifest_json_be0cf40.md "The descriptor for applications, components, and libraries (in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The descriptor provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")
		[Manifest \(Descriptor for Applications, Components, and Libraries\)](Manifest_Descriptor_for_Applications_Components_and_Libraries_be0cf40.md "The manifest (also known as descriptor for applications, components, and libraries, in short: app descriptor) is inspired by the WebApplication Manifest concept introduced by the W3C. The manifest provides a central, machine-readable, and easy-to-access location for storing metadata associated with an application, an application component, or a library.")