Merge pull request #192 from RDFLib/feat/supermodel

Supermodel Profile

Author: edmondchuc

README.rst

@@ -21,6 +21,8 @@ v 3.x will eventually catch up to all of v 2.13.2's features.
 
 To access v 2.13.2 of pyLODE, either `download it from PyPI <https://pypi.org/project/pyLODE/2.13.2/>`_ , `check it out from GitHub <https://github.com/RDFLib/pyLODE/releases/tag/2.13.2>`_ or access it via the `online service <http://pylode.surroundaustralia.com/>`_ .
 
+In v3.1.0, pyLODE now has a new mode called ``supermodel``, in addition to the existing ``ontpub`` mode. See `supermodel.md <supermodel.md>`_ for more information.
+
 ----
 
 Contents
@@ -282,6 +284,7 @@ Release Schedule
    :header: "Version", "Date", "Description"
    :widths: 15, 10, 30
 
+   **3.1.0**, **16 February 2024**, "Add supermodel mode - supports documenting profiles and modules"
    **3.0.5**, **27 April 2023**, "Minor patching"
    3.0.4, 24 May 2022, "Use of Poetry"
    3.0.2, 24 May 2022, "Support for preformatted skos:example literals"

img/direct-position-obs-class.png

@@ -0,0 +1,60 @@
+PREFIX dcterms: <http://purl.org/dc/terms/>
+PREFIX lode: <https://w3id.org/lode/ns/>
+PREFIX ont: <https://w3id.org/lode/ns/ont>
+PREFIX owl: <http://www.w3.org/2002/07/owl#>
+PREFIX prof: <http://www.w3.org/ns/dx/prof/>
+PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
+PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
+
+lode:Module
+    a
+        rdfs:Class ,
+        owl:Class ;
+    skos:definition "A pyLODE module contains one or more profiles and its classes, properties and SHACL shapes for display under one heading."@en ;
+    skos:prefLabel "Module"@en ;
+    skos:scopeNote "A prof:Profile can also be a lode:Module. All resources loaded using owl:imports or PROF resources will go into the module as one set of statements."@en ;
+.
+
+prof:isProfileOf
+    owl:propertyChainAxiom (
+            lode:isQualifiedProfileOf
+            rdf:value
+        ) ;
+    skos:editorialNote "Possibly no longer required."@en ;
+.
+
+lode:componentModel
+    a prof:ResourceRole ;
+    skos:definition "A Component Model is a closed set of classes and properties defined by an ontology."@en ;
+    skos:prefLabel "component model role"@en ;
+    skos:scopeNote "Used as part of pyLODE input metadata to identify profiles that need to be documented as part of the output as a component model (module)."@en ;
+    skos:editorialNote "Possibly no longer required."@en ;
+.
+
+lode:config
+    a prof:ResourceRole ;
+    skos:definition "A resource with a set of RDF statements that determine parts of pyLODE's documentation processing engine."@en ;
+    skos:prefLabel "pyLODE configuration role"@en ;
+    skos:scopeNote "Use this to include statements such as which profiles are also lode:Module instances, what classes to ignore, the ordering of modules and classes, etc in pyLODE."@en ;
+.
+
+lode:ignoreClass
+    a rdf:Property ;
+    skos:definition "A property to classes that should be ignored by application processors."@en ;
+    skos:prefLabel "ignore class"@en ;
+    skos:scopeNote "pyLODE as an application processor will ignore these classes when generating the documentation output."@en ;
+.
+
+ont:
+    a owl:Ontology ;
+    rdfs:label "pyLODE Vocabulary"@en ;
+.
+
+lode:isQualifiedProfileOf
+    a owl:ObjectProperty ;
+    skos:definition "A property to a qualified node which has a link to a profile."@en ;
+    skos:prefLabel "is qualified profile of"@en ;
+    skos:scopeNote "As a configuration side effect, pyLODE will only load into the graph closure classes and properties that are defined in a profile that is linked to by lode:isQualifiedProfileOf."@en ;
+.
+