Skip to content

Commit d8a78e7

Browse files
oblomov-devoblomov-dev
authored
Merge pull request #61 from abap2UI5/claude/rename-soft-keyboard-page-6j0CL
Reorganize documentation structure for messages and development topics
2 parents d768e58 + a3c3fd5 commit d8a78e7

7 files changed

Lines changed: 67 additions & 47 deletions

File tree

‎docs/.vitepress/config.mjs‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,18 @@ export default defineConfig({
120120
{ text: "Controller", link: "/development/general" },
121121
{
122122
text: "View",
123-
link: "/development/view",
124123
collapsed: true,
125124
items: [
125+
{ text: "Definition", link: "/development/view/definition" },
126126
{ text: "Expression Binding", link: "/development/model/expression_binding" },
127127
{ text: "Formatter", link: "/development/specific/formatter" },
128128
],
129129
},
130130
{
131131
text: "Model",
132-
link: "/development/model/model",
133132
collapsed: true,
134133
items: [
134+
{ text: "Binding", link: "/development/model/binding" },
135135
{ text: "Tables, Trees", link: "/development/model/tables" },
136136
{ text: "Device Model", link: "/development/model/device" },
137137
{ text: "OData", link: "/development/model/odata" },
@@ -150,7 +150,15 @@ export default defineConfig({
150150
},
151151
],
152152
},
153-
{ text: "Messages, Errors", link: "/development/messages" },
153+
{
154+
text: "Messages, Errors",
155+
collapsed: true,
156+
items: [
157+
{ text: "Messages", link: "/development/messages/messages" },
158+
{ text: "Errors", link: "/development/messages/errors" },
159+
{ text: "Logging", link: "/development/messages/logging" },
160+
],
161+
},
154162
{ text: "Translation, i18n", link: "/development/translation" },
155163
{ text: "Popups, Popovers", link: "/development/popups" },
156164
{
@@ -175,9 +183,17 @@ export default defineConfig({
175183
text: "Geolocation, Maps",
176184
link: "/development/specific/geolocation",
177185
},
178-
{ text: "File Handling", link: "/development/specific/files" },
186+
{
187+
text: "File Handling",
188+
link: "/development/specific/files",
189+
collapsed: true,
190+
items: [
191+
{ text: "XLSX", link: "/development/specific/xlsx" },
192+
],
193+
},
179194
{ text: "URL", link: "/development/specific/url" },
180195
{ text: "Timer", link: "/development/specific/timer" },
196+
{ text: "Soft Keyboard", link: "/development/specific/soft_keyboard" },
181197
],
182198
},
183199
{
@@ -196,13 +212,10 @@ export default defineConfig({
196212
text: "Misc Topics",
197213
collapsed: true,
198214
items: [
199-
{ text: "Logging", link: "/development/specific/logging" },
200-
{ text: "XLSX", link: "/development/specific/xlsx" },
201215
{ text: "Locks", link: "/development/specific/locks" },
202216
{ text: "Statefulness", link: "/development/specific/statefulness" },
203217
],
204218
},
205-
{ text: "Troubleshooting", link: "/development/trouble" },
206219
],
207220
},
208221
{

‎docs/development/messages/errors.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
outline: [2, 4]
3+
---
4+
# Errors
5+
6+
Beyond plain messages, abap2UI5 ships dedicated popups and fallbacks for handling exceptions and unexpected failures.
7+
8+
#### Error Popup
9+
To display full details of your exception:
10+
```abap
11+
METHOD z2ui5_if_app~main.
12+
13+
TRY.
14+
DATA(lv_val) = 1 / 0.
15+
CATCH cx_root INTO DATA(lx).
16+
client->nav_app_call( z2ui5_cl_pop_error=>factory( lx ) ).
17+
ENDTRY.
18+
19+
ENDMETHOD.
20+
```
21+
22+
#### Uncaught Errors
23+
When your code doesn't catch exceptions, the framework catches them and displays the standard error popup. Try this:
24+
25+
```abap
26+
METHOD z2ui5_if_app~main.
27+
28+
RAISE EXCEPTION NEW cx_sy_itab_line_not_found( ).
29+
30+
ENDMETHOD.
31+
```
32+
33+
#### Uncatchable Exceptions / Short Dumps
34+
What happens if your code raises uncatchable exceptions? The default HTTP handler exception output appears. Processing halts, and the user has to reload the browser. Reserve this for unexpected cases:
35+
36+
```abap
37+
METHOD z2ui5_if_app~main.
38+
39+
ASSERT 1 = `This is an error message!`.
40+
41+
ENDMETHOD.
42+
```

docs/development/specific/logging.md renamed to docs/development/messages/logging.md

File renamed without changes.

docs/development/messages.md renamed to docs/development/messages/messages.md

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
outline: [2, 5]
33
---
4-
# Messages, Errors
4+
# Messages
55

6-
Showing messages and errors is an everyday task for ABAP developers. The functions below cover the most common cases.
6+
Showing messages is an everyday task for ABAP developers. The functions below cover the most common cases.
77

88
#### Message Toast
99

@@ -86,41 +86,6 @@ METHOD z2ui5_if_app~main.
8686
8787
client->nav_app_call( z2ui5_cl_pop_messages=>factory( lt_msg ) ).
8888
89-
ENDMETHOD.
90-
```
91-
#### Error Popup
92-
To display full details of your exception:
93-
```abap
94-
METHOD z2ui5_if_app~main.
95-
96-
TRY.
97-
DATA(lv_val) = 1 / 0.
98-
CATCH cx_root INTO DATA(lx).
99-
client->nav_app_call( z2ui5_cl_pop_error=>factory( lx ) ).
100-
ENDTRY.
101-
102-
ENDMETHOD.
103-
```
104-
105-
#### Uncaught Errors
106-
When your code doesn't catch exceptions, the framework catches them and displays the standard error popup. Try this:
107-
108-
```abap
109-
METHOD z2ui5_if_app~main.
110-
111-
RAISE EXCEPTION NEW cx_sy_itab_line_not_found( ).
112-
113-
ENDMETHOD.
114-
```
115-
116-
#### Uncatchable Exceptions / Short Dumps
117-
What happens if your code raises uncatchable exceptions? The default HTTP handler exception output appears. Processing halts, and the user has to reload the browser. Reserve this for unexpected cases:
118-
119-
```abap
120-
METHOD z2ui5_if_app~main.
121-
122-
ASSERT 1 = `This is an error message!`.
123-
12489
ENDMETHOD.
12590
```
12691

docs/development/model/model.md renamed to docs/development/model/binding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
outline: [2, 4]
33
---
4-
# Model
4+
# Binding
55

66
In abap2UI5, there are two ways to share data between your ABAP code and the UI5 frontend.
77

docs/development/trouble.md renamed to docs/development/specific/soft_keyboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
outline: [2, 4]
33
---
4-
# Troubleshooting
4+
# Soft Keyboard
55

66
#### Hide Soft Keyboard
77

docs/development/view.md renamed to docs/development/view/definition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
outline: [2, 4]
33
---
4-
# View
4+
# Definition
55

66
In abap2UI5, UI5 renders the UI from an XML view that you build in ABAP. A simple example with raw XML:
77

0 commit comments

Comments
 (0)