docs: add RDF import profile reference for external generators - #83
Open
Gaurangit wants to merge 1 commit into
Open
docs: add RDF import profile reference for external generators#83Gaurangit wants to merge 1 commit into
Gaurangit wants to merge 1 commit into
Conversation
Document the exact RDF/XML profile parseRDF() accepts — entity-id derivation, property type mapping, cardinalities, ont: annotations, relationship attributes, and the constructs that are ignored (e.g. rdfs:subClassOf) — so external tools can programmatically emit ontologies that import cleanly into the Playground, the catalogue, and the embed widget. Includes a minimal complete example and verification tips. Co-Authored-By: Claude Fable 5 <[email protected]>
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Adds
docs/external-rdf-generators.md— a reference documenting the exact RDF/XML profileparseRDF()(src/lib/rdf/parser.ts) accepts — plus a row in the README documentation table.It covers, for authors of external tools that want to emit Playground-compatible ontologies programmatically:
rdfs:domainURI match,ont:propertyTypevalues, and the XSD range fallback mappingont:fromEntityId/ont:toEntityIdvs domain/range), valid cardinalities, and relationship attributes viaont:relationshipAttributeOfont:icon,ont:color,ont:unit,ont:enumValues,ont:isIdentifier)rdfs:subClassOf), with the recommended alternativeparseRDF()in CI)Why
The existing Authoring Guide targets humans writing ontologies by hand. While integrating two external Python tools (a schema.org schema generator and a knowledge-object framework) with the Playground, I had to reverse-engineer these rules from
parser.ts. Documenting the import profile makes the Playground usable as a visualization front-end for external pipelines — generators can emit.rdfartifacts that import cleanly via Import/Export, the catalogue, and the embed widget, without reading the parser source.Notes
🤖 Generated with Claude Code