8000 chore: :memo: updated documentation · miggi92/odata-fw@a287bde · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Commit a287bde

Browse files
miggi92miggi92
authored
chore: 📝 updated documentation
1 parent 406819f commit a287bde

28 files changed

+945
-403
lines changed

‎.github/dependabot.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,3 @@ updates:
2222
labels:
2323
- "npm"
2424
- "dependencies"
25-
# Maintain dependencies for pip
26-
- package-ecosystem: "pip"
27-
directory: "/"
28-
schedule:
29-
interval: "weekly"
30-
labels:
31-
- "pip"
32-
- "dependencies"

‎.github/workflows/update_doc_template.yml

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/.vitepress/config.mts

Lines changed: 118 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,127 @@
11
import { defineConfig } from 'vitepress'
2+
import { withMermaid } from "vitepress-plugin-mermaid";
3+
4+
import { version } from "../../package.json";
25

36
// https://vitepress.dev/reference/site-config
4-
export default defineConfig({
5-
title: "ABAP OData Framework",
6-
lang: 'en-US',
7-
base: '/odata-fw/',
8-
description: "A odata framework for a SAP System. ",
9-
head: [['link', { rel: 'icon', href: '../assets/favicon.ico' }]],
10-
sitemap: {
11-
hostname: "https://miggi92.github.io/odata-fw/"
12-
},
13-
themeConfig: {
14-
// https://vitepress.dev/reference/default-theme-config
15-
nav: [
16-
{ text: 'Home', link: '/' },
17-
{ text: 'Documentation', link: '/documentation/' }
18-
],
19-
search: {
20-
provider: 'local',
21-
options: {
22-
_render(src, env, md) {
23-
const html = md.render(src, env)
24-
if (env.frontmatter?.title)
25-
return md.render(`# ${env.frontmatter.title}`) + html
26-
return html
7+
export default
8+
// withMermaid(
9+
10+
defineConfig({
11+
title: "ABAP OData Framework",
12+
lang: 'en-US',
13+
base: '/odata-fw/',
14+
description: "A odata framework for a SAP System. ",
15+
head: [['link', { rel: 'icon', href: '../assets/favicon.ico' }]],
16+
lastUpdated: true,
17+
sitemap: {
18+
hostname: "https://miggi92.github.io/odata-fw/"
19+
},
20+
themeConfig: {
21+
// https://vitepress.dev/reference/default-theme-config
22+
nav: nav(),
23+
outline: [2, 6],
24+
search: {
25+
provider: 'local',
26+
options: {
27+
_render(src, env, md) {
28+
const html = md.render(src, env)
29+
if (env.frontmatter?.title)
30+
return md.render(`# ${env.frontmatter.title}`) + html
31+
return html
32+
}
33+
}
34+
},
35+
lastUpdated: {
36+
text: 'Updated at',
37+
formatOptions: {
38+
dateStyle: 'full',
39+
timeStyle: 'medium'
2740
}
41+
},
42+
43+
sidebar: {
44+
"/documentation/": sidebarDocumentation(),
45+
},
46+
logo: '../assets/odata_fw_logo_transparent.png',
47+
48+
socialLinks: [
49+
{ icon: 'github', link: 'https://github.com/miggi92/odata-fw' }
50+
],
51+
footer: {
52+
message: 'Released under the MIT License.',
53+
copyright: 'Copyright © 2019 - present miggi92'
2854
}
2955
},
56+
locales: {
57+
root: {
58+
label: 'English',
59+
lang: 'en'
60+
},
61+
}
62+
}
63+
// )
64+
);
3065

31-
sidebar: [
32-
{
33-
text: 'Documentation',
34-
items: [
35-
{ text: 'Documentation', link: '/documentation/' },
36-
{ text: 'Creating a service', link: '/documentation/Creating-a-service' },
37-
{ text: 'DPC boilerplate code', link: '/documentation/DPC-boilerplate-code' }
38-
]
39-
}
40-
],
41-
logo: '../assets/odata_fw_logo_transparent.png',
66+
function nav() {
67+
return [
68+
{ text: 'Home', link: '/' },
69+
{ text: 'Documentation', link: '/documentation/', activeMatch: "/documentation/" },
70+
{
71+
text: version,
72+
items: [
73+
{
74+
text: 'Changelog',
75+
link: 'https://github.com/miggi92/odata-fw/blob/master/CHANGELOG.md'
76+
},
77+
{
78+
text: 'Contributing',
79+
link: 'https://github.com/miggi92/odata-fw/blob/master/CONTRIBUTING.md'
80+
}
81+
]
82+
},
83+
];
84+
}
4285

43-
socialLinks: [
44-
{ icon: 'github', link: 'https://github.com/miggi92/odata-fw' }
45-
],
46-
footer: {
47-
message: 'Released under the MIT License.',
48-
copyright: 'Copyright © 2019 - present miggi92'
86+
function sidebarDocumentation() {
87+
return [
88+
{
89+
text: "Documentation",
90+
collapsible: true,
91+
items: [
92+
{ text: 'Creating a service', link: '/documentation/Creating-a-service' },
93+
{ text: 'DPC boilerplate code', link: '/documentation/DPC-boilerplate-code' }
94+
],
95+
},
96+
{
97+
text: 'Development Objects',
98+
link: '/documentation/dev-objects/',
99+
collapsible: true,
100+
items: [
101+
{ text: 'Documentation', link: '/documentation/dev-objects/' }, {
102+
text: 'Classes', link: '/documentation/dev-objects/classes/', items: [
103+
{ text: 'ZCL_ODATA_DATA_PROVIDER', link: '/documentation/dev-objects/classes/ZCL_ODATA_DATA_PROVIDER' },
104+
{ text: 'ZCL_ODATA_DOCUMENTS', link: '/documentation/dev-objects/classes/ZCL_ODATA_DOCUMENTS' },
105+
{ text: 'ZCL_ODATA_FW_CONTROLLER', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_CONTROLLER' },
106+
{ text: 'ZCL_ODATA_FW_CUST_DPC', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_CUST_DPC' },
107+
{ text: 'ZCL_ODATA_FW_CUST', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_CUST' },
108+
{ text: 'ZCL_ODATA_FW_MPC', link: '/documentation/dev-objects/classes/ZCL_ODATA_FW_MPC' },
109+
{ text: 'ZCL_ODATA_MAIN', link: '/documentation/dev-objects/classes/ZCL_ODATA_MAIN' },
110+
{ text: 'ZCL_ODATA_UTILS', link: '/documentation/dev-objects/classes/ZCL_ODATA_UTILS' },
111+
{ text: 'ZCL_ODATA_VALUE_HELP', link: '/documentation/dev-objects/classes/ZCL_ODATA_VALUE_HELP' },
112+
{
113+
text: 'Annotations', link: '/documentation/dev-objects/classes/annotations/', items: [
114+
{ text: 'ZCL_ODATA_ANNOTATION_COMMON', link: '/documentation/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_COMMON' },
115+
{ text: 'ZCL_ODATA_ANNOTATION_SHLP', link: '/documentation/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_SHLP' },
116+
]
117+
},
118+
]
119+
}, {
120+
text: 'DDIC objects', link: '/documentation/dev-objects/ddic/', collapsible: true
121+
},
122+
{
123+
text: 'SAP objects', link: '/documentation/dev-objects/sap-objects/'
124+
}]
49125
}
50-
}
51-
})
126+
];
127+
}

‎docs/documentation/Creating-a-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ PUBLIC SECTION.
4949
METHODS define REDEFINITION.
5050
```
5151

52-
Next we add the OData framework by calling the "define_mpc" method of the framework class ([ZCL_ODATA_FW_CONTROLLER](../dev-objects/classes/ZCL_ODATA_FW_CONTROLLER)). Notice, that 'Z_MY_PROJECT' is the namespace, that we need to use in the framework view cluster.
52+
Next we add the OData framework by calling the "define_mpc" method of the framework class ([ZCL_ODATA_FW_CONTROLLER](./dev-objects/classes/ZCL_ODATA_FW_CONTROLLER)). Notice, that 'Z_MY_PROJECT' is the namespace, that we need to use in the framework view cluster.
5353

5454
```abap
5555
METHOD define.

‎docs/documentation/OData-Customizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To define entities you need to select the namespace you want to define an entity
3232

3333
![define entity](./attachments/cust_define_entity.png)
3434

35-
The classes added to the customizing should inherit from "[ZCL_ODATA_MAIN](../dev-objects/classes/ZCL_ODATA_MAIN)" class.
35+
The classes added to the customizing should inherit from "[ZCL_ODATA_MAIN](./dev-objects/classes/ZCL_ODATA_MAIN)" class.
3636

3737
## Define Properties
3838

‎docs/dev-objects/classes/ZCL_ODATA_DATA_PROVIDER.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_DATA_PROVIDER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: ZCL_ODATA_DATA_PROVIDER
44

55
# {{ $frontmatter.title }}
66

7-
This class contains the data provider classes for the odata service. Every data provider needs to inherit from the [[ZCL_ODATA_MAIN]] class.
7+
This class contains the data provider classes for the odata service. Every data provider needs to inherit from the [ZCL_ODATA_MAIN](./ZCL_ODATA_MAIN) class.
88

99
## Methods
1010

‎docs/dev-objects/classes/ZCL_ODATA_DOCUMENTS.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_DOCUMENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ This method reads out the stream of the document. The stream contains the binary
3333

3434
#### get_file
3535

36-
This method reads out the file data and returns it as structure of type [[ZODATA_FILE]].
37-
It is called within the method [[#get_stream]] and should be redefined in the inherited class.
36+
This method reads out the file data and returns it as structure of type [ZODATA_FILE](./ddic/structures/ZODATA_FILE).
37+
It is called within the method [get_strean](#get_stream) and should be redefined in the inherited class.
3838

3939
#### get_mime_type_from_type
4040

‎docs/dev-objects/classes/ZCL_ODATA_FW_CONTROLLER.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_FW_CONTROLLER.md

File renamed without changes.

‎docs/dev-objects/classes/ZCL_ODATA_FW_CUST.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_FW_CUST.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
description: Framework customizing class
33
title: ZCL_ODATA_FW_CUST
4-
tags:
5-
- customizing
6-
date created: Friday, September 8th 2023, 9:50:10 am
7-
date modified: Friday, September 8th 2023, 10:01:05 am
84
---
95

106
# {{ $frontmatter.title }}

‎docs/dev-objects/classes/ZCL_ODATA_FW_CUST_DPC.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_FW_CUST_DPC.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
---
22
title: ZCL_ODATA_FW_CUST_DPC
33
description: DPC Class
4-
date created: Tuesday, September 5th 2023, 11:14:46 pm
5-
date modified: Friday, September 8th 2023, 10:01:11 am
6-
tags:
7-
- dpc
8-
- customizing
94
---
105
# {{ $frontmatter.title }}
116

‎docs/dev-objects/classes/ZCL_ODATA_FW_MPC.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_FW_MPC.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
---
22
title: ZCL_ODATA_FW_MPC
33
description: MPC Framework class
4-
tags:
5-
- mpc
6-
- customizing
7-
date created: Tuesday, September 5th 2023, 11:07:54 pm
8-
date modified: Friday, September 8th 2023, 10:01:24 am
94
---
105
# {{ $frontmatter.title }}
116

‎docs/dev-objects/classes/ZCL_ODATA_MAIN.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_MAIN.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
22
title: ZCL_ODATA_MAIN
33
description: Class ZCL_ODATA_MAIN
4-
date created: Wednesday, August 23rd 2023, 6:18:18 pm
5-
date modified: Friday, September 8th 2023, 9:57:18 am
64
---
75
# {{ $frontmatter.title }}
86

97
This abstract class is the blueprint for every entity class used by this framework.
108

11-
## [[-IWBEP-IF_MGW_APPL_SRV_RUNTIME|/IWBEP/IF_MGW_APPL_SRV_RUNTIME]]
9+
## [/IWBEP/IF_MGW_APPL_SRV_RUNTIME](../sap-objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME)
1210

1311
Every method of the "/iwbep/if_mgw_appl_srv_runtime" interface can be redefined in the sub class. Only the methods that you really need have to be redefined.
1412

@@ -45,9 +43,9 @@ This method applies dynamic filtering, pagination and sorting to the current ent
4543
4644
The options can also be called separate.
4745

48-
- [[#PAGINATE_COLLECTION]]
49-
- [[#FILTER_COLLECTION]]
50-
- [[#ORDER_COLLECTION]]
46+
- [PAGINATE_COLLECTION](#PAGINATE_COLLECTION)
47+
- [FILTER_COLLECTION](#FILTER_COLLECTION)
48+
- [ORDER_COLLECTION](#ORDER_COLLECTION)
5149

5250
### PAGINATE_COLLECTION
5351

‎docs/dev-objects/classes/ZCL_ODATA_UTILS.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_UTILS.md

File renamed without changes.

‎docs/dev-objects/classes/ZCL_ODATA_VALUE_HELP.md renamed to ‎docs/documentation/dev-objects/classes/ZCL_ODATA_VALUE_HELP.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,25 @@
11
---
22
description: Class for value help entity
33
title: ZCL_ODATA_VALUE_HELP
4-
date created: Friday, September 8th 2023, 9:50:10 am
5-
date modified: Friday, September 8th 2023, 10:00:20 am
6-
tags:
7-
- entity
84
---
95

106
# {{ $frontmatter.title }}
117

12-
This class is used for the [[global value help]] entity.
13-
This class inherits from [[ZCL_ODATA_MAIN]].
8+
This class is used for the [global value help](../../global/global-value-help) entity.
9+
This class inherits from [ZCL_ODATA_MAIN](./ZCL_ODATA_MAIN).
1410

1511
## Methods
1612

1713
### Public
1814

1915
#### get_entityset
2016

21-
This method is redefined from the super class with the interface [[-IWBEP-IF_MGW_APPL_SRV_RUNTIME|/IWBEP/IF_MGW_APPL_SRV_RUNTIME]].
17+
This method is redefined from the super class with the interface [/IWBEP/IF_MGW_APPL_SRV_RUNTIME](../sap-objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME).
2218
This method reads out the values for the value help and returns them.
2319

2420
#### get_entity
2521

26-
This method is redefined from the super class with the interface [[-IWBEP-IF_MGW_APPL_SRV_RUNTIME|/IWBEP/IF_MGW_APPL_SRV_RUNTIME]].
22+
This method is redefined from the super class with the interface [/IWBEP/IF_MGW_APPL_SRV_RUNTIME](../sap-objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME).
2723
This method returns the value help for a specific value.
2824

2925
### Private

‎docs/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_COMMON.md renamed to ‎docs/documentation/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_COMMON.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
title: ZCL_ODATA_ANNOTATION_COMMON
33
description: Common annotation class
4-
date created: Tuesday, September 5th 2023, 11:17:29 pm
5-
date modified: Tuesday, September 5th 2023, 11:18:35 pm
6-
tags:
7-
- annotation
84
---
95
# {{ $frontmatter.title }}
106

‎docs/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_SHLP.md renamed to ‎docs/documentation/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_SHLP.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
---
22
title: ZCL_ODATA_ANNOTATION_SHLP
33
description: Search help annotations
4-
date created: Tuesday, September 5th 2023, 11:18:38 pm
5-
date modified: Tuesday, September 5th 2023, 11:44:25 pm
6-
tags:
7-
- annotation
84
---
95
# {{ $frontmatter.title }}
106

11-
Inheritates from [[ZCL_ODATA_ANNOTATION_COMMON]]. Adds the search help annotations to the odata service.
7+
Inheritates from [ZCL_ODATA_ANNOTATION_COMMON](./ZCL_ODATA_ANNOTATION_COMMON). Adds the search help annotations to the odata service.
128

139
## Methods
1410

‎docs/dev-objects/classes/annotations/index.md renamed to ‎docs/documentation/dev-objects/classes/annotations/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
title: Annotations
33
description: Annotation classes
4-
date created: Tuesday, September 5th 2023, 11:16:53 pm
5-
date modified: Tuesday, September 5th 2023, 11:47:16 pm
6-
tags:
7-
- annotation
84
---
95
# {{ $frontmatter.title }}
106

0 commit comments

Comments
 (0)
0