Skip to content

Commit

Permalink
OpenUI5 Documentation Update 26.03.2024
Browse files Browse the repository at this point in the history
  • Loading branch information
openui5bot committed Mar 26, 2024
1 parent 851d9ca commit 3abc3da
Show file tree
Hide file tree
Showing 147 changed files with 424 additions and 8,687 deletions.
19 changes: 2 additions & 17 deletions docs/0index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ OpenUI5 Version for the OpenUI5 Demo Kit
- [OpenUI5: UI Development Toolkit for HTML5](OpenUI5_UI_Development_Toolkit_for_HTML5_95d113b.md)
- [What's New in OpenUI5](What_s_New_in_OpenUI5_99ac68a.md)
- [What's New in OpenUI5 1.122](What_s_New_in_OpenUI5_1_122_5d078da.md)
- [What's New in OpenUI5 1.121](What_s_New_in_OpenUI5_1_121_91a4a2f.md)
- [Previous Versions](Previous_Versions_6660a59.md)
- [What's New in OpenUI5 1.121](What_s_New_in_OpenUI5_1_121_91a4a2f.md)
- [What's New in OpenUI5 1.120](What_s_New_in_OpenUI5_1_120_2359b63.md)
- [What's New in OpenUI5 1.119](What_s_New_in_OpenUI5_1_119_0b1903a.md)
- [What's New in OpenUI5 1.118](What_s_New_in_OpenUI5_1_118_3eecbde.md)
Expand Down Expand Up @@ -310,11 +310,9 @@ OpenUI5 Version for the OpenUI5 Demo Kit
- [Initialization Process](Initialization_Process_91f2c90.md#loio91f2c9076f4d1014b6dd926db0e91070)
- [Loading of Additional Resources During Bootstrap](Initialization_Process_91f2c90.md#loiobf10bd41ac8f49048a1ccb743fbfbb8a)
- [Dynamic Loading of Libraries](Initialization_Process_91f2c90.md#loiobbce44f06ddc48fda7aeb44eae52ebbc)
- [Deprecated Core API](Deprecated_Core_API_798dd9a.md)
- [Configuration of the OpenUI5 Runtime](Configuration_of_the_OpenUI5_Runtime_91f08de.md)
- [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)
- [Experimental Configuration Options](Experimental_Configuration_Options_b474a71.md)
- [Compatibility Version Information](Compatibility_Version_Information_9feb96d.md)
- [Structuring: Components and Descriptor](Structuring_Components_and_Descriptor_dc9e11c.md)
- [Components](Components_958ead5.md)
Expand Down Expand Up @@ -492,15 +490,6 @@ OpenUI5 Version for the OpenUI5 Demo Kit
- [Using Container Content Padding CSS Classes](Using_Container_Content_Padding_CSS_Classes_c71f6df.md)
- [Enabling Responsive Paddings According to the Control Width](Enabling_Responsive_Paddings_According_to_the_Control_Width_3b718b5.md)
- [Field Groups](Field_Groups_5b07753.md)
- [Declarative Support \(deprecated\)](Declarative_Support_deprecated_91f1301.md)
- [Enabling Declarative Support \(deprecated\)](Enabling_Declarative_Support_deprecated_91f17d6.md)
- [Defining Controls \(deprecated\)](Defining_Controls_deprecated_91f1539.md)
- [Declarative Support: Properties \(deprecated\)](Declarative_Support_Properties_deprecated_91f1619.md)
- [Declarative Support: Associations \(deprecated\)](Declarative_Support_Associations_deprecated_91f13d9.md)
- [Declarative Support: Events \(deprecated\)](Declarative_Support_Events_deprecated_91f15ad.md)
- [Declarative Support: Aggregations \(deprecated\)](Declarative_Support_Aggregations_deprecated_91f136c.md)
- [Declarative Support: Data Binding \(deprecated\)](Declarative_Support_Data_Binding_deprecated_020990b.md)
- [Compiling Declarative HTML \(deprecated\)](Compiling_Declarative_HTML_deprecated_91f1454.md)
- [Error, Warning, and Info Messages](Error_Warning_and_Info_Messages_62b1481.md)
- [Validation Messages](Validation_Messages_a90d93d.md)
- [OData V2 Messages](OData_V2_Messages_81c735e.md)
Expand All @@ -521,8 +510,6 @@ OpenUI5 Version for the OpenUI5 Demo Kit
- [Best Practices for Loading Modules](Best_Practices_for_Loading_Modules_00737d6.md)
- [Troubleshooting for Loading Modules](Troubleshooting_for_Loading_Modules_4363b3f.md)
- [Adapting to the Modularization of the Core](Adapting_to_the_Modularization_of_the_Core_b8fdf0c.md)
- [Legacy jQuery.sap Replacement](Legacy_jQuery_sap_Replacement_a075ed8.md)
- [Legacy Factories Replacement](Legacy_Factories_Replacement_491bd9c.md)
- [Troubleshooting](Troubleshooting_20f6ea7.md)
- [Optimizing Applications](Optimizing_Applications_2f492c4.md)
- [Resource Handling: Modularization and Localization](Resource_Handling_Modularization_and_Localization_91f2b4d.md)
Expand Down Expand Up @@ -839,7 +826,6 @@ OpenUI5 Version for the OpenUI5 Demo Kit
- [Table Design](Table_Design_d3234bc.md)
- [List and Table Events](List_and_Table_Events_35b8a94.md)
- [Growing Feature for Table and List](Growing_Feature_for_Table_and_List_9164ba7.md)
- [Table Personalization \(deprecated\)](Table_Personalization_deprecated_1c60212.md)
- [Performance of Lists and Tables](Performance_of_Lists_and_Tables_f6a1a0a.md)
- [Message Handling](Message_Handling_f5df293.md)
- [Message Popover](Message_Popover_52824a6.md)
Expand All @@ -854,7 +840,6 @@ OpenUI5 Version for the OpenUI5 Demo Kit
- [Split App](Split_App_eedfe79.md)
- [Team Calendar](Team_Calendar_acae0f2.md)
- [Text](Text_f94deb4.md)
- [Upload Collection \(Deprecated\)](Upload_Collection_Deprecated_124ee13.md)
- [URL Helper](URL_Helper_4f1c107.md)
- [Examples for Triggering Telephone, Text and E-Mail Applications](Examples_for_Triggering_Telephone_Text_and_E_Mail_Applications_021ac23.md)
- [sap.tnt](sap_tnt_d8374d5.md)
Expand Down
9 changes: 2 additions & 7 deletions docs/Adapting_to_the_Modularization_of_the_Core_b8fdf0c.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,11 @@ To benefit from the improvements provided by the modules, perform the following

- Always declare the full dependencies as described in [Loading a Module](Loading_a_Module_d12024e.md).

- Migrate to the new module API as described in [Legacy jQuery.sap Replacement](Legacy_jQuery_sap_Replacement_a075ed8.md). Do **not** use the global `jQuery.sap` API anymore.
- Migrate to the new module API as described in [Deprecated jQuery.sap API Replacement](https://help.sap.com/viewer/06dcf306cd6d48098fa341f6f49ddfd9/DEV_OpenUI5/en-US/a075ed88ef324261bca41813a6ac4a1c.html "Overview of the mapping of legacy APIs to the new APIs for the migration") :arrow_upper_right:. Do **not** use the global `jQuery.sap` API anymore.

- Do **not** use the global `sap.ui` factory functions. Instead, use their replacements, see [Legacy Factories Replacement](Legacy_Factories_Replacement_491bd9c.md).
- Do **not** use the global `sap.ui` factory functions. Instead, use their replacements, see [Deprecated Factories Replacement](https://help.sap.com/viewer/06dcf306cd6d48098fa341f6f49ddfd9/DEV_OpenUI5/en-US/491bd9c70b9f4c4d913c8c7b4a970833.html "Overview of the replacement of global functions with the factory functions") :arrow_upper_right:.


- **[Legacy jQuery.sap Replacement](Legacy_jQuery_sap_Replacement_a075ed8.md "Overview of the mapping of legacy APIs to the new APIs for the migration")**
Overview of the mapping of legacy APIs to the new APIs for the migration
- **[Legacy Factories Replacement](Legacy_Factories_Replacement_491bd9c.md "Overview of the replacement of global functions with the factory
functions")**
Overview of the replacement of global functions with the factory functions
- **[Troubleshooting](Troubleshooting_20f6ea7.md "")**


6 changes: 3 additions & 3 deletions docs/Application_Cache_Buster_Configuration_c1c3e2f.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/c1c3e2

## Application Cache Buster: Configuration

The configuration `data-sap-ui-appCacheBuster="./"` must be added to the bootstrap script of the application page.
The configuration `data-sap-ui-app-cache-buster="./"` must be added to the bootstrap script of the application page.

The following code shows an example how the configuration is added to activate the application cache buster:

Expand All @@ -20,10 +20,10 @@ The following code shows an example how the configuration is added to activate t
src="resources/sap-ui-core.js"
data-sap-ui-libs="sap.ui.core,sap.m,sap.ui.table"
data-sap-ui-theme="sap_horizon"
data-sap-ui-appCacheBuster="./"></script>
data-sap-ui-app-cache-buster="./"></script>
```

The parameter `data-sap-ui-appCacheBuster` is a `string[]` which means you can pass a comma-separated list of base URLs pointing to other applications which should be considered by the Application Cache Buster. By default it should contain the base path of your local application.
The parameter `data-sap-ui-app-cache-buster` is a `string[]` which means you can pass a comma-separated list of base URLs pointing to other applications which should be considered by the Application Cache Buster. By default it should contain the base path of your local application.

These base URLs are used to load the index files.

8 changes: 4 additions & 4 deletions docs/Application_Cache_Buster_ff7aced.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Applications provide an index file named `sap-ui-cachebuster-info.json` \(create

The server instructs the client to cache all the above resources \(not using the 304/not modified mechanism\). For the index file we are using the 304/not modified mechanism to avoid to load when it has not been changed.

On the client side, we initially load this file of the application when enabled via configuration option `sap-ui-appcachebuster` and use this for the XHR requests. If the request path is contained in the above mentioned index file we simply add the time stamp as leading path segment to this request. If the time stamp doesn’t change the URL is unique and therefore it will be taken from cache. Once the file is modified the URL parameter will be changed and therefore loaded again from the back end.
On the client side, we initially load this file of the application when enabled via configuration option `sap-ui-app-cache-buster` and use this for the XHR requests. If the request path is contained in the above mentioned index file we simply add the time stamp as leading path segment to this request. If the time stamp doesn’t change the URL is unique and therefore it will be taken from cache. Once the file is modified the URL parameter will be changed and therefore loaded again from the back end.

The server has to delete the time stamp from this URL to look up the file properly. For SAP NetWeaver AS for ABAP, the logic is implemented in the ICF handler. Both back end implementations, SAP NetWeaver AS for Java and SAP NetWeaver AS for ABAP, also generate the index file on-the-fly.

Expand All @@ -30,9 +30,9 @@ The server has to delete the time stamp from this URL to look up the file proper
- **[Application Cache Buster: Index File](Application_Cache_Buster_Index_File_fef5340.md "The index file includes all files that should use the cache buster.")**
The index file includes all files that should use the cache buster.
- **[Application Cache Buster: Configuration](Application_Cache_Buster_Configuration_c1c3e2f.md "The configuration data-sap-ui-appCacheBuster=&quot;./&quot; must be added to
the bootstrap script of the application page.")**
The configuration `data-sap-ui-appCacheBuster="./"` must be added to the bootstrap script of the application page.
- **[Application Cache Buster: Configuration](Application_Cache_Buster_Configuration_c1c3e2f.md "The configuration data-sap-ui-app-cache-buster=&quot;./&quot; must be added to the bootstrap script of the application
page.")**
The configuration `data-sap-ui-app-cache-buster="./"` must be added to the bootstrap script of the application page.
- **[Application Cache Buster: Request Flow](Application_Cache_Buster_Request_Flow_d415dd8.md "When using the application cache buster, a request order must be observed.")**
When using the application cache buster, a request order must be observed.
- **[Application Cache Buster: Enhanced Concept](Application_Cache_Buster_Enhanced_Concept_94e0c33.md "The enhanced concept for application cache buster takes care about most of the URLs in a
Expand Down
4 changes: 2 additions & 2 deletions docs/Basic_Example_How_to_Use_Gherkin_4b0c519.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ Here is a sample HTML bootstrap file for Gherkin. In this example, the feature f
<script
id="sap-ui-bootstrap"
src="https://openui5nightly.hana.ondemand.com/resources/sap-ui-core.js"
data-sap-ui-resourceroots='{"GherkinWithOPA5": "./"}'
data-sap-ui-loglevel="INFO"
data-sap-ui-resource-roots='{"GherkinWithOPA5": "./"}'
data-sap-ui-log-level="INFO"
></script>

<script>
Expand Down
8 changes: 4 additions & 4 deletions docs/Best_Practices_for_Developers_28fcd55.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ Some APIs may be only partially deprecated, for instance passing a non-object `v
- [Don't Use Deprecated or Experimental Features](Don_t_Use_Deprecated_or_Experimental_Features_a8bd1a8.md)
- [Use Only Public APIs](Use_Only_Public_APIs_b0d5fe2.md)
- [Adapting to the Modularization of the Core](Adapting_to_the_Modularization_of_the_Core_b8fdf0c.md)
- [Legacy jQuery.sap Replacement](Legacy_jQuery_sap_Replacement_a075ed8.md)
- [Legacy Factories Replacement](Legacy_Factories_Replacement_491bd9c.md)
- [Deprecated jQuery.sap API Replacement](https://help.sap.com/viewer/06dcf306cd6d48098fa341f6f49ddfd9/DEV_OpenUI5/en-US/a075ed88ef324261bca41813a6ac4a1c.html "Overview of the mapping of legacy APIs to the new APIs for the migration") :arrow_upper_right:
- [Deprecated Factories Replacement](https://help.sap.com/viewer/06dcf306cd6d48098fa341f6f49ddfd9/DEV_OpenUI5/en-US/491bd9c70b9f4c4d913c8c7b4a970833.html "Overview of the replacement of global functions with the factory functions") :arrow_upper_right:

***

Expand Down Expand Up @@ -175,7 +175,7 @@ Identify and resolve cyclic dependencies with the help of the OpenUI5 configurat

**Additional Information:**

- [Deprecated and Experimental Configuration Options](Deprecated_and_Experimental_Configuration_Options_b474a71.md)
- [Experimental Configuration Options](Experimental_Configuration_Options_b474a71.md)

***

Expand All @@ -189,7 +189,7 @@ In the following we'll focus on crucial aspects of app development, specifically
#### Asynchronous Loading
- Use asynchronous loading for views, fragments, and components to enhance performance; see, for example, [Legacy Factories Replacement](Legacy_Factories_Replacement_491bd9c.md).
- Use asynchronous loading for views, fragments, and components to enhance performance; see, for example, [Deprecated Factories Replacement](https://help.sap.com/viewer/06dcf306cd6d48098fa341f6f49ddfd9/DEV_OpenUI5/en-US/491bd9c70b9f4c4d913c8c7b4a970833.html "Overview of the replacement of global functions with the factory functions") :arrow_upper_right:.
- Implement the `sap.ui.core.IAsyncContentCreation` marker interface in your [Component.js file](Component_Controller_27ce0e4.md) to allow the content to be created fully asynchronously and for a stricter handling of certain types of errors during its view processing.
- Load libraries via the new asynchronous APIs in advance before accessing code. Ensure that dependent librares are preloaded through the `manifest.json` in the `sap.ui5/dependencies/libs` section if not already maintained there. For more information, see [Ensure that Library Preloads are Enabled](Performance_Speed_Up_Your_App_408b40e.md#loio408b40efed3c416681e1bd8cdd8910d4__section_LibraryPreloads).
Expand Down
21 changes: 0 additions & 21 deletions docs/Bootstrapping_Loading_and_Initializing_a04b0d1.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,23 +182,6 @@ This file contains most of the modules that are contained in the `sap.ui.core` l
For more information, see [Standard Variant for Bootstrapping](Standard_Variant_for_Bootstrapping_91f1f45.md).

</td>
</tr>
<tr>
<td valign="top">

`sap-ui-core-lean.js`

</td>
<td valign="top">

This bootstrap file is similar to the `sap-ui-core.js` file, but in this use case only the jQuery and one OpenUI5 file are loaded immediately and the other files are loaded dynamically.

> ### Caution:
> This use case is usually **not** used and may be removed in future.


</td>
</tr>
<tr>
Expand Down Expand Up @@ -234,10 +217,6 @@ The noJQuery variant supports bootstrapping for an application that already inte
- **[Initialization Process](Initialization_Process_91f2c90.md#loio91f2c9076f4d1014b6dd926db0e91070 "The initialization process starts after OpenUI5 runtime is
loaded.")**
The initialization process starts after OpenUI5 runtime is loaded.
- **[Deprecated Core API](Deprecated_Core_API_798dd9a.md "This page describes important aspects of the deprecation of the sap.ui.core.Core API facade, as most of its
methods have been deprecated. It shows a migration path away from the deprecated legacy APIs and towards their future-proof
alternatives.")**
This page describes important aspects of the deprecation of the `sap.ui.core.Core` API facade, as most of its methods have been deprecated. It shows a migration path away from the deprecated legacy APIs and towards their future-proof alternatives.
- **[Configuration of the OpenUI5 Runtime](Configuration_of_the_OpenUI5_Runtime_91f08de.md "OpenUI5 provides several options for the configuration of the OpenUI5 runtime. The possible ways to provide input for the available
configuration options are described in detail.")**
OpenUI5 provides several options for the configuration of the OpenUI5 runtime. The possible ways to provide input for the available configuration options are described in detail.
Expand Down
14 changes: 0 additions & 14 deletions docs/Compatibility_Version_Information_9feb96d.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,20 +257,6 @@ By default, the content area of `Dialog` had paddings. To make the padding consi

Default value: 1.14

</td>
</tr>
<tr>
<td valign="top">

`data-sap-ui-bindingSyntax`

</td>
<td valign="top">

This configuration parameter defines whether the simple or the complex binding syntax is used. The parameter only affects bindings that are defined as strings, for example in the constructor of a control, or when specifying a binding in a declarative view, such as an XML view.

For versions lower than 1.28, the default value is `default` which only has very limited features. As of version 1.28, the default is `complex`.

</td>
</tr>
</table>
Expand Down
29 changes: 0 additions & 29 deletions docs/Compiling_Declarative_HTML_deprecated_91f1454.md

This file was deleted.

Loading

0 comments on commit 3abc3da

Please sign in to comment.