# ontouml/ontouml-vocabulary architecture

> Architecture diagram of the GitHub repository ontouml/ontouml-vocabulary, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ontouml/ontouml-vocabulary
- Repository: https://github.com/ontouml/ontouml-vocabulary

## Overview

##### Main Components

a) Core Components:
- OntoUML Vocabulary (OWL Implementation)
- Ontology Documentation
- Example Models
- Integration Points

b) External Dependencies:
- ontouml-js
- ontouml-schema
- Web Ontology Language (OWL)

##### Key Relationships to Highlight

- Bidirectional relationships between the vocabulary and supported tools
- Transformation flow from JSON to TTL
- Demonstrate the relationship between model elements and their visual representations

##### Specific Elements

Components:
**[External Tools] ↔ [OntoUML Vocabulary Core] ↔ [Serialization Formats]**
- ↓                     ↓                         ↓
**[Integration Layer] → [Core Implementation] → [Resource Definitions]**

- Blue: Core vocabulary components
- Green: Integration points
- Yellow: Resource definitions
- Gray: External dependencies

##### Implementation Details

- File organization structure (based on the file tree):
- Ontology files (owl, nt, jsonld, ttl)
- Documentation resources
- Example implementations
- Model elements hierarchy

##### Technical Specifications

- Linked data capabilities
- Serialization formats support
- Integration with external tools
- Model element hierarchies

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Integration
        ET[External Tools]
        JS[ontouml-js]
        J2T[ontouml-json2ttl]
        LOV[LOV Dataset]
    end

    subgraph Core["Core Implementation"]
        VOC["OntoUML Vocabulary Core"]:::core
        OWL["OWL Implementation"]:::core
        SER["Serialization Formats"]
        subgraph Formats
            TTL[".ttl Format"]
            JSONLD[".jsonld Format"]
            NT[".nt Format"]
        end
        PT["Provenance Tracking"]:::provenance
    end

    subgraph Resources["Resource Layer"]
        DOC["Documentation"]:::docs
        
        subgraph ModelElements["Model Elements"]
            ME_CLASS["Class"]:::model
            ME_PROP["Property"]:::model
            ME_REL["Relation"]:::model
            ME_GEN["Generalization"]:::model
            ME_PKG["Package"]:::model
            ME_CARD["Cardinality"]:::model
        end
        
        subgraph Shapes["Shape Definitions"]
            SH_RECT["Rectangle"]:::shape
            SH_PATH["Path"]:::shape
            SH_POINT["Point"]:::shape
            SH_TEXT["Text"]:::shape
        end
        
        subgraph Views["Visual Representations"]
            V_CLASS["Class View"]:::view
            V_REL["Relation View"]:::view
            V_GEN["Generalization View"]:::view
            V_GENSET["Generalization Set View"]:::view
        end
        
        EX["Example Implementations"]:::example
    end

    %% Relationships
    ET --> VOC
    JS --> VOC
    J2T --> VOC
    VOC --> LOV
    
    VOC --> OWL
    OWL --> SER
    SER --> TTL & JSONLD & NT
    VOC --> PT
    
    VOC --> DOC
    VOC --> ModelElements
    ModelElements --> Shapes
    Shapes --> Views
    VOC --> EX

    %% Click Events
    click VOC "https://github.com/ontouml/ontouml-vocabulary/blob/main/docs/ontology.owl"
    click TTL "https://github.com/ontouml/ontouml-vocabulary/blob/main/docs/ontouml.ttl"
    click JSONLD "https://github.com/ontouml/ontouml-vocabulary/blob/main/docs/ontology.jsonld"
    click NT "https://github.com/ontouml/ontouml-vocabulary/blob/main/docs/ontology.nt"
    click DOC "https://github.com/ontouml/ontouml-vocabulary/blob/main/docs/index.html"
    click PT "https://github.com/ontouml/ontouml-vocabulary/blob/main/docs/provenance/provenance-en.html"
    
    click ME_CLASS "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/model elements/class.ttl"
    click ME_PROP "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/model elements/property.ttl"
    click ME_REL "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/model elements/relation.ttl"
    click ME_GEN "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/model elements/generalization.ttl"
    click ME_PKG "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/model elements/package.ttl"
    click ME_CARD "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/model elements/cardinality.ttl"
    
    click SH_RECT "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/shapes/rectangle.ttl"
    click SH_PATH "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/shapes/path.ttl"
    click SH_POINT "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/shapes/point.ttl"
    click SH_TEXT "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/shapes/text.ttl"
    
    click V_CLASS "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/views/class-view.ttl"
    click V_REL "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/views/relation-view.ttl"
    click V_GEN "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/views/generalization-view.ttl"
    click V_GENSET "https://github.com/ontouml/ontouml-vocabulary/blob/main/examples/objects/views/generalization-set-view.ttl"
    
    click EX "https://github.com/ontouml/ontouml-vocabulary/tree/main/examples"

    %% Styles
    classDef core fill:#2374ab
    classDef docs fill:#829399
    classDef model fill:#ffb703
    classDef shape fill:#fb8500
    classDef view fill:#219ebc
    classDef example fill:#8ecae6
    classDef provenance fill:#023047

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Documentation"]:::docs
        L3["Model Elements"]:::model
        L4["Shapes"]:::shape
        L5["Views"]:::view
        L6["Examples"]:::example
        L7["Provenance"]:::provenance
    end
```
