Skip to content

Commit b175c79

Browse files
committed
documentation update
1 parent b4c9385 commit b175c79

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,26 @@ Perl Executing Browser (PEB) is an HTML GUI for [Perl 5](https://www.perl.org/)
5959

6060
## Features
6161
**Usability:**
62-
* [Perl 5 scripts can be fed from HTML forms using direct GET and POST or AJAX requests to a built-in pseudo-domain](#feeding-from-forms).
63-
* [Output from long running Perl 5 scripts can be seamlessly inserted into the HTML DOM of the calling local page](#data-only-scripts).
64-
* [Linux superuser Perl scripts can be started](#calling-linux-superuser-perl-scripts).
65-
* [Any version of Perl 5 can be used](#runtime-requirements).
66-
* [PEB can be started from any folder](#settings).
62+
63+
* [Output from long running Perl 5 scripts can be seamlessly inserted into the HTML DOM of the calling local page.](#data-only-scripts)
64+
* [Perl 5 scripts can be fed from HTML forms using direct GET and POST or AJAX requests to a built-in pseudo-domain.](#feeding-from-forms)
65+
* [Linux superuser Perl scripts can be started.](#calling-linux-superuser-perl-scripts)
66+
* [Any version of Perl 5 can be used.](#runtime-requirements)
67+
* [PEB can be started from any folder.](#settings)
6768
* PEB is useful for both single-page or multi-page applications.
68-
* [Single file or multiple files, new filename, existing or new directory can be selected by user](#special-urls-for-users).
69+
* [Single file or multiple files, new filename, existing or new directory can be selected by user.](#special-urls-for-users)
6970
Their full paths can be displayed in the calling local page and they can be supplied to local Perl scripts.
70-
* [Browser functions are accessible from special URLs](#browser-functions).
71-
* [Any icon can be displayed on windows and message boxes](#icon).
72-
* [Optional context menu translation using JavaScript ](#custom-or-translated-context-menu-labels).
73-
* [Optional translation of the JavaScript *Alert*, *Confirm* and *Prompt* dialog boxes using JavaScript](#custom-or-translated-labels-for-javascript-dialog-boxes).
74-
* [Optional warning for unsaved data in HTML forms before closing a window to prevent accidental data loss](#warning-for-unsaved-user-input-before-closing-a-window).
71+
* [Browser functions are accessible from special URLs.](#browser-functions)
72+
* [Any icon can be displayed on windows and message boxes.](#icon)
73+
* [Optional context menu translation using JavaScript ](#custom-or-translated-context-menu-labels)
74+
* [Optional translation of the JavaScript *Alert*, *Confirm* and *Prompt* dialog boxes using JavaScript](#custom-or-translated-labels-for-javascript-dialog-boxes)
75+
* [Optional warning for unsaved data in HTML forms before closing a window to prevent accidental data loss](#warning-for-unsaved-user-input-before-closing-a-window)
7576
* Cross-site scripting is disabled for all web and local pages.
7677

7778
**Development goodies:**
78-
* PEB can interact with the Perl 5 debugger in graphical mode - see section [HTML Interface for the Perl Debugger](#html-interface-for-the-perl-debugger)
79+
* [PEB can interact with the Perl 5 debugger in graphical mode.](#html-interface-for-the-perl-debugger)
7980
* ```QWebInspector``` window can be invoked using ```Ctrl+I``` keyboard shortcut.
80-
* Extensive optional logging of all browser actions.
81+
* [Optional extensive logging of all browser actions.](#log-files)
8182

8283
## Compile-time Requirements
8384
GCC compiler and Qt 5.1 - Qt 5.5 headers.
@@ -183,7 +184,8 @@ PEB is designed to run from any directory without setting anything beforehand an
183184
A PEB-based application can have its own icon and it must be located at ```{PEB_binary_directory}/resources/app/app.png```. If this file is found during application startup, it will be used as the icon of all windows and dialog boxes. If this file is not found, the default icon embedded into the resources of the browser binary will be used.
184185
* **Trusted domains:**
185186
If PEB is able to read ```{PEB_binary_directory}/resources/app/trusted-domains.json```, all domains listed in this file are considered trusted. Only the local pseudo-domain ```http://local-pseudodomain/``` is trusted if ```trusted-domains.json``` is missing. This setting should be used with care - see section [Security](#security).
186-
* **Log files:**
187+
* **Log files:**
188+
<a name="log-files"></a>
187189
If log files are needed for debugging of PEB or a PEB-based application, they can easily be turned on by manually creating ```{PEB_binary_directory}/logs```. If this directory is found during application startup, the browser assumes that logging is required and a separate log file is created for every browser session following the naming convention: ```{application_name}-started-at-{four_digit_year}-{month}-{day}--{hour}-{minute}-{second}.log```. PEB will not create ```{PEB_binary_directory}/logs``` on its own and if this directory is missing, no logs will be written, which is the default behavior. Please note, that every requested link is logged and log files can grow rapidly. If disc space is an issue, writing log files can be turned off by simply removing or renaming ```{PEB_binary_directory}/logs```.
188190

189191
**Settings based on JavaScript code:**

0 commit comments

Comments
 (0)