doc:webui_guide
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
doc:webui_guide [2015/07/12 18:44] – created 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 capability of using a web browser as a graphical frontend to OOBD opens a endless field of possibilies of how the interface can look like and how it acts. To not having all these different ways interfearing which each other, these rules should be followed. | + | ===== 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 ==== | ||
+ | |||
+ | |||
+ | |||
+ | The capability of using a web browser as a graphical frontend to OOBD opens a endless field of possibilies of how the interface can look like and how it acts. To not having all these different ways interfearing which each other, these rules should be followed. | ||
===== Folder Structure ===== | ===== Folder Structure ===== | ||
Line 30: | Line 70: | ||
- | === lib ==== | + | ==== lib ==== |
The todays webkits like jQuery, Dojo etc. consist of huge numbers of files. To not have them packed multiple time in each container, they are stored separately. | The todays webkits like jQuery, Dojo etc. consist of huge numbers of files. To not have them packed multiple time in each container, they are stored separately. | ||
Line 37: | Line 77: | ||
The lib content should be 1:1 to the original without any own modifications and tweaks | The lib content should be 1:1 to the original without any own modifications and tweaks | ||
- | === theme ==== | + | ==== theme ==== |
Modern HML designs allow a common look & feel, controlled by css, a common set of icons etc. By using themes you can easy design and maintaing a lot of app designs without updating them all individually. | Modern HML designs allow a common look & feel, controlled by css, a common set of icons etc. By using themes you can easy design and maintaing a lot of app designs without updating them all individually. | ||
Line 47: | Line 87: | ||
- | === yourapp ==== | + | ==== yourapp ==== |
in here you store everything, which is unique to your app, means not a common theme or a webkit library | in here you store everything, which is unique to your app, means not a common theme or a webkit library | ||
- | === secret ==== | + | ==== secret ==== |
Afer building it, your app container will need to contain at least some content which is public readable, like it's full name, description, | Afer building it, your app container will need to contain at least some content which is public readable, like it's full name, description, | ||
doc/webui_guide.txt · Last modified: 2017/02/04 18:28 by admin