Skip to content

Commit

Permalink
Merge branch 'main' into mbtools/file_format
Browse files Browse the repository at this point in the history
  • Loading branch information
mbtools authored Feb 8, 2024
2 parents e142e1e + 7e0ee82 commit 8223aec
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 10 deletions.
10 changes: 9 additions & 1 deletion src/development-guide/read-first/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ Exceptions for existing objects:

#### Object Prefixing

Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes). The description of objects should begin with `abapGit - ...`.
Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes).

### Object Descriptions

The description of objects should begin with `abapGit - ...` (for example, `abapGit - Repository Content List`). For [serializer classes](/development-guide/serializers/overview.html), the text should contain the `TADIR` object type and description (for example, `abapGit - INTF - Interface (ABAP Objects)`).

#### Variable Prefixing

Expand Down Expand Up @@ -66,6 +70,10 @@ Pull requests must pass all abaplint configured checks before they can be merged
You can view abaplint findings directly in abapGit using an [extension](https://github.com/Marc-Bernard-Tools/ABAP-Lint-Ext-for-abapGit).
:::

### eslint

JavaScript is checked using eslint. You can find the rules [here](https://github.com/abapGit/abapGit/blob/main/.eslintrc.yaml). All JavaScript code has to adhere to ES5 ([ECMAScript 2009](https://en.wikipedia.org/wiki/ECMAScript_version_history)) to be compatible with the IE-based HTML browser control used in older releases of SAP GUI.

### Internationalization (I18N)

abapGit supports only the English language. Neither objects nor text literals are translated. Therefore, all objects shall be set to English as the original language, and text literals in the code shall be maintained in English.
Expand Down
2 changes: 1 addition & 1 deletion src/development-guide/serializers/serializers.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ In general, the serializer class shall process texts of an object in all availab

The recommended approach is to check `io_xml->i18n_params( )-main_language_only = abap_false` and then serialize the additional translations in the XML (typically using the `I18N` prefix). During deserialize, the translation languages can then be retrieved and processed accordingly.

Example: [`TABL`](https://github.com/abapGit/abapGit/blob/main/src/objects/zcl_abapgit_object_tabl.clas.abap).
Example: [`TABL`](https://github.com/abapGit/abapGit/blob/main/src/objects/tabl/zcl_abapgit_object_tabl.clas.abap).

Note: A new approach for serializing translations based on LXE is under development. See [#4470](https://github.com/abapGit/abapGit/issues/4470) for further details and discussion.

Expand Down
2 changes: 1 addition & 1 deletion src/development-guide/testing/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If you are using SAP GUI 7.7 or higher with *Edge (Chrome)* browser control, use

[General: Debug WebView2 Apps](https://docs.microsoft.com/en-us/microsoft-edge/webview2/how-to/debug?tabs=devtools)
SAP Note [3099670](https://me.sap.com/notes/3099670) - SAP GUI for Windows Chromium-based Edge Control: Adding remote debugging feature
[How to Debug WebView2 in SAP GUI](https://blogs.sap.com/2023/01/20/sap-gui-for-windows-8.00-is-coming-on-27th-of-january-2023-new-features-lifecycle-information/comment-page-1/#comment-680362)
[How to Debug WebView2 in SAP GUI](https://community.sap.com/t5/technology-blogs-by-sap/sap-gui-for-windows-8-00-is-coming-on-27th-of-january-2023-new-features/ba-p/13570993)

### SAP GUI for HTML (Web)

Expand Down
4 changes: 2 additions & 2 deletions src/user-guide/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Download the latest version of the abapGit developer version from <https://gith
1. On the repository list page, select "New Offline"
1. Enter repo name `abapGit` and package name `$ABAPGIT` (or select an existing or create a new package)
1. Select "Create Offline Repo"
1. Select "Import <sup>zip</sup>"
1. Select "Import zip"
1. Select the _abapGit-main.zip_ file
1. Select "Pull <sup>zip</sup>"
1. Select "Pull zip"

Transaction `ZABAPGIT` is now available to run the developer version.
6 changes: 3 additions & 3 deletions src/user-guide/getting-started/ui-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ Click the name to select a different branch or tag.

### Package

The root package of the repository is shown on the far left. Click the name to jump to the package maintenance.
The root package of the repository is shown on the far right. Click the name to jump to the package maintenance.

## Page Content

In the area between header and footer is filled differently depending on the selected page or command. Some pages like the repository list and repository view contain an additional menu bar. Pages that contain input forms, use the top menu bar to switch between forms (like tabs) and a row of buttons at the bottom to select commands.
The area between header and footer is filled differently depending on the selected page or command. Some pages like the repository list and repository view contain an additional menu bar. Pages that contain input forms, use the top menu bar to switch between forms (like tabs) and a row of buttons at the bottom to select commands.

## Page Footer

Expand All @@ -88,7 +88,7 @@ On the left, you find a link to the [Sponsor Us](https://abapgit.org/sponsor.htm

### Version

In the middle under the abapGit logo, you see the current version of abapGit. This includes version number and a description whether you can running the [standalone](/user-guide/getting-started/install.html#install-standalone-version) or the [developer version](/user-guide/getting-started/install.html#install-developer-version).
In the middle under the abapGit logo, you see the current version of abapGit. This includes version number and a description whether you are running the [standalone](/user-guide/getting-started/install.html#install-standalone-version) or the [developer version](/user-guide/getting-started/install.html#install-developer-version).

Hovering of the logo shows the backend runtime of the last navigation step. Clicking the logo takes you to the [abapGit Homepage](https://abapgit.org/).

Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/other/where-used.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ order: 50

## SAP

* [SAP IBSO](https://news.sap.com/tags/sap-innovative-business-solutions/)
* [SAP IBSO](https://sap.com)
* [SAP Labs Czech Republic](https://www.facebook.com/SAPLabsCZ/)

## Consulting and Partner
Expand Down
2 changes: 2 additions & 0 deletions src/user-guide/reference/supported.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ order: 20
| `DOCT` | General Text | **Yes** | No |
| `DOCV` | Documentation (Independent) | **Yes** | No |
| `DOMA` | Domain | **Yes** | *Planned* |
| `DRTY` | CDS Type | **Yes**, [AFF](https://github.com/SAP/abap-file-formats) | **Yes** |
| `DRUL` | Dependency Rule | **Yes** | No |
| `DSYS` | Chapter of a Book Structure | **Yes** | No |
| `DTDC` | Dynamic Cache | **Yes** | *Planned* |
| `DTEB` | CDS Entity Buffer | **Yes**, [AFF](https://github.com/SAP/abap-file-formats) | **Yes** |
| `DTEL` | Data Element | **Yes** | *Planned* |
| `ECAT` | eCATT Test Script | **Yes** | No |
| `ECSD` | eCATT System Data Container | **Yes** | No |
Expand Down
17 changes: 16 additions & 1 deletion src/user-guide/setup/ssl-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,11 +149,26 @@ The following blog posts on the SAP Community Network might be helpful:
- [Calling WebServices from ABAP via HTTPS/SSL with pfx certificates](https://scn.sap.com/people/jens.gleichmann/blog/2008/10/31/calling-webservices-from-abap-via-httpsssl-with-pfx-certificates)
- [BSP a Developer’s Journal Part XIV – Consuming WebServices with ABAP](https://scn.sap.com/people/thomas.jung/blog/2004/11/17/bsp-a-developers-journal-part-xiv--consuming-webservices-with-abap)

:::info
There might be user exits in play that modify the default connection behavior (see section below). Check which exits are implemented and what values they return!
:::

### Notes

#### Actions Requiring Authentication

To perform operations that require authentication, like e.g. cloning a private repository or pushing to any GitHub repository, you need to install not only the certificates for github.com but also for [https://**api**.github.com](https://api.github.com). Repeat the download and STRUST import steps as described in the sections above accordingly. (See also [#1491](https://github.com/abapGit/abapGit/issues/1491))
To perform operations that require authentication, like e.g. cloning a **private repository** or **pushing to any GitHub repository**, you need to install not only the certificates for github.com but also for [https://**api**.github.com](https://api.github.com). Repeat the download and STRUST import steps for the API server as described in the sections above accordingly (see also [#1491](https://github.com/abapGit/abapGit/issues/1491) and [#6768](https://github.com/abapGit/abapGit/issues/6768))

### User Exits

The following exits are available to customize certain aspects of connection to the Git server using ABAP:

- Using a RFC connection instead of HTTP
- Defining proxy host and port (if abapGit settings are not sufficient)
- Defining the SSL certificate section (if other than `ANONYM`)
- Identifying local systems and setting logon tickets

See [User Exits](/user-guide/reference/exits.md) for more details.

#### Accessing GitHub

Expand Down

0 comments on commit 8223aec

Please sign in to comment.