nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: dev/web: update model/view/controller paths

Browse Source 
Fixes #1491
This commit is contained in:
Matthias Schiffer 2018-08-15 19:31:09 +02:00
parent fead411f87
commit 688de03db2
No known key found for this signature in database
GPG Key ID: 16EF3F64CB201D9C
3 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/dev/web/controller.rst
View File

@ -1,8 +1,10 @@
Controllers Controllers
=========== ===========
Controllers live in ``/lib/gluon/web/controller``. They define which pages ("routes") Controllers live in the ``controller`` subdirectory of a gluon-web application
exist under the ``/cgi-bin/gluon`` path, and what code is run when these pages are requested. (``/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 Controller scripts usually start with a *package* declaration, followed by calls
to the *entry* function, which each define one route: to the *entry* function, which each define one route:

9
docs/dev/web/model.rst
View File

@ -1,8 +1,13 @@
Models Models
====== ======
Models are defined in ``/lib/gluon/web/model``. Each model defines one or more Models are defined in the ``model`` subdirectory of a gluon-web application
forms to display on a page, and how the submitted form data is handled. (``/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: Let's start with an example:

7
docs/dev/web/view.rst
View File

@ -1,8 +1,11 @@
Views Views
===== =====
The template parser reads views from ``/lib/gluon/web/view``. Writing own view The template parser reads views from the ``view`` subdirectory of a
should be avoided in favour of using :doc:`model` with their predefined views. 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 Views are partial HTML pages, with additional template tags that allow
to embed Lua code and translation strings. The following tags are defined: to embed Lua code and translation strings. The following tags are defined: