Skip to content

Commit b4c9385

Browse files
committed
documentation update
1 parent c877649 commit b4c9385

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ Perl Executing Browser (PEB) is an HTML GUI for [Perl 5](https://www.perl.org/)
6767
* PEB is useful for both single-page or multi-page applications.
6868
* [Single file or multiple files, new filename, existing or new directory can be selected by user](#special-urls-for-users).
6969
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](#special-urls-for-users).
70+
* [Browser functions are accessible from special URLs](#browser-functions).
7171
* [Any icon can be displayed on windows and message boxes](#icon).
7272
* [Optional context menu translation using JavaScript ](#custom-or-translated-context-menu-labels).
7373
* [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](#checking-for-unsaved-user-input-before-closing-a-window).
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).
7575
* Cross-site scripting is disabled for all web and local pages.
7676

7777
**Development goodies:**
@@ -231,8 +231,8 @@ They have two functions:
231231
}
232232
```
233233

234-
* **Checking for unsaved user input before closing a window:**
235-
<a name="checking-for-unsaved-user-input-before-closing-a-window"></a>
234+
* **Warning for unsaved user input before closing a window:**
235+
<a name="warning-for-unsaved-user-input-before-closing-a-window"></a>
236236
PEB users can enter a lot of data in local HTML forms and it is often important to safeguard this information from accidental deletion if PEB window is closed without first saving the user data. When user starts closing a PEB window, the browser checks for any unsaved data in all forms of the HTML page that is going to be closed. This is achieved using internal JavaScript code compiled in the resources of the browser binary.
237237

238238
If any unsaved data is detected, PEB tries to determine what kind of JavaScript routine has to be displayed to warn the user and ask for final confirmation. Two types of JavaScript warning routines are possible in this scenario: **synchronous** and **asynchronous**.
@@ -352,6 +352,7 @@ They have two functions:
352352
Please note that if you choose to create a new directory, it will be created immediately by PEB.
353353
It will be already existing when passed to a local Perl script.
354354

355+
<a name="browser-functions"></a>
355356
* **Print:** ```http://local-pseudodomain/print.function?action=print```
356357
Printing is not immediately performed, but a native printer selection dialog is displayed first.
357358
If no printer is configured, no dialog is displayed and no action is taken.
@@ -363,7 +364,7 @@ They have two functions:
363364
* **About Qt dialog box:** ```http://local-pseudodomain/about.function?type=qt```
364365

365366
* **Close current window:** ```http://local-pseudodomain/close-window.function```
366-
Please note that the window from where this URL was called will be closed immediately without any check for unsaved user data in HTML forms. Window-closing URL was implememented to make possible asynchronous window close confirmation JavaScript routines - see section *Settings*, paragraph [Checking for unsaved user input before closing a window](#checking-for-unsaved-user-input-before-closing-a-window).
367+
Please note that the window from where this URL was called will be closed immediately without any check for unsaved user data in HTML forms. Window-closing URL was implememented to enable asynchronous JavaScript routines for window closing confirmation - see section *Settings*, paragraph [Warning for unsaved user input before closing a window](#warning-for-unsaved-user-input-before-closing-a-window).
367368

368369
## HTML Interface for the Perl Debugger
369370
Any Perl script can be selected for debugging in an embedded HTML user interface. The debugger output is displayed together with the syntax highlighted source code of the debugged script and its modules. Syntax highlighting is achieved using [Syntax::Highlight::Engine::Kate](https://metacpan.org/release/Syntax-Highlight-Engine-Kate) CPAN module by Hans Jeuken and Gábor Szabó. Interaction with the built-in Perl debugger is an idea proposed by Valcho Nedelchev and provoked by the scarcity of graphical frontends for the Perl debugger.
@@ -378,9 +379,9 @@ They have two functions:
378379

379380
The following special URLs for interaction with the Perl debugger are implemented:
380381

381-
* **Select file:** ```http://local-pseudodomain/perl-debugger.function?action=select-file```
382+
* **Select debugged file:** ```http://local-pseudodomain/perl-debugger.function?action=select-file```
382383
The selected file will be loaded in the Perl debugger, but no command will be automatically issued. Any command can be given later by buttons or by typing it in an input box inside the HTML user interface of the debugger.
383-
* **Send command:** ```http://local-pseudodomain/perl-debugger.function?command=M```
384+
* **Send debugger command:** ```http://local-pseudodomain/perl-debugger.function?command=M```
384385
* **Combined Perl Debugger URL:**
385386
Selecting file to debug and sending command to the Perl debugger can be combined in a single URL.
386387
Example: ```http://local-pseudodomain/perl-debugger.function?action=select-file&command=M```

0 commit comments

Comments
 (0)