Adding sphinx documentation

This commit is contained in:
Luca Frosini 2023-01-26 18:28:54 +01:00
parent 93d00bd4f0
commit 5497bfaf6e
3 changed files with 50 additions and 5 deletions

View File

@ -40,6 +40,10 @@ An previous paper about this work is:
The IS Model
************
.. image:: ./is-model.png
.. image:: ./is-model-er.png
The Information System Model (henceforth IS Model) is a graph model with Entities as nodes and Relations as edges.
* Two typologies of entities are envisaged:
@ -47,6 +51,7 @@ The Information System Model (henceforth IS Model) is a graph model with Entitie
* Resources, i.e. entities representing a description of "thing" to be managed:
* Every Resource is described by a number of Facets.
* Facets, i.e. entities contributing to "build" a description of a Resource. Every facet, once attached to a Resource profile captures a certain aspect / characterization of the resource:
* Every facet is characterised by a number of properties.
@ -83,14 +88,54 @@ The Free Dictionary defines a facet as “One of numerous aspects, as of a subje
....
Type Attributes
===============
********************************
IS Model Base Concept Definition
********************************
Any Property defined in the schema is characterised by:
Any extension of the IS Model will be defined as following
Name:
Property Name
Type:
The Type of the Property (e.g. String, Integer, ...). It can be a Basic Type or a Derived Type or a Complex Type
Description:
The description of the Property. default=null.
Mandatory (M):
Indicate if the Property is mandatory. default=false.
ReadOnly (RO):
The Property cannot change its value. default=false.
NotNull (NN):
Whether the property must assume a value diverse from 'null' or not. default=false
Max (Max):
default=null
Min (Min):
default=null
Regex (Reg)):
A Regular Expression to validate the property value, default=null. A good online tool for regex is avalable at https://regex101.com/
Basic Types
-----------
Derived Types
-----------
The following are obtained using a String as real type and adding a validation regex.
Complex Types
-----------
Any property defined by composing basic types, complex types and other complex types. Any complex type can be defined by extending Property type.
Property

BIN
docs/is-model-er.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/is-model.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB