Skip to content

Commit 988b648

Browse files
committed
docs(tutorials): use OpenUI5 wording and SDK doc links
Align all tutorials to OpenUI5: - Replace remaining "SAPUI5" wording with "OpenUI5" in navigation and odatav4 step READMEs and in navigation i18n appDescription strings. - Point doc/API links at the OpenUI5 SDK: rewrite ui5.sap.com/#/... to sdk.openui5.org/#/... and repair malformed sdk.openui5.org links that were missing the /#/ route (walkthrough step 03). - Normalize SDK topic links (full topic hashes, consistent /topic/ path). Project config was already OpenUI5-correct: every ui5.yaml uses framework OpenUI5 with OpenUI5-only libraries, and every package.json depends on @openui5/types.
1 parent 7438090 commit 988b648

41 files changed

Lines changed: 74 additions & 74 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

packages/navigation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Navigation and Routing Tutorial
22

3-
SAPUI5 comes with a powerful routing API that helps you control the state of your application efficiently. This tutorial will illustrate all major features and APIs related to navigation and routing in SAPUI5 apps by creating a simple and easy to understand mobile app. It represents a set of best practices for applying the navigation and routing features of SAPUI5 to your applications.
3+
OpenUI5 comes with a powerful routing API that helps you control the state of your application efficiently. This tutorial will illustrate all major features and APIs related to navigation and routing in OpenUI5 apps by creating a simple and easy to understand mobile app. It represents a set of best practices for applying the navigation and routing features of OpenUI5 to your applications.
44

55
In classical Web applications, the server determines which resource is requested based on the URL pattern of the request and serves it accordingly. The server-side logic controls how the requested resource or page is displayed in an appropriate way.
66

packages/navigation/steps/01/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
We start by setting up a simple app for this tutorial. The app displays mock data only and mimics real OData back-end calls with the mock server as you have seen in the *Walkthrough* tutorial.
44

5-
The structure and data model created in this step will be used throughout the rest of this tutorial. The initial app created in this step will be extended in the subsequent steps to illustrate the navigation and routing features of SAPUI5.
5+
The structure and data model created in this step will be used throughout the rest of this tutorial. The initial app created in this step will be extended in the subsequent steps to illustrate the navigation and routing features of OpenUI5.
66

77
## Preview
88

@@ -53,11 +53,11 @@ webapp/
5353
5454
## The Initial App
5555

56-
With the downloaded coding, you have an initial app with recommended settings that provides the basic features of an SAPUI5 app:
56+
With the downloaded coding, you have an initial app with recommended settings that provides the basic features of an OpenUI5 app:
5757

5858
- **Home Page**
5959

60-
The home page of our app is defined in the `webapp/index.html` file. In this file we bootstrap SAPUI5 and tell the runtime where to find our custom resources. Furthermore, we initialize the `MockServer` to simulate back-end requests as we do not have a real back-end service throughout this tutorial. Finally, we instantiate the application component, assign it to a `sap.m.Shell` control, and place the shell into the body. The corresponding `Component.ts` file in the `webapp` folder will be extended throughout this tutorial.
60+
The home page of our app is defined in the `webapp/index.html` file. In this file we bootstrap OpenUI5 and tell the runtime where to find our custom resources. Furthermore, we initialize the `MockServer` to simulate back-end requests as we do not have a real back-end service throughout this tutorial. Finally, we instantiate the application component, assign it to a `sap.m.Shell` control, and place the shell into the body. The corresponding `Component.ts` file in the `webapp` folder will be extended throughout this tutorial.
6161

6262
- **Data**
6363

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# App Descriptor
22
appTitle=Navigation & Routing Tutorial
3-
appDescription=A simple app that explains how to use navigation and routing features of SAPUI5
3+
appDescription=A simple app that explains how to use navigation and routing features of OpenUI5
44

55
iWantToNavigate=I want to navigate
66
homePageTitle=Home

packages/navigation/steps/02/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ webapp/
9090

9191
```
9292

93-
Single-page applications based on SAPUI5 can use a so-called “router” to dispatch hash-based URLs to one or more views of the app. Therefore, the router needs to know how to address and show the views. In SAPUI5, we can simply add a `routing` section to our existing `sap.ui5` section in the descriptor file to configure the router. There are three properties that can be used to configure the routing of your application:
93+
Single-page applications based on OpenUI5 can use a so-called “router” to dispatch hash-based URLs to one or more views of the app. Therefore, the router needs to know how to address and show the views. In OpenUI5, we can simply add a `routing` section to our existing `sap.ui5` section in the descriptor file to configure the router. There are three properties that can be used to configure the routing of your application:
9494

9595
- `config`
9696

@@ -110,7 +110,7 @@ Single-page applications based on SAPUI5 can use a so-called “router” to dis
110110
This basic routing configuration was easy enough. However, you can’t see it in action until you have initialized the router.
111111

112112
> :note:
113-
> As of SAPUI5 version 1.30, we recommend that you define the routing in the `manifest.json` descriptor file using routes and targets. In older versions of SAPUI5, the routing configuration had to be done directly in the metadata section of the component, and with different syntax.
113+
> As of OpenUI5 version 1.30, we recommend that you define the routing in the `manifest.json` descriptor file using routes and targets. In older versions of OpenUI5, the routing configuration had to be done directly in the metadata section of the component, and with different syntax.
114114
115115
## `webapp/Component.ts/.js`
116116

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# App Descriptor
22
appTitle=Navigation & Routing Tutorial
3-
appDescription=A simple app that explains how to use navigation and routing features of SAPUI5
3+
appDescription=A simple app that explains how to use navigation and routing features of OpenUI5
44

55
iWantToNavigate=I want to navigate
66
homePageTitle=Home

packages/navigation/steps/03/webapp/i18n/i18n.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# App Descriptor
22
appTitle=Navigation & Routing Tutorial
3-
appDescription=A simple app that explains how to use navigation and routing features of SAPUI5
3+
appDescription=A simple app that explains how to use navigation and routing features of OpenUI5
44

55
iWantToNavigate=I want to navigate
66
homePageTitle=Home

packages/navigation/steps/04/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The function checks if there is a previous hash value in the app history. If so,
128128
The third parameter of `navTo("appHome", {}, true /*no history*/);` has the value `true` and makes sure that the hash is replaced. With the line `sap.ui.core.UIComponent.getRouterFor(this)` you can easily access your component’s router throughout the app. To make it even more comfortable, we also add a handy shortcut `getRouter` to the base controller. This function is now available in each subclass as well. It is also used in the `onNavBack` handler to get a reference to the router before calling `navTo`. We now have to implement the reuse in all other controllers.
129129

130130
> :note:
131-
> In SAPUI5 there are multiple options to reuse code. We recommend to use a base controller for such helper methods because this allows us to decoratively use the `onNavBack` handler directly in any XML view without adding additional code to the controller. Our base controller is an abstract controller that will not be instantiated in any view. Therefore, the naming convention `*.controller.ts` does not apply, and we can just name the file `BaseController.ts`. By not using the naming convention `*.controller.ts` we can even prevent any unintentional usage in views.
131+
> In OpenUI5 there are multiple options to reuse code. We recommend to use a base controller for such helper methods because this allows us to decoratively use the `onNavBack` handler directly in any XML view without adding additional code to the controller. Our base controller is an abstract controller that will not be instantiated in any view. Therefore, the naming convention `*.controller.ts` does not apply, and we can just name the file `BaseController.ts`. By not using the naming convention `*.controller.ts` we can even prevent any unintentional usage in views.
132132
133133
## `webapp/controller/NotFound.controller.ts/.js`
134134

packages/navigation/steps/04/webapp/i18n/i18n.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# App Descriptor
22
appTitle=Navigation & Routing Tutorial
3-
appDescription=A simple app that explains how to use navigation and routing features of SAPUI5
3+
appDescription=A simple app that explains how to use navigation and routing features of OpenUI5
44

55
iWantToNavigate=I want to navigate
66
homePageTitle=Home

packages/navigation/steps/05/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Next, we have to register an event handler to the `display` event of the `notFou
197197
198198
From the router reference we can fetch a reference to the `notFound` target. Each target configuration will create a runtime object that can be accessed through the router.
199199
200-
Similar to SAPUI5 controls, targets define API methods and events that can be attached. We attach a display event handler and save the configuration that was received as the event parameter `data` in an internal controller variable `this.data`. This also includes the `fromTarget` information in case the caller passed it on. However, we now have to override the base controller’s `onNavBack` implementation to change the behavior a bit. We add a special case for our *Back* functionality in case the `fromTarget` property has been passed on. If specified, we simply display the target defined as `fromTarget` manually the same way we actually called the `notFound` target manually. Otherwise we just call the `onNavBack` implementation in the `BaseController`.
200+
Similar to OpenUI5 controls, targets define API methods and events that can be attached. We attach a display event handler and save the configuration that was received as the event parameter `data` in an internal controller variable `this.data`. This also includes the `fromTarget` information in case the caller passed it on. However, we now have to override the base controller’s `onNavBack` implementation to change the behavior a bit. We add a special case for our *Back* functionality in case the `fromTarget` property has been passed on. If specified, we simply display the target defined as `fromTarget` manually the same way we actually called the `notFound` target manually. Otherwise we just call the `onNavBack` implementation in the `BaseController`.
201201
202202
## webapp/i18n/i18n.properties
203203

packages/navigation/steps/05/webapp/i18n/i18n.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# App Descriptor
22
appTitle=Navigation & Routing Tutorial
3-
appDescription=A simple app that explains how to use navigation and routing features of SAPUI5
3+
appDescription=A simple app that explains how to use navigation and routing features of OpenUI5
44

55
iWantToNavigate=I want to navigate
66
homePageTitle=Home

0 commit comments

Comments
 (0)