update documentation
This commit is contained in:
parent
843c49e137
commit
b02708f5ae
20
README.en.md
20
README.en.md
@ -1,3 +1,7 @@
|
|||||||
|

|
||||||
|
[](https://packagist.org/packages/d3/oxid-debugbar)
|
||||||
|

|
||||||
|
|
||||||
[](README.md)
|
[](README.md)
|
||||||
[](README.en.md)
|
[](README.en.md)
|
||||||
|
|
||||||
@ -5,7 +9,7 @@
|
|||||||
|
|
||||||
The debug bar enables the display of relevant debug information in the shop frontend.
|
The debug bar enables the display of relevant debug information in the shop frontend.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Table of content
|
## Table of content
|
||||||
|
|
||||||
@ -32,7 +36,7 @@ Please enter the following section in the `composer.json` of your project:
|
|||||||
"enable-patching": "true",
|
"enable-patching": "true",
|
||||||
"patches": {
|
"patches": {
|
||||||
"oxid-esales/oxideshop-ce": {
|
"oxid-esales/oxideshop-ce": {
|
||||||
"Add overridable functions for advanced profiling in Debug Bar": "https://git.d3data.de/D3Public/DebugBar/raw/branch/patches/overridablefunctions.patch"
|
"Add overridable functions for advanced profiling in Debug Bar": "https://git.d3data.de/D3Public/DebugBar/raw/branch/patches/overridablefunctions_2.0.patch"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -46,13 +50,19 @@ php composer require d3/oxid-debugbar:^2.0
|
|||||||
|
|
||||||
If necessary, please confirm that you allow `composer-symlinker` and `composer-patches` to execute code.
|
If necessary, please confirm that you allow `composer-symlinker` and `composer-patches` to execute code.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm -rf vendor/oxid-esales/oxideshop-ce
|
||||||
|
php composer install
|
||||||
|
php composer update --lock
|
||||||
|
```
|
||||||
|
|
||||||
Have the files of the package `oxid-esales/oxideshop-ce` overwritten.
|
Have the files of the package `oxid-esales/oxideshop-ce` overwritten.
|
||||||
|
|
||||||
Activate the module in Shopadmin under "Extensions -> Modules".
|
Activate the module in Shopadmin under "Extensions -> Modules".
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
__Please note that the DebugBar contains security-relevant information. It should therefore not be activated under any circumstances in a freely accessible installation.__
|
__Please note that the DebugBar contains security-relevant information. It should therefore never be activated in a public installation__.
|
||||||
|
|
||||||
The DebugBar displays the following tabs:
|
The DebugBar displays the following tabs:
|
||||||
- Messages
|
- Messages
|
||||||
@ -65,8 +75,10 @@ The DebugBar displays the following tabs:
|
|||||||
shows basic shop information (edition, versions, theme information)
|
shows basic shop information (edition, versions, theme information)
|
||||||
- Configuration
|
- Configuration
|
||||||
provides all configuration settings of the shop from database and config files
|
provides all configuration settings of the shop from database and config files
|
||||||
- Smarty
|
- Template variables
|
||||||
lists all variables of the template engine that are available on the current shop page
|
lists all variables of the template engine that are available on the current shop page
|
||||||
|
- Twig
|
||||||
|
shows Twig internal profiling (only when using the Twig Template Engine)
|
||||||
- Monolog
|
- Monolog
|
||||||
lists all log messages passed to the Monolog Logger
|
lists all log messages passed to the Monolog Logger
|
||||||
- Database
|
- Database
|
||||||
|
18
README.md
18
README.md
@ -1,3 +1,7 @@
|
|||||||
|

|
||||||
|
[](https://packagist.org/packages/d3/oxid-debugbar)
|
||||||
|

|
||||||
|
|
||||||
[](README.md)
|
[](README.md)
|
||||||
[](README.en.md)
|
[](README.en.md)
|
||||||
|
|
||||||
@ -5,7 +9,7 @@
|
|||||||
|
|
||||||
Die Debug Bar ermöglicht die Darstellung relevanter Debuginformationen im Shopfrontend.
|
Die Debug Bar ermöglicht die Darstellung relevanter Debuginformationen im Shopfrontend.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Inhaltsverzeichnis
|
## Inhaltsverzeichnis
|
||||||
|
|
||||||
@ -32,7 +36,7 @@ Bitte tragen Sie den folgenden Abschnitt in die `composer.json` Ihres Projektes
|
|||||||
"enable-patching": "true",
|
"enable-patching": "true",
|
||||||
"patches": {
|
"patches": {
|
||||||
"oxid-esales/oxideshop-ce": {
|
"oxid-esales/oxideshop-ce": {
|
||||||
"Add overridable functions for advanced profiling in Debug Bar": "https://git.d3data.de/D3Public/DebugBar/raw/branch/patches/overridablefunctions.patch"
|
"Add overridable functions for advanced profiling in Debug Bar": "https://git.d3data.de/D3Public/DebugBar/raw/branch/patches/overridablefunctions_2.0.patch"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -46,6 +50,12 @@ php composer require d3/oxid-debugbar:^2.0
|
|||||||
|
|
||||||
Sofern nötig, bestätigen Sie bitte, dass Sie `composer-symlinker` und `composer-patches` erlauben, Code auszuführen.
|
Sofern nötig, bestätigen Sie bitte, dass Sie `composer-symlinker` und `composer-patches` erlauben, Code auszuführen.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm -rf vendor/oxid-esales/oxideshop-ce
|
||||||
|
php composer install
|
||||||
|
php composer update --lock
|
||||||
|
```
|
||||||
|
|
||||||
Lassen Sie die Dateien des Paketes `oxid-esales/oxideshop-ce` überschreiben.
|
Lassen Sie die Dateien des Paketes `oxid-esales/oxideshop-ce` überschreiben.
|
||||||
|
|
||||||
Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
|
Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
|
||||||
@ -65,8 +75,10 @@ Die DebugBar stellt folgende Tabs dar:
|
|||||||
zeigt grundlegende Shopinformationen (Edition, Versionen, Themeinformationen)
|
zeigt grundlegende Shopinformationen (Edition, Versionen, Themeinformationen)
|
||||||
- Configuration
|
- Configuration
|
||||||
stellt alle Konfigurationseinstellungen des Shops aus Datenbank und config-Dateien zur Verfügung
|
stellt alle Konfigurationseinstellungen des Shops aus Datenbank und config-Dateien zur Verfügung
|
||||||
- Smarty
|
- Template Variablen
|
||||||
listet alle Variablen der Template-Engine, die auf der aktuellen Shopseite zur Verfügung stehen
|
listet alle Variablen der Template-Engine, die auf der aktuellen Shopseite zur Verfügung stehen
|
||||||
|
- Twig
|
||||||
|
zeigt Twig internes Profiling (nur bei Verwendung der Twig Template Engine)
|
||||||
- Monolog
|
- Monolog
|
||||||
listet alle an den Monolog Logger übergebenen Lognachrichten
|
listet alle an den Monolog Logger übergebenen Lognachrichten
|
||||||
- Database
|
- Database
|
||||||
|
BIN
screenshot.jpg
BIN
screenshot.jpg
Binary file not shown.
Before Width: | Height: | Size: 71 KiB |
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 49 KiB |
Loading…
x
Reference in New Issue
Block a user