HGustavs / LenaSYS

Code Viewer and Course Organization System used in some courses at University of Skövde
57 stars 31 forks source link

Create ER-diagram Wiki #14284

Closed a22solmi closed 5 months ago

a22solmi commented 5 months ago

Description

The functionality of different types of diagrams needs to be documented. A wiki page need to be created with the current functionality and some technical description of how it is achieved. There should also be references to closed issues that have implemented said functionality. There should be clear descriptions for each new topic with pictures if user interface is described. File paths and code blocks should be included when describing code implementation. An example of good structure can be found in: https://github.com/HGustavs/LenaSYS/wiki/Diagram-dugga-overview

Job

Create a new wiki page describing how the ER-diagrams currently work.

d22samma commented 5 months ago

ER - Diagram Wiki

Overall information & instructions

Diagram Dugga, represent a page where you are able to create different kinds of diagrams. In this wiki we will display and discuss important parts of Diagram Dugga to create and manage ER diagrams.

General overview of Diagram Dugga

Image 1: General overview of Diagram Dugga source: ( .../DuggaSys/diagram.php )

Toolbar

- Pointer

pointer

The pointer allows user to select single objects and drag across the diagram. It can be enabled by pressing "1" on the keyboard.

- Box selection

boxSelection

The box selection tool allows user to select multiple objects simultaneously. By doing this you can delete multiple objects at the same time or or change the colour of multiple objects by selecting them and opening the options panel giving them a chosen colour from the color palette .

- Entities

ER relation field

By long-pressing this the user can chose between placing an ER-entity, UML class, IE entity or State diagram state into the diagram.

ER entity

ER relation field

By using this button you can create new objects.

- Relation/Inheritance

ER Relation and Attribute Field

Allows user to place ER-relations, UML-inheritence and IE-inheritance in the diagram by long pressing the button.

ER Relation

ER Realtion

Create a relations between different objects.

- ER Attribute

ER Atribute

Create a attribute that you can combine with an object. Example named: firstname, lastname, adress.

Line

ER Atribute

Attributes can be combined with objects Example firstname can be combined with an object called Human.

- Redo

redo

If you accidentally made an undo. You can use the redo button to regret and repaint the previous version.

- Undo

pointer

You did something you regret. You can easily use the undo button to move backwards to the point you want to continue from.

- Toogle ER-table

ertable

To be able to use this functionality the user must first:

  1. Add an object to the diagram
  2. Open the options panel, the yellow bar at the right.
  3. Press the button to toggle between views like options and properties .
er

Image 2: Demonstrates the ER-table functionality.

Options Panel

a22vioja commented 5 months ago

New Wiki page describing how the ER-diagrams currently work is created: https://github.com/HGustavs/LenaSYS/wiki/ER%E2%80%90diagram