Bladeren bron

Start of restructuring the documentation

Yentl Van Tendeloo 8 jaren geleden
bovenliggende
commit
ea59dcecd1
4 gewijzigde bestanden met toevoegingen van 72 en 5 verwijderingen
  1. 13 5
      doc/index.rst
  2. 25 0
      doc/interaction.rst
  3. 20 0
      doc/metamodelling.rst
  4. 14 0
      doc/modelling.rst

+ 13 - 5
doc/index.rst

@@ -12,13 +12,21 @@ Contents:
    :maxdepth: 2
     
    Installation <installation>
-   How to run <howto>
-   Modelverse components <components>
-   Action Language <actionlanguage>
+   Basic interaction <interaction>
+   Modelling <modelling>
+   Metamodelling <metamodelling>
+   Transformations <transformations>
+   Operations <operations>
+   Services <services>
+   Concrete Syntax <concrete_syntax>
+   Common problems and solutions <problems>
    Modelling Language <modellanguage>
+   Action Language <actionlanguage>
    Wrappers <wrappers>
    Model representation <model>
    Permission system <permissions>
-   Common problems and solutions <problems>
-   Interfaces <interface>
+   Modelverse components <components>
+   Communication models <communication_models>
+   Primitives <primitives>
    Internals <internal>
+   Interfaces <interface>

+ 25 - 0
doc/interaction.rst

@@ -0,0 +1,25 @@
+Basic Interaction
+=================
+
+Briefly present Modelverse and how to execute
+
+Working knowledge
+-----------------
+
+Very briefly explain the Modelverse architecture
+the minimal necessary to meaningfully start using it!
+That is: distinction between interface, kernel, and state
+
+Necessary scripts
+-----------------
+
+Explain the different scripts and how they can be used
+Briefly show the *run_tests.py* and *run_local_modelverse.py*
+Also *prompt.py*
+
+Wrapper
+-------
+
+We explain the simple Python wrapper
+Other wrappers can be defined quite easily due to the Modelverse architecture
+Later is a full overview of the wrapper, we now introduce it piece by piece in Python

+ 20 - 0
doc/metamodelling.rst

@@ -0,0 +1,20 @@
+Metamodelling
+=============
+
+Explain use of metamodelling
+
+Metamodels as Models
+--------------------
+
+Metamodels are models as well, and therefore quite similar in use
+
+Creating a metamodel
+--------------------
+
+Show how to create a new metamodel
+And adding some concepts
+
+Instantiating a metamodel
+-------------------------
+
+Show how we now create an instance of this newly created metamodel

+ 14 - 0
doc/modelling.rst

@@ -0,0 +1,14 @@
+Modelling
+=========
+
+explain use of modelling and assume that a metamodel exists
+
+Creating a model
+----------------
+
+Example of creating a simple model
+
+Modifying a model
+-----------------
+
+Example of basic modelling operations on this new model