diff --git a/docs/guide-settings-global.md b/docs/guide-settings-global.md new file mode 100644 index 000000000..6eef4f1bf --- /dev/null +++ b/docs/guide-settings-global.md @@ -0,0 +1,44 @@ +--- +title: Global settings +category: setup +order: 05 +--- + +Global settings in abapGit are valid system-wide and for all users. You can maintain the settings from the repository list or repository view by selecting "Settings > Global". + +![](img/settings-global-0.png) + +Note: Global settings are relevant for online projects, only. + +![](img/settings-global-1.png) +![](img/settings-global-2.png) + +## Proxy Settings + +If your server is behind a proxy, you can maintain the proxy host and port here. Do not enter any "http://" or "https://" prefix for the proxy host. Just enter the host name +or its IP address. + +If your proxy requires you to login, set the proxy authentication flag. Then abapGit will prompt you for your proxy user and password, when an online connection is required. + +In case the proxy should not be used for all repositories, exceptions can be maintained. Enter each exception on a separate line. Patterns are allowed, +for example "*.sap.internal*". + +## Commit Message Settings + +Each commit to an online repository requires a commit message. The corresponding settings define the maximum length for the comment (message header) and body. Defaults are set +to 50/72 according to the "[Rule of Well Formed Git Commit Messages](https://www.midori-global.com/blog/2018/04/02/git-50-72-rule)". + +You can also maintain a default for the comment. Variables $OBJECT and $FILE will be replaced by the number of objects or files contained in the commit. + +## Development Internal Settings + +Note: These settings are only available when using the [Development Version](https://docs.abapgit.org/guide-development-version.html) of abapGit. + +![](img/settings-global-3.png) + +### Enable Critical Unit Tests +The developer version of abapGit might contain unit tests that impact system settings (like creating/deleting test objects). By default, these test are disabled. + +### Enable Experimental Features +There might be features that are not completely implemented or tested yet but already included in the developer version. By default, these features are disabled. + diff --git a/docs/guide-settings-personal.md b/docs/guide-settings-personal.md new file mode 100644 index 000000000..11b2c8a89 --- /dev/null +++ b/docs/guide-settings-personal.md @@ -0,0 +1,50 @@ +--- +title: Personal settings +category: setup +order: 08 +--- + +Personal settings in abapGit are valid only for the logged on user. You can maintain the +settings from the repository list or repository view by selecting "Settings > Personal". + +![](img/settings-personal-0.png) + +Note: Personal settings are relevant all of your repositories. + +![](img/settings-personal-1.png) +![](img/settings-personal-2.png) + +## Startup + +If you turn on "Show Last Opened Repository", abapGit will jump directly to the repository that you worked on last. + +## User Interface + +You can switch the theme for abapGit between several choices: Default, Dark, and Belize. Alternatively, you can select "Synced with SAP GUI" to use the same theme +you are using for SAP GUI (availability depends on SAP GUI release). + +The size of icons can be changed using "icon scaling". + +"List Size" defines the maximum number of items shown in a list. If there are more items, then abapGit start paging. + +## Interaction + +Typically, when objects are changed, the system will display a popup to confirm the activation of objects. This gives the change to address syntax errors, for example. +If you want objects to be activated automatically, select "Activate Objects Without Popup". If there are syntax errors, abapGit will indicate this with an icon next to +the objects in the repository view. + +If you are using ABAP Development Tools (ADT) in Eclipse, we recommend to turn on "Enable Jump to ABAP Development Tools". Clicking on objects names in abapGit will then +open the object in ADT (if available). + +"Enable Vimium-like Link Hints" and "Key to Activate Link Hints" provide a feature similarly to the [Vimium browser](https://vimium.github.io/). After pressing the +activation key (default "f"), abapGit will uses a clever highlighting method to navigate using links. + +![](img/settings-personal-3.png) + +## System Resources + +By default and if sufficient system resources are available, abapGit will use parallel processing to serialize objects of a repository. You can disable parallel processing +with this setting. Note: Use this setting in case you need to debug a serializer class. + + + diff --git a/docs/img/settings-global-0.png b/docs/img/settings-global-0.png new file mode 100644 index 000000000..dafbc96c4 Binary files /dev/null and b/docs/img/settings-global-0.png differ diff --git a/docs/img/settings-global-1.png b/docs/img/settings-global-1.png new file mode 100644 index 000000000..206a8269f Binary files /dev/null and b/docs/img/settings-global-1.png differ diff --git a/docs/img/settings-global-2.png b/docs/img/settings-global-2.png new file mode 100644 index 000000000..9e0da41ea Binary files /dev/null and b/docs/img/settings-global-2.png differ diff --git a/docs/img/settings-global-3.png b/docs/img/settings-global-3.png new file mode 100644 index 000000000..3aa0ba1e3 Binary files /dev/null and b/docs/img/settings-global-3.png differ diff --git a/docs/img/settings-personal-0.png b/docs/img/settings-personal-0.png new file mode 100644 index 000000000..7d9a97656 Binary files /dev/null and b/docs/img/settings-personal-0.png differ diff --git a/docs/img/settings-personal-1.png b/docs/img/settings-personal-1.png new file mode 100644 index 000000000..8b51351d7 Binary files /dev/null and b/docs/img/settings-personal-1.png differ diff --git a/docs/img/settings-personal-2.png b/docs/img/settings-personal-2.png new file mode 100644 index 000000000..f256fae3d Binary files /dev/null and b/docs/img/settings-personal-2.png differ diff --git a/docs/settings-personal-3.png b/docs/settings-personal-3.png new file mode 100644 index 000000000..1d49daa67 Binary files /dev/null and b/docs/settings-personal-3.png differ