diff --git a/src/.vuepress/public/img/debug-info-1.png b/src/.vuepress/public/img/debug-info-1.png new file mode 100644 index 000000000..5d7e913b2 Binary files /dev/null and b/src/.vuepress/public/img/debug-info-1.png differ diff --git a/src/.vuepress/public/img/debug-info-2.png b/src/.vuepress/public/img/debug-info-2.png new file mode 100644 index 000000000..965ac4549 Binary files /dev/null and b/src/.vuepress/public/img/debug-info-2.png differ diff --git a/src/.vuepress/public/img/debug-info-3.png b/src/.vuepress/public/img/debug-info-3.png new file mode 100644 index 000000000..813121341 Binary files /dev/null and b/src/.vuepress/public/img/debug-info-3.png differ diff --git a/src/.vuepress/public/img/debug-info-4.png b/src/.vuepress/public/img/debug-info-4.png new file mode 100644 index 000000000..d85c8274d Binary files /dev/null and b/src/.vuepress/public/img/debug-info-4.png differ diff --git a/src/.vuepress/public/img/debug-info-5.png b/src/.vuepress/public/img/debug-info-5.png new file mode 100644 index 000000000..f35378b14 Binary files /dev/null and b/src/.vuepress/public/img/debug-info-5.png differ diff --git a/src/.vuepress/public/img/ie-dev-tools-1.png b/src/.vuepress/public/img/ie-dev-tools-1.png new file mode 100644 index 000000000..daa0cf508 Binary files /dev/null and b/src/.vuepress/public/img/ie-dev-tools-1.png differ diff --git a/src/.vuepress/public/img/ie-dev-tools-2.png b/src/.vuepress/public/img/ie-dev-tools-2.png new file mode 100644 index 000000000..1a72c466f Binary files /dev/null and b/src/.vuepress/public/img/ie-dev-tools-2.png differ diff --git a/src/.vuepress/public/img/objects-to-files-1.png b/src/.vuepress/public/img/objects-to-files-1.png new file mode 100644 index 000000000..0e0a61516 Binary files /dev/null and b/src/.vuepress/public/img/objects-to-files-1.png differ diff --git a/src/.vuepress/public/img/objects-to-files-2.png b/src/.vuepress/public/img/objects-to-files-2.png new file mode 100644 index 000000000..86395fadb Binary files /dev/null and b/src/.vuepress/public/img/objects-to-files-2.png differ diff --git a/src/.vuepress/public/img/package-to-zip.png b/src/.vuepress/public/img/package-to-zip.png new file mode 100644 index 000000000..29d5db7d9 Binary files /dev/null and b/src/.vuepress/public/img/package-to-zip.png differ diff --git a/src/user-guide/README.md b/src/user-guide/README.md index 7fb48f710..2524062f9 100644 --- a/src/user-guide/README.md +++ b/src/user-guide/README.md @@ -54,6 +54,15 @@ index: false - [Background Mode](repo-settings/background-mode.md) - [Statistics](repo-settings/stats.md) +## Tools + +- [Database Utility](tools/database-util.md) +- [Package to ZIP](tools/package-to-zip.md) +- [Transport to ZIP](tools/transport-to-zip.md) +- [Objects to Files](tools/objects-to-files.md) +- [Debug Info](tools/debug-info.md) +- [IE Dev Tools](tools/ie-dev-tools.md) + ### Reference - [Translations and I18n](reference/translations.md) @@ -69,7 +78,6 @@ index: false - [ABAP Language Version](reference/abap-language-version.md) - [Note Analyzer](reference/note-analyzer.md) - [APACK](reference/apack.md) -- [Database Utility](reference/database-util.md) ### Other diff --git a/src/user-guide/reference/README.md b/src/user-guide/reference/README.md index c9b67909c..89c08e97d 100644 --- a/src/user-guide/reference/README.md +++ b/src/user-guide/reference/README.md @@ -22,4 +22,4 @@ order: 50 - [ABAP Language Version](abap-language-version.md) - [Note Analyzer](note-analyzer.md) - [APACK](apack.md) -- [Database Utility](database-util.md) + diff --git a/src/user-guide/tools/README.md b/src/user-guide/tools/README.md new file mode 100644 index 000000000..d4f12f0f1 --- /dev/null +++ b/src/user-guide/tools/README.md @@ -0,0 +1,18 @@ +--- +title: Tools +icon: tools +article: false +index: false +dir: + order: 45 +--- + +## Tools + +- [Database Utility](database-util.md) +- [Package to ZIP](package-to-zip.md) +- [Transport to ZIP](transport-to-zip.md) +- [Objects to Files](objects-to-files.md) +- [Debug Info](debug-info.md) +- [IE Dev Tools](ie-dev-tools.md) + diff --git a/src/user-guide/reference/database-util.md b/src/user-guide/tools/database-util.md old mode 100755 new mode 100644 similarity index 99% rename from src/user-guide/reference/database-util.md rename to src/user-guide/tools/database-util.md index daa6b70e8..33aa9b54c --- a/src/user-guide/reference/database-util.md +++ b/src/user-guide/tools/database-util.md @@ -1,7 +1,7 @@ --- title: Database Utility -category: reference -order: 99 +category: tools +order: 10 --- `Database Utility` is a tool for managing database entries created by abapGit. You can access the tool via the tools icon in the top right corner of the abapGit home page [](/img/utilities.png). diff --git a/src/user-guide/tools/debug-info.md b/src/user-guide/tools/debug-info.md new file mode 100644 index 000000000..c0e173243 --- /dev/null +++ b/src/user-guide/tools/debug-info.md @@ -0,0 +1,33 @@ +--- +title: Debug Info +category: tools +order: 50 +--- + +The "Debug Info" page contains four sections: + +### abapGit Version + +Shows if this is the abapGit Developer or Standalone Version and in which package abapGit is installed: + +![Developer Version](/img/debug-info-1.png) + +![Standalone Version](/img/debug-info-2.png) + +### Environment + +Various version and timestamp details: + +![Environment](/img/debug-info-3.png) + +### User Exits + +Shows a list of available user exits with implementation status: + +![User Exits](/img/debug-info-4.png) + +### Supported Objects + +This section contains a list of all object types that are supported in the current system: object description, serializer class, serializer version, and deserializer steps that this object type uses. + +![Supported Objects](/img/debug-info-5.png) diff --git a/src/user-guide/tools/ie-dev-tools.md b/src/user-guide/tools/ie-dev-tools.md new file mode 100644 index 000000000..c4e5976cb --- /dev/null +++ b/src/user-guide/tools/ie-dev-tools.md @@ -0,0 +1,23 @@ +--- +title: IE Developer Tools +category: tools +order: 60 +--- + +If you want to analyze the HTML pages generated by abapGit, use the IE Developer Tools. + +### Prerequisites + +- SAP GUI for Windows +- Internet Explorer Browser Control +- Local IE Developer Tools Installation + +### Analysis + +Go to the Repository Overview and select "Tools > Open IE Dev Tools" from the menu. On the following popup, pick the "abapGit" browser session. + +![Start](/img/ie-dev-tools-1.png) + +The following window will show the DOM Explorer and CSS properties: + +![Check](/img/ie-dev-tools-2.png) diff --git a/src/user-guide/tools/objects-to-files.md b/src/user-guide/tools/objects-to-files.md new file mode 100644 index 000000000..c41381736 --- /dev/null +++ b/src/user-guide/tools/objects-to-files.md @@ -0,0 +1,15 @@ +--- +title: Objects to Files +category: tools +order: 40 +--- + +Serialize one or several objects (of the same type) and save the files locally. + +You will be prompted for the target folder for each selected object. + +### Example + +![Dialog](/img/objects-to-files-1.png) + +![Result](/img/objects-to-files-2.png) diff --git a/src/user-guide/tools/package-to-zip.md b/src/user-guide/tools/package-to-zip.md new file mode 100644 index 000000000..30a0f16a2 --- /dev/null +++ b/src/user-guide/tools/package-to-zip.md @@ -0,0 +1,15 @@ +--- +title: Package to ZIP +category: tools +order: 20 +--- + +Export an SAP Package, optionally with sub-packages, to a ZIP file: + +![Dialog](/img/package-to-zip.png) + +The resulting ZIP will contain files for all serialized objects that were included in the selected package(s). The format allows you to use the ZIP to import the objects into another system using an offline repository. + +:::info +The package does not have to be configured as a repository in abapGit. +::: diff --git a/src/user-guide/tools/transport-to-zip.md b/src/user-guide/tools/transport-to-zip.md new file mode 100644 index 000000000..76eb542c8 --- /dev/null +++ b/src/user-guide/tools/transport-to-zip.md @@ -0,0 +1,11 @@ +--- +title: Transport to ZIP +category: tools +order: 30 +--- + +Export objects contained in a transport request to a ZIP file. + +The resulting ZIP will contain files for objects that were included in the selected package(s). + +Partial objects (LIMU) are resolved into the parent object (R3TR) they belong to.