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

Improve coherence and source legibility of guide.md #613

Merged
merged 8 commits into from
Aug 17, 2023
Merged

Improve coherence and source legibility of guide.md #613

merged 8 commits into from
Aug 17, 2023

Conversation

Zack-83
Copy link
Contributor

@Zack-83 Zack-83 commented Aug 15, 2023

Among ontology metadata, add "Similar resource" (used) and remove "Label" (nonused); correct vann:preferredNamespacePrefix and vann:preferredNamespaceURI.

Reshape tables; outsource links to ontology terms; correct links to best practice guide.

Use coherently the prefixes dce: and dcterms: across tables and examples; remove ambiguous dc:.

dgarijo and others added 4 commits April 18, 2023 11:59
Fix mixed content in css from WebVOWL
Among ontology metadata, add "Similar resource" (used) and remove "Label" (nonused); correct `vann:preferredNamespacePrefix` and `vann:preferredNamespaceURI`.

Reshape tables; outsource links to ontology terms; correct links to best practice guide.

Use coherently the prefixes `dce:` and `dcterms:` across tables and examples; remove ambiguous `dc:`.
@Zack-83 Zack-83 changed the title Small corrections to guide.md Improve coherence and source legibility of guide.md Aug 15, 2023
@Zack-83 Zack-83 changed the title Improve coherence and source legibility of guide.md Improve coherence and source legibility of [guide.md](https://github.com/dgarijo/Widoco/blob/develop/doc/metadataGuide/guide.md) Aug 15, 2023
@Zack-83 Zack-83 changed the title Improve coherence and source legibility of [guide.md](https://github.com/dgarijo/Widoco/blob/develop/doc/metadataGuide/guide.md) Improve coherence and source legibility of guide.md Aug 15, 2023
@dgarijo
Copy link
Owner

dgarijo commented Aug 15, 2023

Thanks @Zack-83. Can you please merge it in the develop branch? That's the one with the latest commits.

@Zack-83 Zack-83 changed the base branch from master to develop August 16, 2023 06:13
doc/metadataGuide/guide.md Outdated Show resolved Hide resolved
doc/metadataGuide/guide.md Outdated Show resolved Hide resolved
doc/metadataGuide/guide.md Outdated Show resolved Hide resolved
|Given name |[schema:givenName], [vcard:given-name], [foaf:givenname] |[Text] |
|Email |[schema:email], [vcard:hasEmail], [foaf:mbox] |[Text] |
|URL |[schema:url], [vcard:hasURL], [foaf:homepage] |[URI] |

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, why are you removing all the links here? I added them in the first place because having them at the end of the document is a pain to go back and forth. Plus, that way you can copy the metadata property directly from the link instead of having to go to the back to the document all the time. I am fine if you also want to have them at the end of the doc, but I am against removing them here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are separated just in the source code, to improve legibility of the table. But the preview/rendering of the .md file shows the links correctly at the place they're supposed to be.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I was not aware of this way of setting up links. Will merge then. Thanks!

|Label |[rdfs:label], [skos:prefLabel], [obo:IAO_0000118]|[Sec 4.1] **[RECOMMENDED]**|[Text] |[ontology](#term)|
|Original source |[rdfs:isDefinedBy], [dce:source] |[Sec 4.3] **[OPTIONAL]** |[URI] |[ontology](#term)|
|Rationale |[vaem:rationale] |[Sec 4.6] **[OPTIONAL]** |[Text] |[ontology](#term)|
|Status |[sw:term_status], [obo:IAO_0000114] |[Sec 4.5.2] **[OPTIONAL]** |[Text] |[ontology](#term)|
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment about links below

|Source|[dce:source], [dcterms:source], [prov:hadPrimarySource]|source|[Sec 3.4.5] **[OPTIONAL]** |[URI] |[ontology](#onto), [config]|
|Title |[dce:title], [dcterms:title], [schema:name] |ontologyTitle |[Sec 3.2.1] **[RECOMMENDED]**|[Text]|[ontology](#onto), [config]|
|Version IRI |[owl:versionIRI] |thisVersionURI |[Sec 3.3.1] **[RECOMMENDED]**|[URI] |[ontology](#onto), [config]|
|Version number|[owl:versionInfo], [schema:schemaVersion]|ontologyRevisionNumber|[Sec 3.3.2] **[RECOMMENDED]**|[Text]|[ontology](#onto), [config]|
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see comment about links below. I spent quite a lot of time adding them to the table for the very reason that they make my life easier when copy pasting.

@dgarijo
Copy link
Owner

dgarijo commented Aug 17, 2023

@Zack-83 I do appreciate a lot your contributions. However, I don't want to merge this PR if the links in the tables are removed, as explained in my comments above. I plan to extend this metadata guide a bit further probably next week, based on some new analyses I have done. If you don't have the time, I will try to incorporate your other suggestions in my newer edits.

@dgarijo dgarijo merged commit b558364 into dgarijo:develop Aug 17, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants