Skip to content

Commit

Permalink
OpenUI5 Documentation Update 09.11.2023
Browse files Browse the repository at this point in the history
  • Loading branch information
openui5bot committed Nov 9, 2023
1 parent d26b09f commit 855c208
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/Code_Coverage_20737a4.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ For more information, see the documentation for `Blanket.js` on GitHub. Keep in
**Related Information**


[`Blanket.js` Documentation on GitHub](https://github.com/alex-seville/blanket/blob/master/docs/intermediate_browser.md)
[`Blanket.js` Documentation on GitHub](https://github.com/alex-seville/blanket/blob/-/docs/intermediate_browser.md)

[`UI5 Middleware Code Coverage` repo on GitHub](https://github.com/SAP/ui5-tooling-extensions/tree/main/packages/middleware-code-coverage)
[`UI5 Middleware Code Coverage` repo on GitHub](https://github.com/SAP/ui5-tooling-extensions/blob/-/packages/middleware-code-coverage)

[Code Coverage Measurement](Code_Coverage_Measurement_7ef3242.md "You can measure the code coverage either via HTML or JavaScript code using a code coverage tool like Istanbul (default) or Blanket.js (legacy).")

4 changes: 2 additions & 2 deletions docs/Code_Coverage_Measurement_7ef3242.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ In this example the coverage is limited to one specific file - the only one that
**Related Information**


[`UI5 Middleware Code Coverage`](https://github.com/SAP/ui5-tooling-extensions/tree/main/packages/middleware-code-coverage)
[`UI5 Middleware Code Coverage`](https://github.com/SAP/ui5-tooling-extensions/blob/-/packages/middleware-code-coverage)

[More information about `Blanket.js`](https://github.com/alex-seville/blanket/blob/master/docs/intermediate_browser.md)
[More information about `Blanket.js`](https://github.com/alex-seville/blanket/blob/-/docs/intermediate_browser.md)

2 changes: 1 addition & 1 deletion docs/Custom_Model_91f1c7e.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ To instantiate a custom model, proceed as follows:
4. To enable the sorting functionality, use the `Sorter` class in your binding implementation.


You can find all necessary classes in the `sap.ui.model` namespace. As a starting point, take a look at the `JSONModel` implementation in `sap.ui.model.json.JSONModel`, which is available on the SAP Open Source GitHub at [https://github.com/SAP/openui5/blob/master/src/sap.ui.core/src/sap/ui/model/json/JSONModel.js](https://github.com/SAP/openui5/blob/master/src/sap.ui.core/src/sap/ui/model/json/JSONModel.js).
You can find all necessary classes in the `sap.ui.model` namespace. As a starting point, take a look at the `JSONModel` implementation in `sap.ui.model.json.JSONModel`, which is available on the SAP Open Source GitHub at [https://github.com/SAP/openui5/blob/-/src/sap.ui.core/src/sap/ui/model/json/JSONModel.js](https://github.com/SAP/openui5/blob/-/src/sap.ui.core/src/sap/ui/model/json/JSONModel.js).

2 changes: 1 addition & 1 deletion docs/JSDoc_Guidelines_eeaa5de.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/eeaa5d

## JSDoc Guidelines

General UI5 JSDoc guidelines are available at [OpenUI5 JSDoc Guidelines](https://github.com/SAP/openui5/blob/master/docs/guidelines/jsdoc.md).
General UI5 JSDoc guidelines are available at [OpenUI5 JSDoc Guidelines](https://github.com/SAP/openui5/blob/-/docs/guidelines/jsdoc.md).

2 changes: 1 addition & 1 deletion docs/OpenUI5_Framework_Development_ee8726a.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ view on: [demo kit nightly build](https://sdk.openui5.org/nightly/#/topic/ee8726

This UI5 Developer's Guide contains information relevant for UI5 app developers. Information for framework developers is maintained on GitHub.

OpenUI5 content is developed in an environment based on Node.js. [UI5 Tooling](https://sap.github.io/ui5-tooling/) is used as development server and build tool. If you are interested in OpenUI5 framework development, see the [GitHub OpenUI5 project](https://github.com/SAP/openui5/blob/master/docs/developing.md), where you can find documentation on the initial setup, development workflow, and how tests are executed.
OpenUI5 content is developed in an environment based on Node.js. [UI5 Tooling](https://sap.github.io/ui5-tooling/) is used as development server and build tool. If you are interested in OpenUI5 framework development, see the [GitHub OpenUI5 project](https://github.com/SAP/openui5/blob/-/docs/developing.md), where you can find documentation on the initial setup, development workflow, and how tests are executed.

3 changes: 3 additions & 0 deletions docs/Routing_Configuration_9023130.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ The `config` section contains the global router configuration and default values
> ### Note:
> If you use asynchronous loading, you cannot rely on the sequence of events that are fired during the load phase. If you follow our programming model with MVC, this should not be a problem.
> ### Note:
> If the `Component.js` implements the `sap.ui.core.IAsyncContentCreation` interface, the default value for `async` is set to `true`, so no `async` config needs to be set in the `manifest.json`.
- Using the `bypassed` parameter, you specify the navigation target that is used whenever no navigation pattern is matched. If you use this setting, you also have to define a corresponding target in the `targets` section.


Expand Down
2 changes: 1 addition & 1 deletion docs/SAPUI5_vs_OpenUI5_5982a97.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The additional libraries in SAPUI5 include more controls on top, like charts, an

OpenUI5 is Open Source, and is available on [GitHub](https://github.com/SAP/openui5/).

If you find a bug or have an idea for a new feature - just go ahead and propose a GitHub issue or a change. But before you do so, please just read our guidelines first: [Contributing to OpenUI5](https://github.com/SAP/openui5/blob/master/CONTRIBUTING.md).
If you find a bug or have an idea for a new feature - just go ahead and propose a GitHub issue or a change. But before you do so, please just read our guidelines first: [Contributing to OpenUI5](https://github.com/SAP/openui5/blob/-/CONTRIBUTING.md).

***

Expand Down
4 changes: 2 additions & 2 deletions docs/Server_Messages_in_the_OData_V4_Model_fbe1cb5.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ a property of `Edm.String` type, which is nullable
</tr>
</table>

\*\) In the error response this is represented by an instance annotation in the SAP Common vocabulary, [com.sap.vocabularies.Common.v1](https://github.com/SAP/odata-vocabularies/blob/master/vocabularies/Common.md)
\*\) In the error response this is represented by an instance annotation in the SAP Common vocabulary, [com.sap.vocabularies.Common.v1](https://github.com/SAP/odata-vocabularies/blob/-/vocabularies/Common.md)

End user messages contain the following information:

Expand Down Expand Up @@ -604,5 +604,5 @@ Let `messageModel` be the named message model. A table row with messages can be
**Related Information**
[https://github.com/SAP/odata-vocabularies/blob/master/vocabularies/Common.md](https://github.com/SAP/odata-vocabularies/blob/master/vocabularies/Common.md)
[https://github.com/SAP/odata-vocabularies/blob/-/vocabularies/Common.md](https://github.com/SAP/odata-vocabularies/blob/-/vocabularies/Common.md)
2 changes: 1 addition & 1 deletion docs/Step_27_Unit_Test_with_QUnit_e1ce1de.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ We add a new folder `unit` under the `test` folder and a `model` subfolder where

***

### webapp/test/unit/model/formatter.js
### webapp/test/unit/model/formatter.js \(New\)

```js
sap.ui.define([
Expand Down
4 changes: 2 additions & 2 deletions docs/Step_37_Accessibility_ff7cab1.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,12 +171,12 @@ Here, we add the text for the rating panel title and the labels for the ARIA reg
<tr>
<td valign="top">

**Landmarks on the overview page - before**![The graphic has an explanatory text.](images/loio54e9bca5a5844c14b45b5405496166b1_HiRes.png)
![Landmarks before](images/loio54e9bca5a5844c14b45b5405496166b1_HiRes.png)

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

**Landmarks on the overview page - after**![The graphic has an explanatory text.](images/loiof38dee2624c2437d8977de70575b3eae_HiRes.png)
![Landmarks after](images/loiof38dee2624c2437d8977de70575b3eae_HiRes.png)

</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/Step_3_Controls_ddbceec.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Now it is time to build our first little UI by replacing the “Hello World” t

**The "Hello World" text is now displayed by a OpenUI5 control**

![The Hello World text is now displayed by a OpenUI5 control](images/loio30a42d381b9e4388bf7fdc0b941e5381_LowRes.png "The "Hello World" text is now displayed by a OpenUI5
![Hello World](images/loio30a42d381b9e4388bf7fdc0b941e5381_LowRes.png "The "Hello World" text is now displayed by a OpenUI5
control")

***
Expand Down
2 changes: 1 addition & 1 deletion docs/Step_3_Extending_the_Worklist_Table_84100bc.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ tableNoDataText=No products are currently available
Finally, we modify the existing column names in the resource bundle file `webapp/i18n/i18n.properties` to match our scenario and add the new texts for the column titles.

> ### Note:
> The `webapp/i18n/i18n.properties` file contains some annotations for each key in the file. These annotations offer some more context, which can help translators to better interpret the semantics of the text belonging to the keys. An example for such an annotation is XTIT in the `i18n.properties` file above, which tells that the corresponding key is supposed to be used as a title. The guidelines at [https://github.com/SAP/openui5/blob/master/docs/guidelines/translationfiles.md](https://github.com/SAP/openui5/blob/master/docs/guidelines/translationfiles.md) give you a better idea of how this can be used. Be aware that this is how SAP uses the annotations internally. In case you want to use this approach to work with your own translators make sure that you agree on a common set of allowed annotations that everybody understands.
> The `webapp/i18n/i18n.properties` file contains some annotations for each key in the file. These annotations offer some more context, which can help translators to better interpret the semantics of the text belonging to the keys. An example for such an annotation is XTIT in the `i18n.properties` file above, which tells that the corresponding key is supposed to be used as a title. The guidelines at [https://github.com/SAP/openui5/blob/-/docs/guidelines/translationfiles.md](https://github.com/SAP/openui5/blob/-/docs/guidelines/translationfiles.md) give you a better idea of how this can be used. Be aware that this is how SAP uses the annotations internally. In case you want to use this approach to work with your own translators make sure that you agree on a common set of allowed annotations that everybody understands.
> ### Tip:
> **Testing the responsiveness of the app**
Expand Down
2 changes: 1 addition & 1 deletion docs/Step_4_XML_Views_1409791.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ OpenUI5 supports multiple view types \(XML, HTML, JavaScript\). When working wit

**The "Hello World" text is now displayed by a OpenUI5 control \(No visual changes to last step\)**

![The Hello World text is now displayed by a OpenUI5 control (No visual changes to last step)](images/loio05f6775a39d3409ea673f4acc3812142_LowRes.png "The "Hello World" text is now displayed by a OpenUI5 control (No
![Hello World](images/loio05f6775a39d3409ea673f4acc3812142_LowRes.png "The "Hello World" text is now displayed by a OpenUI5 control (No
visual changes to last step)")

***
Expand Down

0 comments on commit 855c208

Please sign in to comment.