summaryrefslogtreecommitdiff
path: root/docs/glossary.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/glossary.rst')
-rw-r--r--docs/glossary.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst
new file mode 100644
index 00000000..cfeb0966
--- /dev/null
+++ b/docs/glossary.rst
@@ -0,0 +1,34 @@
+
+Glossary
+--------
+
+.. glossary::
+
+ application
+ A CherryPy application is simply a class instance containing
+ at least one page handler.
+
+ controller
+ Loose name commonly given to a class owning at least one exposed method
+
+ exposed
+ A Python function or method which has an attribute called `exposed`
+ set to `True`. This attribute can be set directly or via the
+ :func:`cherrypy.expose()` decorator.
+
+ .. code-block:: python
+
+ @cherrypy.expose
+ def method(...):
+ ...
+
+ is equivalent to:
+
+ .. code-block:: python
+
+ def method(...):
+ ...
+ method.exposed = True
+
+ page handler
+ Name commonly given to an exposed method