OOBD

User Tools

Site Tools

Trace:
doc:webui_guide

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
doc:webui_guide [2015/12/28 10:01] – admindoc:webui_guide [2017/02/04 18:28] (current) – [The Communication Handshake] admin
Line 50: Line 50:
    { "script": "helloworld.lbc" }    { "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  ^ ^  Parameter  ^  Meaning  ^  Default  ^
Line 56: Line 56:
 |  startpage      | HTML page, which is loaded at start  |  ''/theme/default/startpage.html''  | |  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 ===== ===== The Communication Handshake =====
Line 138: Line 150:
 } }
 </graphviz> </graphviz>
 +----
  
  
Line 171: Line 183:
             +---yoursecretcontent             +---yoursecretcontent
 </code> </code>
 +----
 ===== The meaning of the folder structure ===== ===== The meaning of the folder structure =====
  
doc/webui_guide.1451293311.txt.gz · Last modified: 2015/12/28 10:01 by admin