Skip to content

Commit d70ba7b

Browse files
committed
documentation update
1 parent 050b1ef commit d70ba7b

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

doc/CONSTANTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ PEB is created to work from any directory without installation and all file path
2121
* **Application directory:**
2222
All Perl application files must be located within this folder.
2323
The application directory path must be: ``{PEB_executable_directory}/resources/app``
24+
PEB application directory is labeled as ``{PEB_app_directory}`` within this documentation.
2425
By default the working directory of all Perl scripts run by PEB is the application directory.
2526

2627
PEB application directory pathname is compatible with the [Electron](http://electron.atom.io/) framework.

doc/SETTINGS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Three methods to start a local Perl script:
6060
peb.startScript('perl_script.settings');
6161
```
6262

63-
* **script**
63+
* **scriptRelativePath**
6464
``String`` for the relative path of a Perl script run by PEB
65-
The script relative path is converted to a full path using the PEB application directory as a root folder.
65+
The script relative path is converted to a full path using the ``{PEB_app_directory}`` as a root folder.
6666
PEB does not check filename extensions or shebang lines of Perl scripts.
6767
Scripts without filename extensions can also be used.
6868
*This object property is mandatory.*
@@ -96,14 +96,14 @@ peb.startScript('perl_script.settings');
9696
```
9797

9898
* **scriptExitCommand**
99-
``String`` containing the command used to gracefully shut down an interactive Perl script when PEB is closed
99+
``String`` containing the command used to gracefully shut down [an interactive Perl script](#interactive_perl_scripts) when PEB is closed
100100
Upon receiving it, an interactive script must start its shutdown procedure.
101101

102102
* **scriptExitConfirmation**
103-
``String`` used to signal PEB that an interactive Perl script completed its shutdown
103+
``String`` used to signal PEB that [an interactive Perl script](#interactive_perl_scripts) completed its shutdown
104104
All interactive scripts must exit in 3 seconds after ``scriptExitCommand`` is given or any unresponsive scripts will be killed and PEB will exit.
105105

106-
Perl scripts running for a long time should have ``$|=1;`` among their first lines to disable the built-in buffering of the Perl interpreter. Some builds of Perl may not give any output until the script is finished when buffering is enabled.
106+
Perl scripts running for a long time should have ``$|=1;`` among their first lines to disable the built-in buffering of the Perl interpreter. Some builds of Perl may not give any output until the script has ended when buffering is enabled.
107107

108108
## Interactive Perl Scripts
109109
Each PEB interactive Perl script must have its own event loop waiting constantly for new data on STDIN for a bidirectional connection with PEB. Many interactive scripts can be started simultaneously in one browser window. One script may be started in many instances, provided that it has a JavaScript settings object with a unique name. Interactive scripts must also have the ``scriptExitCommand`` object property. The ``scriptExitConfirmation`` object property is not mandatory, but highly recommended for a quick shutdown of PEB.

0 commit comments

Comments
 (0)