DiellzaElshani
commented
1 year ago @danielhz's suggestion and comment:
The way we define classes with github URI works in term of identifying classes, but not according to the linked data principles. A good URL design is one that:
- Distinguish objects from documents. In this case you GET an class Bar, but you get a document of the Web page of the class Bar in the Github repository. It is better to use a distinct URL, for instance:
https://github.com/BHoM/BHoM/blob/main/Structure_oM/Elements/Bar.cs#class
or
https://bhom.org/ontology/Sttructure_oM/Bar
And then, this URL should not retrieve just a page, but a RDF document describing the class Bar.
I think that you should avoid conflicts between classes defined by other people. Maybe you can generate a service that is connected to BHoM where to store classes and predicates. So, if your BHoM code can generate a particular class Bar that is different from other people class Bar.
So, the generator can use this service as a parameter, maybe with a namespace to create classes and predicates. So you can generate URLs like this one:
http://ourontologyservice.org/saoYuBot9AhrooGhiemi/Bar
The to_rdf() should have the option to post the ontology to this service. Maybe, we can just use a Solid POD to manage ontologies and data.
Description:
In bhOWL for each class or property we use its github URI.
for example:
In the ttl we define @ prefix : https://www.bhom.org/ . which means. whenever we see a colon ":" a bhom.org can be placed before the colon, and this would form a URI that pinpoints to the URI of the class.
which is wrong in two ways:
we use : in front of custom classes too, which concatenated with bhom.org would give invalid URI, and it is inconsistent with the link above.
Also BHoM native objects have a wrong URI, because adding bhom.org in front of :BH.oM.Architecture.Elements.Room also does not give us (https://github.com/BHoM/BHoM/blob/main/Architecture_oM/Elements/Room.cs). And using something like: _ArchitectureoM/Elements/Room.cs to name the class woulnd work, becuase of RDF syntax using /.
Steps to reproduce:
I have two suggestions: 1) We use a unique URI for both, bhom classes and custom objects, so we don't have to differentiate between the prefix. We then add one more input to Tbox settings, to define a prefix for it.
Eventually in future we can also publish have a way to publish a page with this ontology (like rdf https://www.w3.org/1999/02/22-rdf-syntax-ns# or bot https://w3c-lbd-cg.github.io/bot/ ). Which does not have to be public, but accessible from the ones who use the ontology.
2) We create a static page with bhom ontology, and we use bhom: prefix in front of each bhom native object. But for the Custom ones, we define this imaginary URI, which we can publish and share internally with the ones who will use the ontology. In this case we would use ":" only in front of NON-BHoM native objects.
I think the second option is a better solution.
Expected behaviour:
Test file(s):