Skip to content

Commit 1b7d934

Browse files
authored
fixes
1 parent 255134e commit 1b7d934

File tree

7 files changed

+32
-39
lines changed

7 files changed

+32
-39
lines changed

docs/development/general.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# General
22

3-
abap2UI5 offers great flexibility in developing your app. Most samples follow a process similar to the sequence shown below. Use it as a starting point, and feel free to create your own sequence or build a wrapper on top of abap2UI5.
3+
abap2UI5 offers great flexibility in app development. Most sample applications follow a process similar to the sequence outlined below. You can use it as a starting point, but feel free to create your own sequence or build a wrapper on top of abap2UI5 for more customized behavior:
44

55
```abap
66
CLASS z2ui5_cl_app DEFINITION PUBLIC.
@@ -47,4 +47,4 @@ CLASS z2ui5_cl_app IMPLEMENTATION.
4747
ENDMETHOD.
4848
ENDCLASS.
4949
````
50-
Refer to the specific sections of this development guide for more details on implementation.
50+
Refer to the specific sections of this development guide for more details on the implementation process.

docs/development/messages.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ outline: [2, 4]
44

55
# Messages, Errors
66

7-
Outputting messages and errors is an everyday requirement for ABAP developers. Functions are provided for the most common situations.
7+
Displaying messages and errors is an everyday requirement for ABAP developers. The following functions handle the most common scenarios.
88

99
#### Message Toast
1010

11-
Messages that are displayed for a short period, such as success notifications, can be shown with:
11+
For short-duration messages, such as success notifications, you can use the message toast:
1212

1313
```abap
1414
METHOD z2ui5_if_app~main.
@@ -20,7 +20,7 @@ ENDMETHOD.
2020

2121
#### Message Box
2222

23-
If you want to ensure that the user acknowledges the message, you can display a message box that requires a manual close:
23+
If you want the user to acknowledge the message, you can display a message box that requires manual closure:
2424

2525
```abap
2626
METHOD z2ui5_if_app~main.
@@ -43,7 +43,7 @@ ENDMETHOD.
4343
```
4444

4545
#### SY, BAPIRET, CX_ROOT
46-
Common message structures, objects, and variables can be passed directly to the functions:
46+
You can directly pass common message structures, objects, and variables to the functions:
4747
###### SY
4848
```abap
4949
METHOD z2ui5_if_app~main.
@@ -81,10 +81,10 @@ METHOD z2ui5_if_app~main.
8181
8282
ENDMETHOD.
8383
```
84-
Many other imports are supported. Just import your message structure, and the message box will display it.
84+
Other imports are supported as well. Simply import your message structure, and the message box will display it.
8585

8686
#### Popup Multi Message
87-
The message box provides basic output, if you want to generate a detailed output, use the popup `z2ui5_cl_pop_messages`:
87+
The message box provides basic output. For a more detailed output, use the popup `z2ui5_cl_pop_messages`:
8888
```abap
8989
METHOD z2ui5_if_app~main.
9090
@@ -97,7 +97,7 @@ METHOD z2ui5_if_app~main.
9797
ENDMETHOD.
9898
```
9999
#### Popup Error
100-
To show a detailed view of your exception:
100+
To show a detailed view of your exception, use the following code:
101101
```abap
102102
METHOD z2ui5_if_app~main.
103103
@@ -110,7 +110,7 @@ METHOD z2ui5_if_app~main.
110110
ENDMETHOD.
111111
```
112112
#### Popup Confirm
113-
If interaction is required, the `z2ui5_cl_pop_to_confirm` can be used:
113+
If interaction is required, you can use `z2ui5_cl_pop_to_confirm`:
114114
```abap
115115
METHOD z2ui5_if_app~main.
116116
@@ -128,15 +128,15 @@ METHOD z2ui5_if_app~main.
128128
ENDMETHOD.
129129
```
130130
#### Uncatched Errors
131-
What happens if errors are uncaught? In this case, the default HTTP handler exception output is used. The processing is interrupted and the user need to refresh the browser. So only use this for unexpected behaviour:
131+
What happens if errors are uncaught? In this case, the default HTTP handler exception output is used. The processing is interrupted, and the user will need to refresh the browser. Use this only for unexpected behavior:
132132
```abap
133133
METHOD z2ui5_if_app~main.
134134
135135
ASSERT 1 = `This is an error message!`.
136136
137137
ENDMETHOD.
138138
```
139-
Or achieve the same behavior with an uncaught exception:
139+
Alternatively, achieve the same behavior with an uncaught exception:
140140
```abap
141141
METHOD z2ui5_if_app~main.
142142
@@ -145,5 +145,5 @@ METHOD z2ui5_if_app~main.
145145
ENDMETHOD.
146146
```
147147
::: tip **Improvements**
148-
All these message functions are continually improved. Feel free to open an issue if you encounter errors or incompatibilities, or submit a PR to extend the functionality.
148+
These message functions are continually being improved. Feel free to open an issue if you encounter errors or incompatibilities, or submit a PR to extend the functionality.
149149
:::

docs/development/model.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ outline: [2, 4]
33
---
44
# Model
55

6-
There are three ways to exchange data with the frontend in abap2UI5.
6+
In abap2UI5, there are three ways to exchange data with the frontend.
77

88
#### One-Way Binding
9+
Use one-way binding when you need to display data on the frontend without allowing changes. The `client->_bind` method sends data to the frontend and connects it to the view:
910

10-
When you need to display data on the frontend without allowing any changes, use one-way binding. The `client->_bind` method sends the data to the frontend and connects it to the view:
1111
```abap
1212
CLASS z2ui5_cl_app_hello_world DEFINITION PUBLIC.
1313
@@ -29,10 +29,10 @@ CLASS z2ui5_cl_app_hello_world IMPLEMENTATION.
2929
ENDMETHOD.
3030
ENDCLASS.
3131
```
32-
This method also works for tables, trees, and other complex data structures. For more details, refer to the samples repository and explore the table or tree samples.
32+
This method works with tables, trees, and other complex data structures. For more details, refer to the samples repository and explore the table or tree samples.
3333

3434
#### Two-Way Binding
35-
If the user should be able to modify data, enable two-way binding to update data in the ABAP backend. Use the `client->_bind_edit` method so that after an event, the framework will synchronize the data with your ABAP class.
35+
If the user should be able to modify data, enable two-way binding to update the data in the ABAP backend. Use the `client->_bind_edit` method so that, after an event, the framework will synchronize the data with your ABAP class:
3636

3737
```abap
3838
CLASS z2ui5_cl_app_hello_world DEFINITION PUBLIC.
@@ -64,7 +64,7 @@ ENDCLASS.
6464
```
6565

6666
#### Local Binding
67-
When you only have local access to data but want to bind it for display (e.g., for a value help or lookup), use local binding. The `client->_bind_local` method copies the data and sends it to the frontend without impacting backend logic:
67+
When you only have local access to data but still want to bind it for display (e.g., for value help or lookups), use local binding. The `client->_bind_local` method copies the data and sends it to the frontend:
6868

6969
```abap
7070
CLASS z2ui5_cl_app_hello_world DEFINITION PUBLIC.
@@ -88,8 +88,8 @@ CLASS z2ui5_cl_app_hello_world IMPLEMENTATION.
8888
ENDMETHOD.
8989
ENDCLASS.
9090
```
91-
For an example of local binding in action, see the value help use case in `Z2UI5_CL_DEMO_APP_002`.
91+
For an example of local binding in action, refer to the value help use case in `Z2UI5_CL_DEMO_APP_002`.
9292

9393
::: tip **Data in Public Attributes**
94-
When using One-Way or Two-Way binding, remember to store your data in public attributes of your class, as the framework needs to access it from outside. This is similar to the PBO/PAI screen days, where data needed to be stored in global variables.
94+
When using One-Way or Two-Way binding, ensure your data is stored in the public attributes of your class. This allows the framework to access it from outside. This is similar to the PBO/PAI screen days, where data had to be stored in global variables.
9595
:::

docs/development/popups.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ ENDMETHOD.
2323
```
2424

2525
#### Flow Logic
26-
Typically, a common flow for using popups involves displaying a normal view, then showing a popup, and finally closing it. Here’s how this can be structured:
27-
26+
A common flow for using popups typically involves displaying a normal view, then showing a popup, and finally closing it. Here’s how to structure this:
2827
```abap
2928
METHOD Z2UI5_if_app~main.
3029
@@ -62,12 +61,10 @@ ENDMETHOD.
6261
```
6362

6463
#### Separated App
65-
For better source code structure, it's possible to encapsulate the popups in separate classes and call them through navigation.
64+
For better source code structure, it's possible to encapsulate popups in separate classes and call them through navigation.
6665

6766
### Popover
68-
69-
Use the method client->popover_display and specify the ID of the control where you want to display the popover:
70-
67+
To display a popover, use the method `client->popover_display` and specify the ID of the control where you want the popover to appear:
7168
```abap
7269
METHOD Z2UI5_if_app~main.
7370
@@ -108,7 +105,6 @@ ENDMETHOD.
108105
```
109106

110107
### Built-in Popups
111-
112108
Several pre-built popup classes are available for specific scenarios:
113109

114110
* z2ui5_cl_pop_error
@@ -126,4 +122,4 @@ Several pre-built popup classes are available for specific scenarios:
126122
* z2ui5_cl_pop_textedit
127123
* z2ui5_cl_pop_to_confirm
128124
* z2ui5_cl_pop_to_inform
129-
* z2ui5_cl_pop_to_select
125+
* z2ui5_cl_pop_to_select

docs/development/translation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ outline: [2, 4]
66
In UI5 apps, translations are typically managed through i18n files, with translation content stored in frontend artifacts. In abap2UI5, since all apps reside on the ABAP backend, we can leverage ABAP's built-in translation mechanisms, such as text elements or message classes.
77

88
### Text Element
9-
The message can be translated using the ABAP text element mechanism, making it available in different languages without changing the code:
9+
Messages can be translated using the ABAP text elements, making them available in different languages without changing the code:
1010
```abap
1111
METHOD z2ui5_if_app~main.
1212
@@ -17,7 +17,7 @@ ENDMETHOD.
1717
```
1818

1919
### Messages
20-
Messages are translated using message classes, which ensures that translations are managed centrally and can be maintained easily in different languages:
20+
Messages are translated using message classes, ensuring that translations are managed centrally and can be maintained easily in different languages:
2121
```abap
2222
METHOD z2ui5_if_app~main.
2323
@@ -28,7 +28,7 @@ ENDMETHOD.
2828
```
2929

3030
### Data Element
31-
You can also retrieve and display the short, medium, or long descriptions of data elements (DD04T). Heres how to access these text types programmatically:
31+
You can also retrieve and display the short, medium, or long descriptions of data elements (DD04T). Here's how to access these text types programmatically:
3232

3333
::: code-group
3434

docs/development/troubleshooting.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,4 @@ Here, you can inspect the XML View and check the Data Model bound to the view.
1717

1818
##### UI5 Inspector
1919

20-
Another useful option is SAP’s default debugging tool, the [UI5 Inspector.](https://chromewebstore.google.com/detail/ui5-inspector/bebecogbafbighhaildooiibipcnbngo?hl=es)
21-
22-
20+
Another useful option is SAP’s default debugging tool, the [UI5 Inspector.](https://chromewebstore.google.com/detail/ui5-inspector/bebecogbafbighhaildooiibipcnbngo?hl=es)

docs/development/view.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
outline: [2, 4]
33
---
44
# View
5-
Output in abap2UI5 is generated by importing a UI5 XML View. Here’s a basic example:
6-
5+
In abap2UI5, the output is generated by importing a UI5 XML View. Here’s a basic example:
76
```abap
87
METHOD z2ui5_if_app~main.
98
@@ -19,7 +18,7 @@ METHOD z2ui5_if_app~main.
1918
2019
ENDMETHOD.
2120
```
22-
You can use any UI5 control available in the UI5 SDK. However, working with XML can be cumbersome. The current best practice is to use the class `Z2UI5_CL_XML_VIEW`:
21+
You can use any UI5 control available in the UI5 SDK. However, working with XML can become cumbersome. A more efficient approach is to use the `Z2UI5_CL_XML_VIEW` class. Here's an improved version of the code using this class:
2322
```abap
2423
METHOD z2ui5_if_app~main.
2524
@@ -32,6 +31,6 @@ You can use any UI5 control available in the UI5 SDK. However, working with XML
3231
3332
ENDMETHOD.
3433
```
35-
Check the API of the class `Z2UI5_CL_XML_VIEW` and use code completion to easily find the right controls and properties. Additionally, it’s recommended to explore the sample repository, where pre-written XML examples for most use cases are available for easy copy, paste, and adjustment to fit your needs.
34+
Check the API of the `Z2UI5_CL_XML_VIEW` class and leverage code completion to easily find the correct controls and properties. Additionally, it’s recommended to explore the sample repository, which contains pre-written XML examples for most use cases. These examples are available for easy copy-pasting and can be adjusted to suit your specific needs.
3635

37-
Currently, this setup is quite static; we’ll explore how to bind and exchange data in the next section.
36+
Currently, this setup is quite static. In the next section, we will explore how to bind and exchange data between the view and the app logic.

0 commit comments

Comments
 (0)