# HG changeset patch
# User jbe
# Date 1503280713 -7200
# Node ID 696d7e5f2bcb29f8f3fd01e0081a7ff31cb9d626
# Parent 6c819040ef6fb8646415433d17bf15906d0a35a6
Added "Layouts" section to WebMCP documentation and cleaned "Directory structure" section up
diff -r 6c819040ef6f -r 696d7e5f2bcb doc/autodoc-header.htmlpart
--- a/doc/autodoc-header.htmlpart Mon Aug 21 01:33:17 2017 +0200
+++ b/doc/autodoc-header.htmlpart Mon Aug 21 03:58:33 2017 +0200
@@ -269,7 +269,31 @@
Actions are similar to views, but supposed to change data in the database, hence only callable by HTTP POST requests. They are also responsible for processing the POST parameters from the webbrowser. They can modify the database, but instead of rendering a page to be displayed, they just return a status code string (via Lua's return statement, where true can also be used instead of "ok", and false instead of "error"). Depending on the status string there will be an internal forward or an HTTP 303 redirect to a view. When calling an action via a POST request, additional POST parameters, which are usually added by hidden form fields, determine the view to be displayed for each status string returned by the action. See the routing parameter to the ui.form{...} function for further details.
+ Layouts
+
+ Templates for HTML documents to be returned by views are stored at the path "app/application_name/_layout/layout_name.html", relative to the application base path. The default layout name is "default". For system errors, the layout name "system_error" is used. A sample layout is given as follows:
+
+
+<!DOCTYPE HTML>
+<html>
+ <head>
+ <title><!-- WEBMCP SLOTNODIV title --></title>
+ <link rel="stylesheet" type="text/css" media="screen" href="__BASEURL__/static/style.css"/>
+ </head>
+ <body>
+ <!-- WEBMCP SLOT content -->
+ </body>
+</html>
+
+ The following elements in a layout file get replaced automatically:
+
+
+ - __BASEURL__ gets replaced with the application's base web address.
+ - <!-- WEBMCP SLOT slot_name --> gets, if the slot is not empty, replaced with a <div> element (with the id attribute set to "slot_slotname") that contains the slot's content.
+ - <!-- WEBMCP SLOTNODIV slot_name --> gets replaced with the slot's content (without wrapping it in an additional <div> element).
+
Directory structure of a WebMCP application
+ Summarizing information from the previous section, we get the following directory structure for a WebMCP application:
-
Base Directory
@@ -277,109 +301,36 @@
-
app/
+ - _prefork/
+ - _postfork/
-
- _prefork/
-
- -
- 10_first_prefork_initializer.lua
-
- -
- 30_third_prefork_initializer.lua
-
-
-
- -
- _postfork/
+ main/ (typically "main" is the only application)
- -
- 01_first_postfork_initializer.lua
-
- -
- 03_third_postfork_initializer.lua
-
-
-
- -
- main/
-
- -
- _prefork/
-
- -
- 20_second_prefork_initializer.lua
-
-
-
+ - _prefork/
+ - _postfork/
+ - _filter/
+ - _filter_action/
+ - _filter_view/
+ - _layout/
-
- _postfork/
-
- -
- 02_second_postfork_initializer.lua
-
-
-
- -
- _filter/
-
- -
- 10_first_filter.lua
-
- -
- 30_third_filter.lua
-
- - …
-
-
- -
- _filter_action/
-
- -
- 20_second_filter.lua
-
- - …
-
-
- -
- _filter_view/
-
-
- -
- _layout/
-
-
- -
- index/
+ index/ (module "index" is the default module)
-
_action/
- -
- action_name.lua
-
- -
- another_action_name.lua
-
+ - action_name.lua
+ - another_action_name.lua
- …
- -
- index.lua
-
- -
- other_view_name.lua
-
+ - index.lua (view "index" of module "index" is the default view)
+ - other_view_name.lua
- …
-
other_module_name/
-
+
@@ -394,28 +345,20 @@
-
config/
- -
- development.lua
-
- -
- production.lua
-
-
-
-
- other_config_name.lua
-
+ - development.lua (e.g. to be used for development purposes)
+ - production.lua (e.g. to be used for production)
+ - other_config_name.lua
- …
-
db/
- -
- schema.sql
-
+ - schema.sql (not used by WebMCP, but may be used to initialize a database)
-
- locale/
+ locale/ (translation files used by the underscore function")
-
translations.de.lua
@@ -433,7 +376,7 @@
model/
-
- model_name.lua
+ model_name.lua (code must create a model class in camel case, e.g. "ModelName" if the file name is "model_name.lua")
-
another_model_name.lua
@@ -448,7 +391,7 @@
-
- tmp/ (writable by the web process)
+ tmp/ (needs to be writable by the user executing WebMCP)