doc:webui_guide
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
doc:webui_guide [2015/12/27 20:51] – [OOBD Web UI Design Rules] admin | doc:webui_guide [2015/12/27 23:01] – admin | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== OOBD Web UI Design | + | ====== OOBD Web UI Design |
+ | |||
+ | This guideline describes, what you need to know to create a package containing lua scipts and webpages ready to run in OOBD | ||
+ | |||
+ | ===== The Basics ===== | ||
+ | |||
+ | The webUI of OOBD consists of three elements: | ||
+ | * A HTTP server | ||
+ | * A directory, where the scipts are stored in | ||
+ | * An optional, but highly recommended directory, which serves as common pool for all these javascript libraries, which are likely to be used for the script webpages. | ||
+ | |||
+ | |||
+ | When a browser connects to the root URL (simply means "/" | ||
+ | |||
+ | ==== The Themes, the Libs and the Default ==== | ||
+ | In the OOBD settings a library folder can be configured. In there all global web files can be stored. It contains two folders: libs and theme (more details see below). The theme folder can contain subfolders, one for each theme. It also contains a folder named " | ||
+ | |||
+ | A new theme is selected by adding a parameter to any URL send to OOBD as '' | ||
+ | |||
+ | OOBD maps the URLs to the '' | ||
+ | * everything which starts with "/ | ||
+ | * everything which starts with "/ | ||
+ | |||
+ | |||
+ | ===== Structure of a script package ===== | ||
+ | |||
+ | The invidual script application can exist in three different versions: | ||
+ | + as well known compiled lua file with the extension .lbc | ||
+ | + as directory with the suffix .epa | ||
+ | + as package file, also with the suffix .epa | ||
+ | |||
+ | ==== the .lbc file ==== | ||
+ | when a lbc file is choosen, the browser loads the default file, referenced as ''/ | ||
+ | |||
+ | ==== the .epa directory or file ==== | ||
+ | Both directory and file are equal regarding their content, but while the directory is mainly for the development work, the package file is for the final distribution, | ||
+ | |||
+ | As soon as such an epa package is selected, it acts as root directory for all following page calls, just except the a.m. directory mapping. | ||
+ | |||
+ | |||
+ | ==== the manifest file ==== | ||
doc/webui_guide.txt · Last modified: 2017/02/04 18:28 by admin