Skip to content

General Issue: Restructuring the Terms pages #182

@DavidFichtmueller

Description

@DavidFichtmueller

Suggestion

For each FDO, there are 3 resource pages, the terms page, the quick reference guide and the core resources. the terms page and the guide are very close to each other in terms of the information they present. This structure is taken from the DwC documentation, it differs however in certain ways, that are a bit of a disadvantage.

In the guide, the terms are structured a bit more user friendly. All of the properties are sorted by their class, even if this means that reused properties occur multiple times on that page. On the terms page, the terms show a bit more information.

When the URI of a term in DwC is resolved, it is redirected to the terms page, which is sorted alphabetically. DwC doesn't have any reuses of properties between classes. The ones that are, are sorted in their own group called "Record level". Which is why they don't encounter a problem that exists for openDS.

The openDS terms don't resolve yet and I am not sure, what the planned strategy is for when they resolve, but at the moment they could not link to the correct definition, as the entries on the terms page are still dependent on the class where they are used. Compare for example MaterialEntity:organisationName and DigitalSpecimen:organisationName, both having the same URI, but different documentation here, in regards to the "Belongs to Class" segment.

We feel that the terms pages need to be restructured, so that each term only occurs once. The terms could be sorted alphabetically and if reused by different classes, it should list them as "Belongs to Class(es):" . The anchor links at the section Index By Term Name should only include the term name and not the class, just as the DwC documentation does.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions