Skip to content

Commit ab4648e

Browse files
oblomov-devoblomov-dev
authored
update
1 parent 20ff762 commit ab4648e

File tree

3 files changed

+88
-13
lines changed

3 files changed

+88
-13
lines changed

‎docs/.vitepress/config.mjs

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ export default defineConfig({
99
// https://vitepress.dev/reference/default-theme-config
1010
nav: [
1111
{ text: 'Get Started', link: '/get_started/quickstart' },
12+
{ text: 'Features', link: '/' },
1213
{ text: 'Contribution', link: '/' },
1314
{ text: 'Integration', link: '/' },
1415
{ text: 'Resources', link: '/resources/blogs' }
@@ -18,8 +19,20 @@ export default defineConfig({
1819
text: 'Get Started',
1920
collapsed: true,
2021
items: [
21-
{ text: 'Markdown Examples', link: '/get_started/quickstart' },
22-
{ text: 'Runtime API Examples', link: '/api-examples' }
22+
{ text: 'Installation', link: '/get_started/quickstart' },
23+
{ text: 'Hello World', link: '/get_started/quickstart' },
24+
{ text: 'Configuration', link: '/get_started/configuration' },
25+
{ text: 'Sample Apps', link: '/get_started/configuration' }
26+
]
27+
},
28+
{
29+
text: 'Features',
30+
collapsed: true,
31+
items: [
32+
{ text: 'Feature I', link: '/features/' },
33+
{ text: 'Feature II', link: '/features/' },
34+
{ text: 'Feature III', link: '/features/' },
35+
{ text: 'FAQ', link: '/features/faq' }
2336
]
2437
},
2538
{
@@ -31,12 +44,14 @@ export default defineConfig({
3144
]
3245
},
3346
{
34-
text: 'Integration',
47+
text: 'Setup & Launchpad',
3548
collapsed: true,
3649
items: [
3750
{ text: 'Business Technology Platform', link: '/markdown-examples' },
38-
{ text: 'Build Workzone', link: '/markdown-examples' },
39-
{ text: 'Fiori Launchpad', link: '/api-examples' }
51+
{ text: 'BTP ABAP Environment', link: '/markdown-examples' },
52+
{ text: 'S/4 Public Cloud', link: '/api-examples' },
53+
{ text: 'S/4 Private or On-Premise', link: '/api-examples' },
54+
{ text: 'R/3 Netweaver', link: '/api-examples' }
4055
]
4156
},
4257
{

‎docs/features/faq.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# FAQ
2+
3+
_Change the HTTP Handler and URL Paramters for various configuration possibilities: Theme, Bootstrapping, Conten-Security-Policy etc.
4+
Check it out [**here.**](https://github.com/abap2UI5/abap2UI5-documentation/blob/main/docs/handler_config.md)_
5+
6+
## Client & UI
7+
8+
## **1. How to read URL parameters?**
9+
Use the following snippet:
10+
```abap
11+
DATA(lv_search) = client->get( )-s_config-search.
12+
DATA(lv_param) = z2ui5_cl_xml_view=>factory( client )->hlp_get_url_param( `myparam` ).
13+
```
14+
## **2. How to format numbers, times and dates?**
15+
Take a look at the following example: <br>
16+
https://github.com/abap2UI5/demo-demos/blob/main/src/z2ui5_cl_app_demo_47.clas.abap
17+
<img width="500" alt="image" src="https://github.com/abap2UI5/abap2UI5/assets/102328295/6b9011b5-94e6-4329-9666-0e779c01b400">
18+
19+
## **3. How to format the output of currencies?**
20+
Take a look at the following example: <br>
21+
https://github.com/abap2UI5/demo-demos/blob/main/src/z2ui5_cl_app_demo_67.clas.abap
22+
<img width="500" alt="image" src="https://github.com/abap2UI5/abap2UI5/assets/102328295/fef6e08c-5a34-4aee-9d34-ebb1c5d45275">
23+
24+
## **4. How to call an url in a new tab?**
25+
Use the following snippet:
26+
```abap
27+
client->timer_set(
28+
interval_ms = 0
29+
event_finished = client->_event_client( action = client->cs_event-open_new_tab t_arg = value #( ( `https://www.github.com/abap2UI5` ) )
30+
) ).
31+
```
32+
#### 5. **Which values can be send back via client->_event( t_arg = value # ( ( ... ?**
33+
Check the documentation [here.](https://openui5.hana.ondemand.com/#/topic/b0fb4de7364f4bcbb053a99aa645affe) There are different ways for adressing the event handler ($event, $source, $params) and you can select your value for example with /mProperties/property.<br>
34+
<img width="500" alt="image" src="https://github.com/abap2UI5/abap2UI5-documentation/assets/102328295/6de59970-f766-46fd-a35a-933d26287564">
35+
<br>
36+
You can also call functions directly in the view as explained [here.](https://sapui5.hana.ondemand.com/#/entity/sap.m.ActionSheet/sample/sap.m.sample.ActionSheet/code/view/ActionSheet.fragment.xml) <br>
37+
<img width="500" alt="image" src="https://github.com/abap2UI5/abap2UI5-documentation/assets/102328295/17650cca-d84a-4e88-be2b-244ead773b52">
38+
<br>
39+
#### 5. **How can I change the logon language?**
40+
Set the url parameter sap-language for this and check all other options [here.](https://help.sap.com/doc/saphelp_nw75/7.5.5/de-DE/8b/46468c433b40c3b87b2e07f34dea1b/content.htm?no_cache=true)
41+
42+
## Extension
43+
#### 1. **How can i call my own custom function?**
44+
Extend the initial HTTP Get call:<br>
45+
<img width="500" alt="image" src="https://github.com/abap2UI5/abap2UI5-documentation/assets/102328295/b671b89f-530b-4a35-98ba-e1a779fc0087"><br>
46+
And in your application, call the function in the view definition:<br>
47+
<img width="500" alt="image" src="https://github.com/abap2UI5/abap2UI5-documentation/assets/102328295/2f041184-a8c1-4d11-893a-ee6800b3214c">
48+
49+
50+
## Productive Usage
51+
#### **1. Can abap2UI5 used in a productive system?**
52+
The project is technically just an implementation of an HTTP handler and can be used as any other HTTP Service also in a productive scenario.
53+
#### **2. Are there any dependencies or preparations needed before using abap2UI5 in a productiv scenario?**
54+
No, but it is recommended to follow these steps before using abap2UI5 apps in a productive scenario:
55+
1. Transport the abap2UI5 HTTP service and the framework first
56+
2. Sometimes an extra activation of the HTTP service is needed, along with an adjustment of the UI5 bootstrapping
57+
3. Test the "hello world" app to ensure that abap2UI5 works correctly
58+
4. Now continue with tranporting your custom apps...
59+
#### **3. Does a stable version of abap2UI5 exist?**
60+
The project will be continuously further developed. Therefore, there is no specific "stable" version. However, adjustments to the public APIs will be kept to a minimum to avoid frequent refactoring of apps. You can use [releases](https://github.com/abap2ui5/abap2ui5/releases/) instead of pulling the main branch and only update from time to time to reduce refactoring efforts.

‎obsolet/docs/handler_config.md renamed to ‎docs/get_started/configuration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## HTTP Handler Configuration
1+
# Configuration
22

33
abap2UI5 can be run with various custom configurations. This is the call for the default setup:
44
```abap
@@ -10,7 +10,7 @@ abap2UI5 can be run with various custom configurations. This is the call for the
1010
```
1111
For custom configurations, simply create a config variable and import it to the main method:
1212

13-
#### Theme
13+
## Theme
1414
eg. for changing the theme the source code looks like this:
1515
```abap
1616
METHOD if_http_extension~handle_request.
@@ -23,7 +23,7 @@ eg. for changing the theme the source code looks like this:
2323
ENDMETHOD.
2424
```
2525

26-
#### UI5 Bootstrapping
26+
## UI5 Bootstrapping
2727

2828
```abap
2929
DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ).
@@ -32,7 +32,7 @@ eg. for changing the theme the source code looks like this:
3232
) ).
3333
```
3434

35-
#### Custom JS
35+
## Custom JS
3636
Use this for example to install additional custom controls [here:](https://github.com/abap2UI5-addons/custom-controls)
3737
```abap
3838
DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ).
@@ -41,7 +41,7 @@ Use this for example to install additional custom controls [here:](https://githu
4141
) ).
4242
```
4343

44-
#### Content-Security-Policy
44+
## Content-Security-Policy
4545

4646
```abap
4747
DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ).
@@ -52,7 +52,7 @@ Use this for example to install additional custom controls [here:](https://githu
5252
) ).
5353
```
5454

55-
#### Title
55+
## Title
5656

5757
```abap
5858
DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ).
@@ -61,7 +61,7 @@ Use this for example to install additional custom controls [here:](https://githu
6161
) ).
6262
```
6363

64-
#### Style / CSS
64+
## Style / CSS
6565

6666
```abap
6767
DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ).
@@ -70,5 +70,5 @@ Use this for example to install additional custom controls [here:](https://githu
7070
) ).
7171
```
7272

73-
#### URL Parameter
73+
## URL Parameter
7474
Further configuration can be done by changing the URL [**here.**](https://help.sap.com/doc/saphelp_nw75/7.5.5/de-DE/8b/46468c433b40c3b87b2e07f34dea1b/content.htm?no_cache=true)

0 commit comments

Comments
 (0)