refactor: ♻️ changed title to frontmatter

miggi92 · Apr 24, 2024 · 406819f · 406819f
1 parent 1fed57b
commit 406819f
Show file tree

Hide file tree

Showing 30 changed files with 43 additions and 44 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -4,6 +4,7 @@ import { defineConfig } from 'vitepress'
 export default defineConfig({
   title: "ABAP OData Framework",
   lang: 'en-US',
+  base: '/odata-fw/',
   description: "A odata framework for a SAP System. ",
   head: [['link', { rel: 'icon', href: '../assets/favicon.ico' }]],
   sitemap: {
@@ -15,6 +16,17 @@ export default defineConfig({
       { text: 'Home', link: '/' },
       { text: 'Documentation', link: '/documentation/' }
     ],
+    search: {
+      provider: 'local',
+      options: {
+        _render(src, env, md) {
+          const html = md.render(src, env)
+          if (env.frontmatter?.title)
+            return md.render(`# ${env.frontmatter.title}`) + html
+          return html
+        }
+      }
+    },
 
     sidebar: [
       {

diff --git a/docs/changelog/.authors.yml b/docs/changelog/.authors.yml
diff --git a/docs/changelog/index.md b/docs/changelog/index.md
@@ -7,6 +7,6 @@ hidden: true
 date created: Tuesday, September 5th 2023, 10:36:51 am
 date modified: Tuesday, September 5th 2023, 5:12:21 pm
 ---
-# Changelog
+#  {{ $frontmatter.title }}
 
 Here you can find the latest changes in the blog posts.
diff --git a/docs/changelog/releases/v1.0.1.md b/docs/changelog/releases/v1.0.1.md
@@ -14,7 +14,7 @@ authors:
 
 New features and bug fixes for the v1.0.1 release.
 
-# V1.0.1
+#  {{ $frontmatter.title }}
 
 ## Added
 - create deep entity customizing | Issue [#9]

diff --git a/docs/changelog/releases/v1.0.2.md b/docs/changelog/releases/v1.0.2.md
@@ -14,7 +14,7 @@ authors:
 > [!warning]
 > Not released yet
 
-# V1.0.2
+#  {{ $frontmatter.title }}
 
 ## Added
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_DATA_PROVIDER.md b/docs/dev-objects/classes/ZCL_ODATA_DATA_PROVIDER.md
@@ -2,7 +2,7 @@
 title: ZCL_ODATA_DATA_PROVIDER
 ---
 
-# ZCL_ODATA_DATA_PROVIDER
+#  {{ $frontmatter.title }}
 
 This class contains the data provider classes for the odata service. Every data provider needs to inherit from the [[ZCL_ODATA_MAIN]] class.
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_DOCUMENTS.md b/docs/dev-objects/classes/ZCL_ODATA_DOCUMENTS.md
@@ -7,9 +7,9 @@ date created: Friday, September 8th 2023, 9:50:10 am
 date modified: Friday, September 8th 2023, 10:00:28 am
 ---
 
-# ZCL_ODATA_DOCUMENTS
+#  {{ $frontmatter.title }}
 
-This class inherits from [[ZCL_ODATA_MAIN]]. 
+This class inherits from [ZCL_ODATA_MAIN](./ZCL_ODATA_MAIN). 
 It contains an abstract document entity for the odata service.
 This class helps to handle the an document entity in the odata service.
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_FW_CONTROLLER.md b/docs/dev-objects/classes/ZCL_ODATA_FW_CONTROLLER.md
@@ -4,7 +4,7 @@ description: Framework controller class
 date created: Tuesday, September 5th 2023, 11:10:30 pm
 date modified: Tuesday, September 5th 2023, 11:12:18 pm
 ---
-# ZCL_ODATA_FW_CONTROLLER
+#  {{ $frontmatter.title }}
 
 The controller class, that will be called in the "DPC_EXT" and "MPC_EXT" classes.
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_FW_CUST.md b/docs/dev-objects/classes/ZCL_ODATA_FW_CUST.md
@@ -7,7 +7,7 @@ date created: Friday, September 8th 2023, 9:50:10 am
 date modified: Friday, September 8th 2023, 10:01:05 am
 ---
 
-# ZCL_ODATA_FW_CUST
+#  {{ $frontmatter.title }}
 
 This class reads out the customizing and stores it for the other classes.
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_FW_CUST_DPC.md b/docs/dev-objects/classes/ZCL_ODATA_FW_CUST_DPC.md
@@ -7,7 +7,7 @@ tags:
   - dpc
   - customizing
 ---
-# ZCL_ODATA_FW_CUST_DPC
+#  {{ $frontmatter.title }}
 
 
 ## Methods

diff --git a/docs/dev-objects/classes/ZCL_ODATA_FW_MPC.md b/docs/dev-objects/classes/ZCL_ODATA_FW_MPC.md
@@ -7,7 +7,7 @@ tags:
 date created: Tuesday, September 5th 2023, 11:07:54 pm
 date modified: Friday, September 8th 2023, 10:01:24 am
 ---
-# ZCL_ODATA_FW_MPC
+#  {{ $frontmatter.title }}
 
 
 ## Methods

diff --git a/docs/dev-objects/classes/ZCL_ODATA_MAIN.md b/docs/dev-objects/classes/ZCL_ODATA_MAIN.md
@@ -4,7 +4,7 @@ description: Class ZCL_ODATA_MAIN
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Friday, September 8th 2023, 9:57:18 am
 ---
-# ZCL_ODATA_MAIN
+#  {{ $frontmatter.title }}
 
 This abstract class is the blueprint for every entity class used by this framework.
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_UTILS.md b/docs/dev-objects/classes/ZCL_ODATA_UTILS.md
@@ -2,7 +2,7 @@
 title: ZCL_ODATA_UTILS
 ---
 
-# ZCL_ODATA_UTILS
+#  {{ $frontmatter.title }}
 
 This class contains some utility methods for the odata framework.
 

diff --git a/docs/dev-objects/classes/ZCL_ODATA_VALUE_HELP.md b/docs/dev-objects/classes/ZCL_ODATA_VALUE_HELP.md
@@ -7,7 +7,7 @@ tags:
   - entity
 ---
 
-# ZCL_ODATA_VALUE_HELP
+#  {{ $frontmatter.title }}
 
 This class is used for the [[global value help]] entity.
 This class inherits from [[ZCL_ODATA_MAIN]].

diff --git a/docs/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_COMMON.md b/docs/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_COMMON.md
@@ -6,7 +6,7 @@ date modified: Tuesday, September 5th 2023, 11:18:35 pm
 tags:
   - annotation
 ---
-# ZCL_ODATA_ANNOTATION_COMMON
+#  {{ $frontmatter.title }}
 
 Abstract class for the [common annotations](https://sap.github.io/odata-vocabularies/vocabularies/Common.html).
 
diff --git a/docs/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_SHLP.md b/docs/dev-objects/classes/annotations/ZCL_ODATA_ANNOTATION_SHLP.md
@@ -6,7 +6,7 @@ date modified: Tuesday, September 5th 2023, 11:44:25 pm
 tags:
   - annotation
 ---
-# ZCL_ODATA_ANNOTATION_SHLP
+#  {{ $frontmatter.title }}
 
 Inheritates from [[ZCL_ODATA_ANNOTATION_COMMON]]. Adds the search help annotations to the odata service.
 

diff --git a/docs/dev-objects/classes/annotations/index.md b/docs/dev-objects/classes/annotations/index.md
@@ -6,7 +6,7 @@ date modified: Tuesday, September 5th 2023, 11:47:16 pm
 tags:
   - annotation
 ---
-# Annotations
+#  {{ $frontmatter.title }}
 
 
 ## Class UML

diff --git a/docs/dev-objects/classes/index.md b/docs/dev-objects/classes/index.md
@@ -4,7 +4,7 @@ description: Overview of the classes of the framework
 date created: Tuesday, September 5th 2023, 5:22:45 pm
 date modified: Tuesday, September 5th 2023, 11:14:38 pm
 ---
-# Classes
+#  {{ $frontmatter.title }}
 
 ## Class Documentations
 

diff --git a/docs/dev-objects/index.md b/docs/dev-objects/index.md
@@ -4,8 +4,8 @@ title: Development Objects
 date created: Friday, September 8th 2023, 9:50:10 am
 date modified: Friday, September 8th 2023, 9:58:44 am
 ---
-# Development Objects
+#  {{ $frontmatter.title }}
 
-## [[dev objects/classes/index|Classes]]
+## [Classes](./classes/)
 
-## [[dev objects/sap objects/index|SAP Objects]]
+## [SAP Objects](./sap-objects/)
diff --git a/...objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME.md → ...objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME.md b/...objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME.md → ...objects/-IWBEP-IF_MGW_APPL_SRV_RUNTIME.md
@@ -8,7 +8,7 @@ authors:
   - miggi92
 ---
 
-# /IWBEP/IF_MGW_APPL_SRV_RUNTIME
+#  {{ $frontmatter.title }}
 
 This interface is used from the odata gateway to get the data. 
 

diff --git a/docs/dev-objects/sap objects/index.md → docs/dev-objects/sap-objects/index.md b/docs/dev-objects/sap objects/index.md → docs/dev-objects/sap-objects/index.md
@@ -2,4 +2,4 @@
 title: SAP Objects
 ---
 
-# SAP Objects
+#  {{ $frontmatter.title }}
diff --git a/docs/dev-objects/tables/index.md b/docs/dev-objects/tables/index.md
@@ -2,4 +2,4 @@
 title: Tables
 ---
 
-# Tables
+#  {{ $frontmatter.title }}
diff --git a/docs/documentation/DPC-boilerplate-code.md b/docs/documentation/DPC-boilerplate-code.md
@@ -6,7 +6,7 @@ tags:
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Tuesday, September 5th 2023, 5:37:59 pm
 ---
-# DPC Boilerplate Code
+#  {{ $frontmatter.title }}
 
 ## get_entity
 

diff --git a/docs/documentation/Deep-entities.md b/docs/documentation/Deep-entities.md
@@ -4,7 +4,7 @@ description: Deep entities
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Tuesday, September 5th 2023, 5:37:56 pm
 ---
-# Deep Entities
+#  {{ $frontmatter.title }}
 
 ## Boilerplate Coding for Implementing
 

diff --git a/docs/documentation/OData-Customizing.md b/docs/documentation/OData-Customizing.md
@@ -6,7 +6,7 @@ tags:
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Tuesday, September 5th 2023, 5:38:06 pm
 ---
-# OData Customizing
+#  {{ $frontmatter.title }}
 
 ## Transaction
 

diff --git a/docs/documentation/definitions/DPC.md b/docs/documentation/definitions/DPC.md
@@ -7,6 +7,6 @@ tags:
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Tuesday, September 5th 2023, 5:37:34 pm
 ---
-# DPC
+#  {{ $frontmatter.title }}
 
 **D**ata **P**rovider **C**lass
diff --git a/docs/documentation/definitions/MPC.md b/docs/documentation/definitions/MPC.md
@@ -7,6 +7,6 @@ tags:
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Tuesday, September 5th 2023, 11:08:30 pm
 ---
-# MPC
+#  {{ $frontmatter.title }}
 
 **M**odel **P**rovider **C**lass
diff --git a/docs/documentation/definitions/SEGW.md b/docs/documentation/definitions/SEGW.md
@@ -6,7 +6,7 @@ tags:
 date created: Wednesday, August 23rd 2023, 6:18:18 pm
 date modified: Tuesday, September 5th 2023, 5:37:45 pm
 ---
-# SEGW
+#  {{ $frontmatter.title }}
 
 This is a SAP Transaction to create an OData service.
 

diff --git a/docs/documentation/global/global value help.md b/docs/documentation/global/global value help.md
@@ -2,4 +2,4 @@
 title: global value help
 ---
 
-# global value help
+#  {{ $frontmatter.title }}
diff --git a/docs/documentation/index.md b/docs/documentation/index.md
@@ -4,7 +4,7 @@ description: OData Framework Documentation
 date created: Tuesday, September 5th 2023, 11:24:45 am
 date modified: Tuesday, September 5th 2023, 5:38:03 pm
 ---
-# OData Framework Documentation
+#  {{ $frontmatter.title }}
 
 ## Creating the First Service