adjust documentation, add todo list

This commit is contained in:
Daniel Seifert 2022-08-05 09:25:49 +02:00
parent ef66dd22cb
commit 8cba6428ed
Signed by: DanielS
GPG Key ID: 8A7C4C6ED1915C6F
6 changed files with 39 additions and 13 deletions

View File

@ -6,6 +6,7 @@
* *
* https://www.d3data.de * https://www.d3data.de
* *
* @copyright (c) 2016 Dmitry Kosenkov
* @copyright (C) D3 Data Development (Inh. Thomas Dartsch) * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
* @author D3 Data Development - Daniel Seifert <info@shopmodule.com> * @author D3 Data Development - Daniel Seifert <info@shopmodule.com>
* @link https://www.oxidmodule.com * @link https://www.oxidmodule.com

View File

@ -4,7 +4,19 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased](https://git.d3data.de/D3Public/DebugBar/compare/1.0.0.0...rel_1.x) ## [Unreleased](https://git.d3data.de/D3Public/DebugBar/compare/1.1.0.0...rel_1.x)
## [1.1.0.0](https://git.d3data.de/D3Public/DebugBar/compare/1.0.0.0...1.1.0.0) - 2022-08-05
### Added
- shop edition and version information directly in the bar
- basic shop informations (edition, version, theme informations) in the shop tab
### Changed
- reorder tabs
- adjust tab icons for small viewports
### removed
- useless exceptions tab
## [1.0.0.0](https://git.d3data.de/D3Public/DebugBar/releases/tag/1.0.0.0) - 2022-07-30 ## [1.0.0.0](https://git.d3data.de/D3Public/DebugBar/releases/tag/1.0.0.0) - 2022-07-30
### Added ### Added

View File

@ -10,10 +10,11 @@ The debug bar enables the display of relevant debug information in the shop fron
## Table of content ## Table of content
- [Installation](#installation) - [Installation](#installation)
- [How to use](#how-to-use)
- [Changelog](#changelog) - [Changelog](#changelog)
- [Contributing](#contributing) - [Contributing](#contributing)
- [License](#license) - [License](#license)
- [Further licences and terms of use](#further-licences-and-terms-of-use) - [Further licenses and terms of use](#further-licenses-and-terms-of-use)
## Installation ## Installation
@ -39,7 +40,6 @@ Please enter the following section in the `composer.json` of your project:
Open a command line and navigate to the root directory of the shop (parent directory of source and vendor). Execute the following command. Adapt the path details to your installation environment. Open a command line and navigate to the root directory of the shop (parent directory of source and vendor). Execute the following command. Adapt the path details to your installation environment.
```bash ```bash
php composer require d3/oxid-debugbar:^1.0 php composer require d3/oxid-debugbar:^1.0
``` ```
@ -50,21 +50,25 @@ 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.__
The DebugBar displays the following tabs: The DebugBar displays the following tabs:
- Messages - Messages
can contain individual debug output. Messages can be set within the PHP code with `debugVar($message)` and corresponds to the OXID function `dumpVar(...)` can contain individual debug output. The messages can be set within the PHP code with `debugVar($message)` and corresponds to the OXID function `dumpVar(...)`
- Request - Request
shows all information from GET and POST requests, as well as session, cookie and server variables shows all information from GET and POST requests, as well as session, cookie and server variables
- Timeline - Timeline
displays all areas defined with `startProfile` and `stopProfile` with single and summed execution time as well as a waterfall diagram displays all areas defined with `startProfile` and `stopProfile` with single and summed execution time as well as a waterfall diagram
- Shop
shows basic shop information (edition, versions, theme information)
- Configuration
provides all configuration settings of the shop from database and config files
- Smarty
lists all variables of the template engine that are available on the current shop page
- Monolog - Monolog
lists all log messages passed to the Monolog Logger lists all log messages passed to the Monolog Logger
- Database - Database
shows all database queries necessary to generate the current page shows all database queries necessary to generate the current page
- Smarty
lists all Smarty variables available on the current shop page
- Configuration
Provides all configuration settings of the shop (from database and file).
## Changelog ## Changelog

View File

@ -10,6 +10,7 @@ Die Debug Bar ermöglicht die Darstellung relevanter Debuginformationen im Shopf
## Inhaltsverzeichnis ## Inhaltsverzeichnis
- [Installation](#installation) - [Installation](#installation)
- [Verwendung](#verwendung)
- [Changelog](#changelog) - [Changelog](#changelog)
- [Beitragen](#beitragen) - [Beitragen](#beitragen)
- [Lizenz](#lizenz) - [Lizenz](#lizenz)
@ -39,7 +40,6 @@ Bitte tragen Sie den folgenden Abschnitt in die `composer.json` Ihres Projektes
Öffnen Sie eine Kommandozeile und navigieren Sie zum Stammverzeichnis des Shops (Elternverzeichnis von source und vendor). Führen Sie den folgenden Befehl aus. Passen Sie die Pfadangaben an Ihre Installationsumgebung an. Öffnen Sie eine Kommandozeile und navigieren Sie zum Stammverzeichnis des Shops (Elternverzeichnis von source und vendor). Führen Sie den folgenden Befehl aus. Passen Sie die Pfadangaben an Ihre Installationsumgebung an.
```bash ```bash
php composer require d3/oxid-debugbar:^1.0 php composer require d3/oxid-debugbar:^1.0
``` ```
@ -50,6 +50,8 @@ Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
## Verwendung ## Verwendung
__Bitte beachten Sie, dass die DebugBar sicherheitsrelevante Informationen enthält. Diese sollte daher unter keinen Umständen in einer frei zugänglichen Installation aktiviert sein.__
Die DebugBar stellt folgende Tabs dar: Die DebugBar stellt folgende Tabs dar:
- Messages - Messages
kann individuelle Debugausgaben enthalten. Die Nachrichten können innerhalb des PHP-Codes mit `debugVar($message)` gesetzt werden und entspricht der OXID-Funktion `dumpVar(...)`. kann individuelle Debugausgaben enthalten. Die Nachrichten können innerhalb des PHP-Codes mit `debugVar($message)` gesetzt werden und entspricht der OXID-Funktion `dumpVar(...)`.
@ -57,14 +59,16 @@ Die DebugBar stellt folgende Tabs dar:
zeigt alle Angaben aus GET- und POST-Requests, sowie Session-, Cookie- und Servervariablen zeigt alle Angaben aus GET- und POST-Requests, sowie Session-, Cookie- und Servervariablen
- Timeline - Timeline
stellt alle mit `startProfile` und `stopProfile` definierten Bereiche mit einzelner und summierter Ausführungszeit sowie als Wasserfalldiagramm dar stellt alle mit `startProfile` und `stopProfile` definierten Bereiche mit einzelner und summierter Ausführungszeit sowie als Wasserfalldiagramm dar
- Shop
zeigt grundlegende Shopinformationen (Edition, Versionen, Themeinformationen)
- Configuration
stellt alle Konfigurationseinstellungen des Shops aus Datenbank und config-Dateien zur Verfügung
- Smarty
listet alle Variablen der Template-Engine, die auf der aktuellen Shopseite zur Verfügung stehen
- Monolog - Monolog
listet alle an den Monolog Logger übergebenen Lognachrichten listet alle an den Monolog Logger übergebenen Lognachrichten
- Database - Database
zeigt alle zur Generierung der aktuellen Seite nötigen Datenbankabfragen zeigt alle zur Generierung der aktuellen Seite nötigen Datenbankabfragen
- Smarty
listet alle Smarty-Variablen, die auf der aktuellen Shopseite zur Verfügung stehen
- Configuration
stellt alle Konfigurationseinstellungen des Shops aus Datenbank und Dateien zur Verfügung
## Changelog ## Changelog

5
ToDo.md Normal file
View File

@ -0,0 +1,5 @@
# ToDo
- clear tmp button
- phpinfo() overview
- automatic switch between Smarty and Twig

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 71 KiB