Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -472,13 +472,19 @@ export default defineConfig({
// entries and Technical Insight - the last of them - is visible
// without scrolling, which it was not when it was the twelfth.
//
// Use Cases and Add-ons stay loose at the top: both moved out of
// Getting Started on purpose, because they answer questions a
// newcomer does not have yet, and on the entry pages they read as
// required steps. They are the two that say what this section is
// for, so they are what a reader opening it meets first.
// Use Cases stays loose at the top: it moved out of Getting
// Started on purpose, because it answers a question a newcomer
// does not have yet, and on the entry page it reads as a required
// step. It is the one that says what this section is for, so it is
// what a reader opening it meets first.
//
// Add-ons stood next to it and is now under Resources. Every other
// page in this section teaches something you do to your own app -
// downport it, run it off-stack, extend it, wire it to something.
// Add-ons teaches nothing: it is a list of what other people
// published, which is the same kind of page as References and Who
// Uses abap2UI5?. The pages that need it still link it by name.
{ text: "Use Cases", link: "/advanced/use_cases" },
{ text: "Add-ons", link: "/advanced/addons" },
{
text: "Extensibility",
collapsed: true,
Expand Down Expand Up @@ -630,6 +636,12 @@ export default defineConfig({
// did not own. The catalogue pages introduce themselves and link
// one another; the home page opens the first of them directly, and
// the cookbook links individual samples per chapter.
//
// Moved here from Advanced Topics: the ecosystem around the
// framework rather than a technique to apply to your own app, and
// it closes by asking the reader to add their project - the same
// invitation Who Uses abap2UI5? makes below it.
{ text: "Add-ons", link: "/resources/addons" },
{ text: "Who Uses abap2UI5?", link: "/resources/who_uses" },
{ text: "Release Notes", link: "/resources/changelog" },
{ text: "Deprecations", link: "/resources/deprecations" },
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/renaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ alone would let them collide; the segment is what keeps them apart.
| `smp` | [samples](https://github.com/abap2UI5/samples) — the sample catalog, `z2ui5_cl_smp_app_*` |
| `smps` | [samples-stack](https://github.com/abap2UI5/samples-stack) — full-stack samples |
| `smpc` | [samples-controls](https://github.com/abap2UI5/samples-controls) — control samples |
| `popup` | [popups](https://github.com/abap2UI5-addons/popups) — the popups [add-on](/advanced/addons) |
| `popup` | [popups](https://github.com/abap2UI5-addons/popups) — the popups [add-on](/resources/addons) |
| `cci` | [custom-controls](https://github.com/abap2UI5-addons/custom-controls) — custom controls shared with the community |
| `ccc` | [custom-controls-customer](https://github.com/abap2UI5/custom-controls-customer) — the template for **your own** frontend artefacts |

Expand Down
2 changes: 1 addition & 1 deletion docs/cookbook/device_capabilities/barcode_scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ ENDCLASS.
For a complete sound sample, see `Z2UI5_CL_SMPS_APP_487` in the [samples-stack repository](https://github.com/abap2UI5/samples-stack).

## Render Barcodes
To also render barcodes, use bwip-js, which ships with the js-libraries add-on. See [Add-ons](/advanced/addons) for details.
To also render barcodes, use bwip-js, which ships with the js-libraries add-on. See [Add-ons](/resources/addons) for details.
2 changes: 1 addition & 1 deletion docs/cookbook/device_capabilities/spreadsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,4 +301,4 @@ ENDCLASS.
:::

## UI5 Control
To export data directly on the frontend, SAP offers the sap.ui.export.Spreadsheet control for exporting table content. With some extra logic, you can use this control with abap2UI5 too. See the [Add-ons](/advanced/addons) page for a complete sample with the custom control. The coding effort may be higher than the file-based approach shown above.
To export data directly on the frontend, SAP offers the sap.ui.export.Spreadsheet control for exporting table content. With some extra logic, you can use this control with abap2UI5 too. See the [Add-ons](/resources/addons) page for a complete sample with the custom control. The coding effort may be higher than the file-based approach shown above.
2 changes: 1 addition & 1 deletion docs/cookbook/expert_more/lock.md
Original file line number Diff line number Diff line change
Expand Up @@ -1148,7 +1148,7 @@ ENDCLASS.
On modern releases, RAP draft-enabled business objects manage locking for you: the draft holds an exclusive lock for its owner while the user keeps editing — no stateful session, no `ENQUEUE_*` call. If a released SAP BO already covers your object, this is usually the simplest path. See [Draft Handling](../eml_cds_sql/draft_handling.md).

## 8. Lock-Manager Add-on
The community add-on [**lock-manager**](https://github.com/abap2UI5-addons/lock-manager) wraps the lock logic in a reusable class — including stale-lock cleanup and a "locked by X since…" message for the user. Install it like any other [add-on](../../advanced/addons.md) and call it instead of writing the boilerplate yourself.
The community add-on [**lock-manager**](https://github.com/abap2UI5-addons/lock-manager) wraps the lock logic in a reusable class — including stale-lock cleanup and a "locked by X since…" message for the user. Install it like any other [add-on](../../resources/addons.md) and call it instead of writing the boilerplate yourself.

## Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/cookbook/expert_more/value_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Pass `i_multiselect = abap_true` for multi-pick; the result table is then in `ls

### DDIC Search Help

For value helps that exist as DDIC search help objects (`SE11` → search help), the [generic search help builder](https://github.com/axelmohnen/a2UI5-generic_search_hlp) wraps the F4 framework so you can fire any standard search help by name and get the picked row back. Install it like any other [add-on](../../advanced/addons.md).
For value helps that exist as DDIC search help objects (`SE11` → search help), the [generic search help builder](https://github.com/axelmohnen/a2UI5-generic_search_hlp) wraps the F4 framework so you can fire any standard search help by name and get the picked row back. Install it like any other [add-on](../../resources/addons.md).

### Custom Dialog

Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Authentication is the ICF node's job, exactly as for any other service on your s
### System Footprint
The framework has a small system footprint — essentially classes, interfaces, and a single draft table. The core stays minimal; optional add-ons provide extra functionality only when you need it.

→ *See [Add-ons](/advanced/addons) for the ecosystem around the core — layout variants, table maintenance, charts*
→ *See [Add-ons](/resources/addons) for the ecosystem around the core — layout variants, table maintenance, charts*

### Transparency
All source code lives publicly on GitHub. We discuss features and issues openly, publish technical blog posts that explain key concepts, and ship fixes quickly via abapGit. You'll always understand how the framework works and can confirm its behavior.
Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/next.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Build views, handle events, share data, and work with tables. The [Cookbook](/co
Before going live, set up security, performance tuning, Launchpad integration, and more. Start with the [Configuration guide](/configuration/setup).

## Add-ons
Extend your apps with community-built add-ons for layout handling, charts, table maintenance, and more. See the [Add-ons page](/advanced/addons).
Extend your apps with community-built add-ons for layout handling, charts, table maintenance, and more. See the [Add-ons page](/resources/addons).

## Real-World Use
See ready-to-use apps, real-world scenarios, and companies already running on abap2UI5 on the [Who Uses abap2UI5](/resources/who_uses) page.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/resources/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ z2ui5_cl_popup_to_confirm=>factory( `Delete this entry?` )

The name gains the two letters `up`: the add-on ships under `z2ui5_cl_popup_*`,
the frozen built-ins are `z2ui5_cl_pop_*`. The shipped classes are unchanged, so
existing calls keep compiling. See [Add-ons](/advanced/addons).
existing calls keep compiling. See [Add-ons](/resources/addons).

### Utility classes

Expand Down