# Documenting Ontologies

**URL:** <https://forum.solidproject.org/t/documenting-ontologies/5252>\
**Category:** Linked Data\
**Created:** [May 4, 2022, 3:44pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252 "2022-05-04T15:44:36Z")\
**Posts on this page:** 11\
**Page:** 1

<div class="post-metadata">

**Author:** ![calummackervoy](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/calummackervoy/32/2233_2.png) [@calummackervoy](https://forum.solidproject.org/u/calummackervoy)\
**Post date:** [May 4, 2022, 3:44pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/1 "2022-05-04T15:44:36Z")

</div>

Hi!

Apologies if I’m asking this in the wrong place or if it’s been asked before (I missed it if so)

All the best ontologies have human-readable documentation to explain their terms, and they follow a similar format, usually using tables. For examples see [DCMI](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/) or [FOAF](http://xmlns.com/foaf/spec/)

Is there a tool which automatically generates a template for these documents? A friend of mine asked me about this because he wasn’t able to find one which is maintained (and they have some ontologies to publish!), and I thought I’d ask here

Thanks!

---

<div class="post-metadata">

**Author:** ![Smag0](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/smag0/32/310_2.png) [@Smag0](https://forum.solidproject.org/u/Smag0)\
**Post date:** [May 5, 2022, 11:22am UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/2 "2022-05-05T11:22:52Z")

</div>

In what format is your ontology?  
If XML/rdf, it should be possible to use xslt to build html

---

<div class="post-metadata">

**Author:** ![calummackervoy](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/calummackervoy/32/2233_2.png) [@calummackervoy](https://forum.solidproject.org/u/calummackervoy)\
**Post date:** [May 5, 2022, 1:15pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/3 "2022-05-05T13:15:03Z")

</div>

Thanks 😄 do you know if there’s a similar tool for turtle directly? I guess that I can also serialize it into XML and then build with XSLT

---

<div class="post-metadata">

**Author:** ![jeffz](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/jeffz/32/600_2.png) [@jeffz](https://forum.solidproject.org/u/jeffz)\
**Post date:** [May 5, 2022, 5:33pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/4 "2022-05-05T17:33:19Z")

</div>

Inrupt has ontology managing/building tools. See [Vocabulary — Inrupt JavaScript Client Libraries](https://docs.inrupt.com/developer-tools/javascript/client-libraries/tutorial/use-vocabularies/).

@Timea - I seem to remember you had a friend with a tool like the one requested.

---

<div class="post-metadata">

**Author:** ![jeffz](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/jeffz/32/600_2.png) [@jeffz](https://forum.solidproject.org/u/jeffz)\
**Post date:** [May 5, 2022, 5:35pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/5 "2022-05-05T17:35:40Z")

</div>

Also, my own library [Solid UI Components - WiP | solid-ui-components](https://jeff-zucker.github.io/solid-ui-components) has the ability to display ontologies as HTML. See an example of displaying a glossary at [https://jeff-zucker.solidcommunity.net/sp4/](https://jeff-zucker.solidcommunity.net/sp4/).

---

<div class="post-metadata">

**Author:** ![Timea](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/timea/32/2720_2.png) [@Timea](https://forum.solidproject.org/u/Timea)\
**Post date:** [May 6, 2022, 4:20pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/6 "2022-05-06T16:20:32Z")

</div>

I am only aware of a commercial solution because I used to work for that company. They had some tools for displaying, in a human-readable way, a thesaurus or an ontology. They called it the Linked Data frontend. Here is an example of the World Bank open data build on that tool: [https://vocabulary.worldbank.org/](https://vocabulary.worldbank.org/) P.s. the ontology driving the documentation and structure is SKOS here.

---

<div class="post-metadata">

**Author:** ![kidehen](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/kidehen/32/42_2.png) [@kidehen](https://forum.solidproject.org/u/kidehen)\
**Post date:** [May 6, 2022, 10:14pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/8 "2022-05-06T22:14:49Z")

</div>

Nice page!

Wondering if you could add a reference to the RDF-Turtle doc via HTML metadata such that its easier to discover by other user agents.

Options.

1. `<link rel="alternate" href="https://jeff-zucker.solidcommunity.net/sp4/glossary-data.ttl" type="text/turtle" />`

2. `<script type="text/turtle"> @prefix xhv: <http://www.w3.org/1999/xhtml/vocab#> . <> xhv:alternate <glossary-data.ttl>. </script> .`

Net effect, it’s much easier to mesh your data with others across the Web. For example, here’s what I’ve done with [this example](http://linkeddata.uriburner.com/describe/?url=https%3A%2F%2Fjeff-zucker.solidcommunity.net%2Fsp4%2Fglossary-data.ttl%23SolidCoreConcepts&distinct=1), albeit with more clicks than would be required should you incorporate any of the suggestions above into your HTML doc 🙂

---

<div class="post-metadata">

**Author:** ![jeffz](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/jeffz/32/600_2.png) [@jeffz](https://forum.solidproject.org/u/jeffz)\
**Post date:** [May 6, 2022, 10:18pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/9 "2022-05-06T22:18:53Z")

</div>

Great idea, thanks @kidehen! When I get time, this will be hosted on [solidproject.org](http://solidproject.org) and have a permanent location for the RDF so can be reusable any way anyone wants.

---

<div class="post-metadata">

**Author:** ![aschrijver](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/aschrijver/32/463_2.png) [@aschrijver](https://forum.solidproject.org/u/aschrijver)\
**Post date:** [May 8, 2022, 6:06am UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/10 "2022-05-08T06:06:03Z")

</div>

Not directly what you are asking, but here’s also some tools that offer more dynamic visualization that may be usable to easily grasp the ontologies in use. Like WebVOWL:

> **[WebVOWL - Web-based Visualization of Ontologies](http://vowl.visualdataweb.org/webvowl.html)**
>
> WebVOWL - Web-based Visualization of Ontologies

---

<div class="post-metadata">

**Author:** ![ThisIsMissEm](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/thisismissem/32/3166_2.png) [@ThisIsMissEm](https://forum.solidproject.org/u/ThisIsMissEm)\
**Post date:** [May 9, 2022, 8:54pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/11 "2022-05-09T20:54:01Z")

</div>

The Inrupt tools around vocabularies (artifact-generator & our “pre-built vocab” packages) are currently only available as alpha releases, so mileage may vary.

What sort of features would people want in a vocabulary tool?

I’m thinking validation, overlaps, recommendations (helping you write good vocabs), code generation, docs, etc. might be all things people might want?

We do have some ideas recorded internally at Inrupt on potential tools beyond the alphas we have out, but nothing particular on the roadmap. It’s also debatable as to whether people will want tooling around vocabs, or whether tooling around shapes would be more useful.

---

<div class="post-metadata">

**Author:** ![zwifi](https://dub1.discourse-cdn.com/flex017/user_avatar/forum.solidproject.org/zwifi/32/1525_2.png) [@zwifi](https://forum.solidproject.org/u/zwifi)\
**Post date:** [May 10, 2022, 1:51pm UTC](https://forum.solidproject.org/t/documenting-ontologies/5252/12 "2022-05-10T13:51:16Z")

</div>

In the past, I’ve used [LODE - Live OWL Documentation Environment](https://essepuntato.it/lode/), but I think it’s mostly based on XSLT transforms, which requires the ontology being in RDF/XML, and is a bit brittle. I would recommand using [WIzard for DOCumenting Ontologies (WIDOCO) | Widoco](https://dgarijo.github.io/Widoco/), which is quite a fully-featured tool to generate ontology documentations.