Changeset 10743 for main/eko-disco-specs

Timestamp:

14 Nov 2013, 09:50:44 (11 years ago)

Author:

Henrik Bettermann

Message:

The relationships are very important and should be explained not only in a footnote.

Remove 'Indices and Tables' from index page unless we provide them.

Location:

main/eko-disco-specs/trunk

Files:

• data.rst (modified) (6 diffs)
• index.rst (modified) (2 diffs)

main/eko-disco-specs/trunk/data.rst

@@ -25 +25 @@
 data entities connected. Connections to other data entities contain a
 relationship telling how many instances of the described entity are
-connected to how many instances of the related entity [#]_.
-
+connected to how many instances of the related entity.
+
+The following relation types may occur (in both directions):
+
+  - 1:1 (one on one)
+  - n:1 (many on one)
+  - n:m (many on many)
+  - p:1 (many or none on one)
+  - p:q (many or none on many or none)
+  - p:n (many or none on many)
+  - b:1 (one or none on one)
+
+with
+
+  - n, m element of {1, 2, ...},
+  - p, q element of {0, 1, 2, ...}
+  - b element of {0, 1}
+
+Examples:
+
+1:p service-contract relation means that each service
+offered can result in various contracts, but each contract is
+only based on one service. 
+
+p:q user-userrole relation means that each user can have no role or
+several roles and each role can be assigned to no user or several users.
+
+Relations can always be read in two directions.
 
 .. _label-contact-address:
@@ -96 +122 @@
 people. Instead it is an abstraction used inside the system.
 
-It is always created from a :ref:`label-service` , which tells about
+It is always created from a :ref:`label-service`, which tells about
 the basic data, with additional parameters set that depend on the type
 of :ref:`label-service` ordered.
@@ -107 +133 @@
 
 Connected to: :ref:`label-service` (p:1), :ref:`label-customer` (p:1),
-:ref:`label-contract-addon` (1:p), :ref:`label-transaction` (p:q)
+:ref:`label-contract-addon` (1:p), :ref:`label-transaction` (1:p)
 
 Used in the following use cases:
@@ -121 +147 @@
 parameters. Contract addons are created by :ref:`label-contract`\ s.
 
-Connected to: :ref:`label-contract` (p:1)
+Connected to: :ref:`label-contract` (p:1),
+:ref:`label-service` (p:1), :ref:`label-customer` (p:1),
+:ref:`label-transaction` (1:p)
 
 
@@ -311 +339 @@
 
 Connected to: :ref:`label-customer` (p:1), :ref:`label-service`
-(p:1)
+(p:1), :ref:`label-contract` (p:1)
 
 Used in the following use cases:
@@ -346 +374 @@
 Connected to: :ref:`label-user` (p:q)
 
-
-.. [#] Relation types: (1:1): one on one, (1:n): one on many, (n:1):
-       many on one, (n:m): many on many, (1:p): one on many or none,
-       (p:1): many or none on one, (p:q): many or none on many or none,
-       (1:b): one or none on one, (b:1): none or one on one
-
-       In mathematical terms:
-
-       n and m are elements of {1, 2, ...},
-       p and q are elements of {0, 1, 2, ...},
-       b is element of {0, 1}
-
-

main/eko-disco-specs/trunk/index.rst

@@ -4 +4 @@
    contain the root `toctree` directive.
 
-Portal Specifications
-=====================
+Eko Disco Portal Specifications
+===============================
 
 .. Contents:
@@ -19 +19 @@
    license
    install
-
-
-Indices and Tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`