From 688de03db2a31a5d5cb8cf2be38a94aa282c78d6 Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Wed, 15 Aug 2018 19:31:09 +0200 Subject: [PATCH] docs: dev/web: update model/view/controller paths Fixes #1491 --- docs/dev/web/controller.rst | 6 ++++-- docs/dev/web/model.rst | 9 +++++++-- docs/dev/web/view.rst | 7 +++++-- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/dev/web/controller.rst b/docs/dev/web/controller.rst index b3adb288..9bea74eb 100644 --- a/docs/dev/web/controller.rst +++ b/docs/dev/web/controller.rst @@ -1,8 +1,10 @@ Controllers =========== -Controllers live in ``/lib/gluon/web/controller``. They define which pages ("routes") -exist under the ``/cgi-bin/gluon`` path, and what code is run when these pages are requested. +Controllers live in the ``controller`` subdirectory of a gluon-web application +(``/lib/gluon/config-mode/controller`` for the config mode, +``/lib/gluon/status-page/controller`` for the status page). They define which pages ("routes") +exist under the application base URL, and what code is run when these pages are requested. Controller scripts usually start with a *package* declaration, followed by calls to the *entry* function, which each define one route: diff --git a/docs/dev/web/model.rst b/docs/dev/web/model.rst index 6a61e3c4..bc933e75 100644 --- a/docs/dev/web/model.rst +++ b/docs/dev/web/model.rst @@ -1,8 +1,13 @@ Models ====== -Models are defined in ``/lib/gluon/web/model``. Each model defines one or more -forms to display on a page, and how the submitted form data is handled. +Models are defined in the ``model`` subdirectory of a gluon-web application +(``/lib/gluon/config-mode/model`` for the config mode; the status +page does not use any models). Model support is not part of the gluon-web core +anymore, but is provided by the *gluon-web-model* package. + +Each model defines one or more forms to display on a page, and how the submitted +form data is handled. Let's start with an example: diff --git a/docs/dev/web/view.rst b/docs/dev/web/view.rst index d9cafa34..d4f63b60 100644 --- a/docs/dev/web/view.rst +++ b/docs/dev/web/view.rst @@ -1,8 +1,11 @@ Views ===== -The template parser reads views from ``/lib/gluon/web/view``. Writing own view -should be avoided in favour of using :doc:`model` with their predefined views. +The template parser reads views from the ``view`` subdirectory of a +gluon-web application (``/lib/gluon/config-mode/view`` for the config mode, +``lib/gluon/status-page/view`` for the status page). +Writing own views should usually be avoided in favour of using :doc:`model` +with their predefined views. Views are partial HTML pages, with additional template tags that allow to embed Lua code and translation strings. The following tags are defined: