From 1d8287ce1fbc76b088a8e50daa8facd8695b0611 Mon Sep 17 00:00:00 2001 From: geekwright Date: Mon, 15 Feb 2021 15:51:21 -0600 Subject: [PATCH] Update README to reflect changes and add detail --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e3103d..a51c3f7 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ xWhoops25 A XOOPS 2.5.11+ extension that brings [whoops](https://github.com/filp/whoops) error display to XOOPS. It is especially handy for diagnosing failures brought on by unhandled errors, so you can more properly handle them. -Administrators will always have access to the extended diagnotics, and other groups can also be granted access. +Administrators control access to the extended diagnotics, and any group can be granted or denied access. Outside of the control panel, there is no user interface. It will "just work" when needed. @@ -14,3 +14,12 @@ To add *xwhoops25* to your XoopsCore25, follow these steps - open a terminal into that folder and execute ```composer install``` - install the xwhoops25 module in the system administration module page +- grant access by selecting groups in the permissions section + +The Whoops display contains 4 main sections. +- *top left* is the error that was encountered +- *lower left* shows the stack frames, the trace of path of the processing that resulted in the error. +- *top right* shows the code for the currently selected stack frame item. Select a new stack frame to see the related code. +- *lower right* shows environment information such as request parameters, session information, etc. + +Note: if the XoopsLogger is enabled, MySQL queries will be shown in the Environment & details section. \ No newline at end of file