Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properties for generating introduction and description sections #544

Closed
gkirtzou opened this issue Jul 11, 2022 · 10 comments · Fixed by #619
Closed

Properties for generating introduction and description sections #544

gkirtzou opened this issue Jul 11, 2022 · 10 comments · Fixed by #619

Comments

@gkirtzou
Copy link

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
Copy link
Author

You can check the pull request generated by ontoology here:
gkirtzou/LexMeta@6071484#diff-1802b9d76c75894923aca057775a0070ae21aa7c0ff9379742aa875dd7bd8cef

@dgarijo
Copy link
Owner

dgarijo commented Jul 11, 2022

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 (gkirtzou/LexMeta@6071484#diff-1802b9d76c75894923aca057775a0070ae21aa7c0ff9379742aa875dd7bd8cef)
So I guess it has worked?

@gkirtzou
Copy link
Author

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
Copy link
Owner

dgarijo commented Jul 11, 2022

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
Copy link
Author

gkirtzou commented Jul 12, 2022

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
Copy link
Owner

dgarijo commented Jul 12, 2022

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
Copy link

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
Copy link
Owner

dgarijo commented Nov 15, 2022

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
Copy link
Owner

dgarijo commented Jan 8, 2023

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

dgarijo added a commit that referenced this issue Aug 21, 2023
@dgarijo
Copy link
Owner

dgarijo commented Aug 23, 2023

Description is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants