From bf1c64da845a8442502a043c7d944b9b1cf2bbe8 Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Tue, 9 Sep 2014 17:52:10 +0200 Subject: [PATCH] Doc: Structure and concepts --- doc/development/concepts.rst | 18 ++++++++++++++++++ doc/development/index.rst | 2 ++ doc/development/structure.rst | 20 ++++++++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 doc/development/concepts.rst create mode 100644 doc/development/structure.rst diff --git a/doc/development/concepts.rst b/doc/development/concepts.rst new file mode 100644 index 0000000000..ad89552d7b --- /dev/null +++ b/doc/development/concepts.rst @@ -0,0 +1,18 @@ +Implementation Concepts +======================= + +Basic terminology +----------------- + +Tixl is a sofware selling **Items**, an abstract thing which is related to an **Event**. Every Event is managed by the **Organizer**, who runs the event. + +Tixl know two types of **Users**: + +**Local users** + Local users do only exist inside the scope of one event. They are identified by usernames, which are only valid for exactly one event. + +**Global users** + Global users exist everywhere in the installation of Tixl. They can buy tickets for multiple events and they can be managers of one or more Organizers/Events. Global users are identified by e-mail addresses. + +For more information about this user concept and reasons behind it, see the docstring of the ``tixlbase.models.User`` class. + diff --git a/doc/development/index.rst b/doc/development/index.rst index 41be4c494a..0bbcb1e6e2 100644 --- a/doc/development/index.rst +++ b/doc/development/index.rst @@ -7,4 +7,6 @@ Contents: :maxdepth: 2 goals + concepts setup + structure diff --git a/doc/development/structure.rst b/doc/development/structure.rst new file mode 100644 index 0000000000..3fa3bf1282 --- /dev/null +++ b/doc/development/structure.rst @@ -0,0 +1,20 @@ +Project structure +================= + +Python source code +------------------ + +All the source code lives in ``src/``, which has several subdirectories. + +tixl/ + This directory contains the basic Django settings and URL routing. It is + +tixlbase/ + This is the django app containing all the models and methods which are + essential to all of tixl's features. + +tixlcontrol/ + This is the django app containing the frontend for organizers. + +tixlpresale/ + This is the django app containing the frontend for users buying tickets.