Skip to content

Commit 05c76bf

Browse files
authored
Add docs for "Tools" menu (#268)
1 parent a0259b4 commit 05c76bf

19 files changed

+127
-4
lines changed
13.4 KB
Loading
7.47 KB
Loading
13.4 KB
Loading
39 KB
Loading
70.6 KB
Loading
9.55 KB
Loading
43.9 KB
Loading
19.8 KB
Loading
Loading
19.9 KB
Loading

src/user-guide/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,15 @@ index: false
5555
- [Background Mode](repo-settings/background-mode.md)
5656
- [Statistics](repo-settings/stats.md)
5757

58+
## Tools
59+
60+
- [Database Utility](tools/database-util.md)
61+
- [Package to ZIP](tools/package-to-zip.md)
62+
- [Transport to ZIP](tools/transport-to-zip.md)
63+
- [Objects to Files](tools/objects-to-files.md)
64+
- [Debug Info](tools/debug-info.md)
65+
- [IE Dev Tools](tools/ie-dev-tools.md)
66+
5867
### Reference
5968

6069
- [Translations and I18n](reference/translations.md)
@@ -70,7 +79,6 @@ index: false
7079
- [ABAP Language Version](reference/abap-language-version.md)
7180
- [Note Analyzer](reference/note-analyzer.md)
7281
- [APACK](reference/apack.md)
73-
- [Database Utility](reference/database-util.md)
7482

7583
### Other
7684

src/user-guide/reference/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ order: 50
2222
- [ABAP Language Version](abap-language-version.md)
2323
- [Note Analyzer](note-analyzer.md)
2424
- [APACK](apack.md)
25-
- [Database Utility](database-util.md)
25+

src/user-guide/tools/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Tools
3+
icon: tools
4+
article: false
5+
index: false
6+
dir:
7+
order: 45
8+
---
9+
10+
## Tools
11+
12+
- [Database Utility](database-util.md)
13+
- [Package to ZIP](package-to-zip.md)
14+
- [Transport to ZIP](transport-to-zip.md)
15+
- [Objects to Files](objects-to-files.md)
16+
- [Debug Info](debug-info.md)
17+
- [IE Dev Tools](ie-dev-tools.md)
18+

src/user-guide/reference/database-util.md src/user-guide/tools/database-util.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Database Utility
3-
category: reference
4-
order: 99
3+
category: tools
4+
order: 10
55
---
66

77
`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).

src/user-guide/tools/debug-info.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Debug Info
3+
category: tools
4+
order: 50
5+
---
6+
7+
The "Debug Info" page contains four sections:
8+
9+
### abapGit Version
10+
11+
Shows if this is the abapGit Developer or Standalone Version and in which package abapGit is installed:
12+
13+
![Developer Version](/img/debug-info-1.png)
14+
15+
![Standalone Version](/img/debug-info-2.png)
16+
17+
### Environment
18+
19+
Various version and timestamp details:
20+
21+
![Environment](/img/debug-info-3.png)
22+
23+
### User Exits
24+
25+
Shows a list of available user exits with implementation status:
26+
27+
![User Exits](/img/debug-info-4.png)
28+
29+
### Supported Objects
30+
31+
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.
32+
33+
![Supported Objects](/img/debug-info-5.png)

src/user-guide/tools/ie-dev-tools.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: IE Developer Tools
3+
category: tools
4+
order: 60
5+
---
6+
7+
If you want to analyze the HTML pages generated by abapGit, use the IE Developer Tools.
8+
9+
### Prerequisites
10+
11+
- SAP GUI for Windows
12+
- Internet Explorer Browser Control
13+
- Local IE Developer Tools Installation
14+
15+
### Analysis
16+
17+
Go to the Repository Overview and select "Tools > Open IE Dev Tools" from the menu. On the following popup, pick the "abapGit" browser session.
18+
19+
![Start](/img/ie-dev-tools-1.png)
20+
21+
The following window will show the DOM Explorer and CSS properties:
22+
23+
![Check](/img/ie-dev-tools-2.png)
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Objects to Files
3+
category: tools
4+
order: 40
5+
---
6+
7+
Serialize one or several objects (of the same type) and save the files locally.
8+
9+
You will be prompted for the target folder for each selected object.
10+
11+
### Example
12+
13+
![Dialog](/img/objects-to-files-1.png)
14+
15+
![Result](/img/objects-to-files-2.png)
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Package to ZIP
3+
category: tools
4+
order: 20
5+
---
6+
7+
Export an SAP Package, optionally with sub-packages, to a ZIP file:
8+
9+
![Dialog](/img/package-to-zip.png)
10+
11+
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.
12+
13+
:::info
14+
The package does not have to be configured as a repository in abapGit.
15+
:::
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Transport to ZIP
3+
category: tools
4+
order: 30
5+
---
6+
7+
Export objects contained in a transport request to a ZIP file.
8+
9+
The resulting ZIP will contain files for objects that were included in the selected package(s).
10+
11+
Partial objects (LIMU) are resolved into the parent object (R3TR) they belong to.

0 commit comments

Comments
 (0)