dgarijo / Widoco

Wizard for documenting ontologies. WIDOCO is a step by step generator of HTML templates with the documentation of your ontology. It uses the LODE environment to create part of the template.
Apache License 2.0
295 stars 89 forks source link

Properties for generating introduction and description sections #544

Closed gkirtzou closed 1 year ago

gkirtzou commented 2 years ago

Dear Widoco team, i am trying to generate documentation using the Widoco throught Ontoology (http://ontoology.linkeddata.es/) and I cannot undestand which properties would generate the text for the Introduction and Description section of the html generate pages.

I have tried rdfs:comment, dc:description the only take that changes is in the abstract section. Could you please point me to the correct direction?

PS. In the documentation of best practices (https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html#intro), for the abstract you mention to use "Properties you may use: dc:abstract dcterms:abstract" by there is no dc:abstract property defined in DC vobulary, and if you notice the url points to dc:description.

gkirtzou commented 2 years ago

You can check the pull request generated by ontoology here: https://github.com/gkirtzou/LexMeta/pull/15/commits/607148481b556db2cfe942e81e4cec9acf99565d#diff-1802b9d76c75894923aca057775a0070ae21aa7c0ff9379742aa875dd7bd8cef

dgarijo commented 2 years ago

The property url should take you to https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/abstract, it's a typo in the spec. In theory, adding any of those should work. Your abstract will be based on those.

In the pull request you sent by OnToology the abstract is based on your description (https://github.com/gkirtzou/LexMeta/commit/607148481b556db2cfe942e81e4cec9acf99565d#diff-1802b9d76c75894923aca057775a0070ae21aa7c0ff9379742aa875dd7bd8cef) So I guess it has worked?

gkirtzou commented 2 years ago

In the commit I sent above, I have both a rdfs:comment and a dc:description and given the information in the Best practices page (https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html#intro), I would expect to have the dc:description in the Abstract section and the rdfs:comment value in the Description section. But what I get is rdfs:comment value in Abstract, and placeholder text for Introduction and Description.

So, my question is which are the properties that would generate text in the description.html and introduction.html pages respectively.

dgarijo commented 2 years ago

At the moment (if I remember correctly), the abstract and description are both used in the summary section of the HTML. Intro and description is something left out to complete by hand

gkirtzou commented 2 years ago

Ahhh if that's the case, then I would need to manually change this information in the generated html pages. Maybe you need to clarify that in the Best practices document, cause from our understanding, we did expect to Section 3.2.2 - Description (recommended) and Section 3.2.3 - Abstract (optional) would generate different areas in the html documentation, not the same. Given that LODE (https://essepuntato.it/lode/) used to do that as well.

dgarijo commented 2 years ago

This is a good point. If there is a description I may copy it in the description section always. And then if you have a different abstract, add the abstract there. I will leave the issue open until this is addressed. Sorry for the confusion

jfaldanam commented 2 years ago

Is there any update on this? It will be useful to avoid any kind of manual postprocessing of the HTML to generate the ontology automatically.

dgarijo commented 2 years ago

Hi @jfaldanam, I have been working on documenting which properties are used where, but I have not found the time to address this one yet, sorry. I would like to spend some additional time soon (if I can ) to address it

dgarijo commented 1 year ago

Now that I had the time to work on #436, next release will address this issue

dgarijo commented 1 year ago

Description is done.