Differences

This shows you the differences between two versions of the page.

--- doc:webui_guide [2015/12/28 09:59] – admin
+++ doc:webui_guide [2017/02/04 18:28] (current) – [The Communication Handshake] admin
@@ Line 26: / Line 26: @@
 ===== Structure of a script package =====
-The invidual script application can exist in three different versions:
+The invidual script application can exist in for different versions:
-  - as well known compiled lua file with the extension .lbc
+  - as well known compiled lua file with the extension .lbc or .pgp
   - as directory with the suffix .epa
   - as package file, also with the suffix .epa
-==== the .lbc file ====
+==== the .lbc and .pgp file ====
-when a lbc file is choosen, the browser loads the default file, referenced as ''/theme/start.html'' (where ''/theme'' is mapped, as you remember), so the apperance is driven by the theme. This html file needs to have the functionality to handle the openPage, addElement and PageDone commands coming from the scripts. To see how this works, please have a look into the samples supplied.
+when a lbc or .pgp file is choosen, the browser loads the default file, referenced as ''/theme/start.html'' (where ''/theme'' is mapped, as you remember), so the apperance is driven by the theme. This html file needs to have the functionality to handle the openPage, addElement and PageDone commands coming from the scripts. To see how this works, please have a look into the samples supplied.
 ==== the .epa directory or file ====
@@ Line 50: / Line 50: @@
    { "script": "helloworld.lbc" }
-The parameters used by OOBD are actual
+The parameters used by OOBD to start a script and to send back a adjacend web page are actual
 ^  Parameter  ^  Meaning  ^  Default  ^
@@ Line 56: / Line 56: @@
 |  startpage      | HTML page, which is loaded at start  |  ''/theme/default/startpage.html''  |
-As this manifest file can also be loaded as ''/manifest'' by the web application, it's also a good place to store the application specific settings into it.
+where the ''script'' parameter is optional, so the startpage can be used to send another menu first which e.g. links to several scripts on one package
+As this manifest file can also be loaded as ''manifest'' by the web application, it's also a good place to store the application specific settings into it.
+==== "PassThrough" and "SetRoot" Behaviour ====
+Whenever the root page ("/") is called, this acts like a reset to OOBD. All available packages are readable, so when using a link like /package-name/internal/path/to/file, the file inside the page can be accessed by the URL. This is helpful to store data inside the package, which can be used in the main page to give further information about that package, like an icon, a screenshot or other data. This capability to look into a package is the so called passthrough mode.
+This changes as soon as a packet is adressed not by it's filename, but by his id (which is, in fact, the base64 encoded format of the filename). When this happens, that package becomes the new virtual root directory of the webserver until the pure root page ("/") is addressed.
+----
 ===== The Communication Handshake =====
@@ Line 71: / Line 83: @@
-<graphviz dot right 800x400>
+<graphviz dot right>
 digraph G {
 rankdir=TB;ratio = fill;
@@ Line 138: / Line 150: @@
 }
 </graphviz>
+----
@@ Line 171: / Line 183: @@
             +---yoursecretcontent
 </code>
+----
 ===== The meaning of the folder structure =====
@@ Line 201: / Line 213: @@
 in the ''secret'' subfolder you can stored what you would like to have encrypted by the normal OOBD pgp encryption process