update documentation
This commit is contained in:
bovenliggende
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.en.md)
|
||||
|
||||
@ -5,7 +9,7 @@
|
||||
|
||||
The debug bar enables the display of relevant debug information in the shop frontend.
|
||||
|
||||

|
||||

|
||||
|
||||
## Table of content
|
||||
|
||||
@ -32,7 +36,7 @@ Please enter the following section in the `composer.json` of your project:
|
||||
"enable-patching": "true",
|
||||
"patches": {
|
||||
"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.
|
||||
|
||||
```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.
|
||||
|
||||
Activate the module in Shopadmin under "Extensions -> Modules".
|
||||
|
||||
## 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:
|
||||
- Messages
|
||||
@ -65,8 +75,10 @@ The DebugBar displays the following tabs:
|
||||
shows basic shop information (edition, versions, theme information)
|
||||
- Configuration
|
||||
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
|
||||
- Twig
|
||||
shows Twig internal profiling (only when using the Twig Template Engine)
|
||||
- Monolog
|
||||
lists all log messages passed to the Monolog Logger
|
||||
- Database
|
||||
|
18
README.md
18
README.md
@ -1,3 +1,7 @@
|
||||

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

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

|
||||

|
||||
|
||||
## Inhaltsverzeichnis
|
||||
|
||||
@ -32,7 +36,7 @@ Bitte tragen Sie den folgenden Abschnitt in die `composer.json` Ihres Projektes
|
||||
"enable-patching": "true",
|
||||
"patches": {
|
||||
"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.
|
||||
|
||||
```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.
|
||||
|
||||
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)
|
||||
- Configuration
|
||||
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
|
||||
- Twig
|
||||
zeigt Twig internes Profiling (nur bei Verwendung der Twig Template Engine)
|
||||
- Monolog
|
||||
listet alle an den Monolog Logger übergebenen Lognachrichten
|
||||
- Database
|
||||
|
BIN
screenshot.jpg
BIN
screenshot.jpg
Binair bestand niet weergegeven.
Voor Breedte: | Hoogte: | Grootte: 71 KiB |
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binair bestand niet weergegeven.
Na Breedte: | Hoogte: | Grootte: 49 KiB |
Laden…
x
Verwijs in nieuw issue
Block a user