Differences

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

--- doc:webui_guide [2015/07/12 18:45] – admin
+++ doc:webui_guide [2015/12/27 23:01] – admin
@@ Line 1: / Line 1: @@
-====== OOBD Web UI Design Rules =====
+====== OOBD Web UI Design Guideline ======
+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 "/"), OOBD sends a on-the-fly generated xml file containing the available scripts. The xml file contains also a reference to a xslt style sheet (/theme/default/xslt/start.xsl). These both is rendered by the browser to show what can be used as script.
+==== 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 "default", which supplies the default theme as long as no other theme is choosen.
+A new theme is selected by adding a parameter to any URL send to OOBD as ''http://xxxxx?theme=newtheme''. The new theme is stored and used for the futher page requests.
+OOBD maps the URLs to the ''libs'' and ''theme'' folders:
+  * everything which starts with "/libs/" is mapped to the libs - folder inside the Library folder, which is configured in the settings
+  * everything which starts with "/theme" is mapped to the theme/<youractualtheme> - folder inside the Library folder, which is configured in the settings
+===== 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 ''/theme/start.html'' (where ''/theme'' is mapped, as you remember), so the apperance is driven by the theme
+==== 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 it contains all nessesary files, it's just the zipped content of the directory.
+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 =====