Skip to content

Commit a3d49a0

Browse files
committed
Improve English content in technical documentation
Made technical docs more casual and approachable: - Simplified complex sentences - Added contractions where natural - Improved flow and readability - Fixed typos (e.g., "elemenating" → "eliminating") Files updated: - docs/technical/concept.md - docs/technical/dx.md
1 parent 0bd9af4 commit a3d49a0

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

docs/technical/concept.md

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

33
_The Architecture of abap2UI5_
44

5-
This article introduces the core pattern behind abap2UI5: HTML Over-the-Wire — reimagined for the ABAP world. It explains how this approach eliminates traditional frontend complexity by shifting both UI rendering and application logic to the backend. The result: faster development, simplified deployment, and a UI5 frontend shell that acts purely as a rendering engine.
5+
This article introduces the core pattern behind abap2UI5: HTML Over-the-Wire — reimagined for the ABAP world. It shows how this approach cuts through traditional frontend complexity by moving both UI rendering and application logic to the backend. The result: faster development, simpler deployment, and a UI5 frontend shell that's purely a rendering engine.
66

77
#### What is HTML Over-the-Wire?
88

99
_HTML Over-the-Wire_ describes a server-centric web architecture in which the user interface is generated on the server and sent to the browser as ready-to-render HTML.
1010

11-
Instead of building and maintaining complex JavaScript frontends, managing APIs, and exchanging JSON, the server handles everything — from business logic to UI generation. The browser simply receives HTML fragments and renders them. This approach eliminates the need for client-side MVC frameworks, data transformation layers, and frontend deployment processes [(1)](https://signalvnoise.com/svn3/html-over-the-wire/):
11+
Instead of building and maintaining complex JavaScript frontends, managing APIs, and exchanging JSON, the server handles everything — from business logic to UI generation. The browser just receives HTML fragments and renders them. This approach cuts out the need for client-side MVC frameworks, data transformation layers, and frontend deployment processes [(1)](https://signalvnoise.com/svn3/html-over-the-wire/):
1212

1313
> You can write fast, modern, responsive web applications by generating your HTML on the server, and delivering that directly to the browser. You don’t need JSON as an in-between format. You don’t need client-side MVC frameworks. You don’t need complicated bundling and transpiling pipelines.
1414
@@ -102,9 +102,7 @@ When a user triggers an event (e.g., pressing a button), the event information i
102102
<em>abap2UI5 – Simple shell app, backend handles all logic</em>
103103
</p>
104104

105-
The frontend becomes a static app shared across all applications. Views and logic are fully defined and maintained in the backend and each application is represented by backend ABAP classes only. As a result, every UI5 app becomes a complete ABAP backend project — eliminating the need for separate frontend deployments entirely:
106-
107-
The frontend becomes a static shell shared across all applications. Views and logic are fully defined and maintained in the backend, and each application is represented solely by backend ABAP classes. As a result, every UI5 development project becomes a complete backend project — eliminating the need for separate frontend deployments entirely:
105+
The frontend becomes a static shell shared across all applications. Views and logic are fully defined and maintained in the backend, with each application represented solely by backend ABAP classes. The result: every UI5 development project becomes a complete backend project — no separate frontend deployments needed:
108106

109107
<p align="center">
110108
<img width="400" alt="image" src="https://github.com/user-attachments/assets/2d8b6441-84f3-464c-980f-2773d619af29" />
@@ -146,7 +144,7 @@ This leads to the second subtle shift in abap2UI5: Instead of binding OData to V
146144

147145
This means CDS Views and OData services are no longer consumed directly on the frontend. Instead, the complete UI state — both view and model — is sent from the backend in a single response. Any user changes in the UI are then returned to the backend via a lightweight AJAX call containing the updated view model — no OData routing involved.
148146

149-
Developers do not need to manually configure models or bindings. abap2UI5 handles this internally. All that’s required is to expose class attributes using a simple bind method — abap2UI5 handles the rest.
147+
You don't need to manually configure models or bindings. abap2UI5 handles this internally. All you need to do is expose class attributes using a simple bind method — abap2UI5 takes care of the rest.
150148

151149
A typical backend response includes both the XML View:
152150

@@ -229,9 +227,9 @@ The illustration below shows the difference between a full re-render and a targe
229227
<em>Partly HTML Rerendering via View Model Updates - Only relevant DOM parts are re-rendered, preserving UI state</em>
230228
</p>
231229

232-
Thanks to UI5s powerful data binding mechanism, only the modified DOM elements are updated. This preserves the current UI state — such as input focus — and ensures a smooth, uninterrupted user experience.
230+
Thanks to UI5's powerful data binding mechanism, only the modified DOM elements are updated. This keeps the current UI state intact — like input focus — and ensures a smooth, uninterrupted user experience.
233231

234-
The XML View and View Model concept make UI5 a perfect team player for the UI5 Over-the-Wire approach elemenating the need of full client-side re-renders.
232+
The XML View and View Model concept make UI5 a perfect match for the UI5 Over-the-Wire approach, eliminating the need for full client-side re-renders.
235233

236234
#### Conclusion
237235

@@ -250,7 +248,7 @@ Limitations:
250248
- Offline functionality or complex client-side interactions are not covered
251249
- Less effective if frontend and backend teams work independently
252250

253-
By relocating UI control to the ABAP backend and using UI5 solely forthe HTML creation, abap2UI5 enables fast and efficient development of business applications — without the complexity of SPA architectures.
251+
By moving UI control to the ABAP backend and using UI5 solely for HTML creation, abap2UI5 enables fast and efficient development of business applications — without the complexity of SPA architectures.
254252

255253
Happy ABAPing! ❤️🦖🦕🦣
256254

docs/technical/dx.md

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

33
_A Developer-Centric Approach_
44

5-
abap2UI5 was created from the everyday experiences of ABAP developers. It addresses common challenges in the development process — including deployment, caching, debugging, and tooling — while preserving a coding style that stays close to familiar ABAP and SAP GUI patterns such as Selection Screens and ALV. The goal is to make working with abap2UI5 as familiar and intuitive as possible for ABAPers. This page takes a closer look at some of the key influences behind the framework.
5+
abap2UI5 was built from the everyday experiences of ABAP developers. It tackles common challenges in the development process — deployment, caching, debugging, and tooling — while keeping a coding style that's close to familiar ABAP and SAP GUI patterns like Selection Screens and ALV. The goal: make working with abap2UI5 as familiar and intuitive as possible for ABAPers. This page takes a closer look at the key influences behind the framework.
66

77
### Simple Output with IF_OO_ADT_CLASSRUN
88

@@ -38,11 +38,11 @@ CLASS zcl_app_ui5 IMPLEMENTATION.
3838
ENDMETHOD.
3939
ENDCLASS.
4040
```
41-
What abap2UI5 adds is the ability to run in the browser without ADT, using a UI5 frontend that fully adheres to SAP Fiori design guidelines — and is ready to be shown to your colleagues right away.
41+
What abap2UI5 adds: the ability to run in the browser without ADT, using a UI5 frontend that fully follows SAP Fiori design guidelines — ready to show your colleagues right away.
4242

4343
### Classic Input Handling with Selection Screens
4444

45-
Input handling was never a challenge in classic ABAP — just define a Report with `PARAMETERS` and `SELECT-OPTIONS`, and the UI is generated automatically. Although the term didnt exist back then, this gave you a "fullstack" app in just a few lines:
45+
Input handling was never a challenge in classic ABAP — just define a Report with `PARAMETERS` and `SELECT-OPTIONS`, and the UI gets generated automatically. The term didn't exist back then, but this gave you a "fullstack" app in just a few lines:
4646

4747
```abap
4848
REPORT zre_app_input.
@@ -80,7 +80,7 @@ CLASS zcl_app_input IMPLEMENTATION.
8080
ENDMETHOD.
8181
ENDCLASS.
8282
```
83-
Additionally, you can test code changes instantly — just reload the page, enter input, and press the button — all within a single class and without any external UI tooling.
83+
Plus, you can test code changes instantly — just reload the page, enter input, and press the button — all within a single class, no external UI tooling needed.
8484

8585
### ALV-Style Table Output in the Browser
8686

@@ -143,7 +143,7 @@ CLASS zcl_app_alv IMPLEMENTATION.
143143
ENDCLASS.
144144
```
145145

146-
From here, it's just a small step to generate everything dynamically using RTTI — similar to the SALV functionality, but running directly in the browser.
146+
From here, it's just a small step to generate everything dynamically with RTTI — similar to SALV functionality, but running directly in the browser.
147147

148148
### Classic Popups, Modern Events
149149

@@ -203,34 +203,34 @@ CLASS zcl_app_alv_event IMPLEMENTATION.
203203
ENDCLASS.
204204
```
205205

206-
While browser-based roundtrips require slightly different flow control, the overall approach remains intuitive for ABAP developers.
206+
Browser-based roundtrips need slightly different flow control, but the overall approach stays intuitive for ABAP developers.
207207

208208
### More Developer-Friendly Advantages
209209

210-
Beyond the code snippets shown above, the Over-the-Wire approach of abap2UI5 — based entirely on backend development — offers several additional advantages.
210+
Beyond the code snippets above, the Over-the-Wire approach of abap2UI5 — based entirely on backend development — brings several additional advantages.
211211

212212
##### Zero-Setup Deployment
213213

214-
In abap2UI5, apps are just ABAP classes — deployment is as simple as activating the class. Transport to production happens via the standard transport system familiar from traditional ABAP development:
214+
In abap2UI5, apps are just ABAP classes — deployment is as simple as activating the class. Transport to production happens via the standard transport system you know from traditional ABAP development:
215215
- No separate frontend build or deployment pipelines
216216
- Code changes can be instantly tested by other developers or consultants
217217
- Every app is abapGit-compatible — no separate frontend artifacts required
218218

219219
##### No Caching Issues
220220

221-
A common frustration in frontend development is caching — especially with BSP or Fiori Elements apps. You make a change, but nothing happens due to cached files, unless you manually trigger several cache invalidation transactions in the SAP backend. abap2UI5 avoids this issue entirely, as the UI is dynamically generated on every request:
221+
A common frustration in frontend development: caching — especially with BSP or Fiori Elements apps. You make a change, but nothing happens due to cached files, unless you manually trigger several cache invalidation transactions in the SAP backend. abap2UI5 sidesteps this entirely, as the UI gets dynamically generated on every request:
222222
- No need to clear browser or server caches
223223
- Fast development iteration — edit the code, refresh the browser, see results
224224

225225
##### Develop in Any IDE
226226

227-
There's often debate about which IDE to use — but why not let everyone choose the tool they prefer? abap2UI5 apps are developed entirely in ABAP. You can work in ADT, SE80, or even explore integration with VS Code:
227+
There's often debate about which IDE to use — but why not let everyone pick their favorite? abap2UI5 apps are developed entirely in ABAP. Work in ADT, SE80, or even explore VS Code integration:
228228
- No additional setup required — works in any IDE
229229
- Ideal for teams with different tooling preferences
230230

231231
##### Pure ABAP Debugging
232232

233-
Frontend-heavy applications often require switching between browser dev tools, JavaScript logs, and network inspectors. With abap2UI5, the UI is pure ABAP — no JavaScript, no additional layers. Just set a breakpoint in your ABAP method:
233+
Frontend-heavy apps often need switching between browser dev tools, JavaScript logs, and network inspectors. With abap2UI5, the UI is pure ABAP — no JavaScript, no additional layers. Just set a breakpoint in your ABAP method:
234234
- Backend-only debugging with the classic SE80 debugger or ADT
235235
- No need for browser debugging tools
236236

@@ -243,7 +243,7 @@ Sharing your apps or code is simple. Since abap2UI5 apps are standard ABAP class
243243

244244
### Conclusion
245245

246-
abap2UI5 brings back familiar ABAP development patterns. It reuses proven concepts like Selection Screens, ALV tables, and popup dialogs — but renders them as UI5 apps, defined and executed entirely in ABAP.
247-
The result: backend-driven UI development with minimal tooling and fast iterations. Whether it's prototyping or building full business apps, abap2UI5 keeps the development process close to what ABAP developers know best.
246+
abap2UI5 brings back familiar ABAP development patterns. It reuses proven concepts like Selection Screens, ALV tables, and popup dialogs — but renders them as UI5 apps, all defined and executed in ABAP.
247+
The result: backend-driven UI development with minimal tooling and fast iterations. Whether you're prototyping or building full business apps, abap2UI5 keeps development close to what ABAP developers know best.
248248

249249
Happy ABAPing! ❤️🦖🦕🦣

0 commit comments

Comments
 (0)