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

Add documentation on how to create a Glossarist dataset #83

Closed
ronaldtse opened this issue Nov 17, 2023 · 4 comments
Closed

Add documentation on how to create a Glossarist dataset #83

ronaldtse opened this issue Nov 17, 2023 · 4 comments

Comments

@ronaldtse
Copy link
Member

What are the key files of a Glossarist dataset? The description YAML, concept YAML files... etc.

@HassanAkbar
Copy link
Member

@ronaldtse we need 2 folders for creating a concept dataset (both folder names are singular)

  1. concept
  2. localized_concept

Currently there is no documentation for Glossarist Model V2 so I've followed what was done in isotc211-glosary and Typescript definitions concept.ts and item.ts. For Glossarist We don't need all the folders here only the 2 mentioned above and also we only need the data key and not the registers data for the concepts and localized_concepts.

I'm working on adding complete documentations for what is currently implemented in Glossarist and I'll open a PR for that once done.

@ronaldtse
Copy link
Member Author

ronaldtse commented Nov 17, 2023

@HassanAkbar in the termium gem when I export from glossarist, in the Cli class “convert” method, the generated dataset only had a flat directory with concepts as YAML files. What’s wrong with it?

Do you have to update the glossarist gem to export in the new structure with 2 directories?

@HassanAkbar
Copy link
Member

@ronaldtse I believe the issue has been fixed in #84.

I will add the documentation for this in a PR for this issue -> #81

@HassanAkbar
Copy link
Member

Documentation was added in this PR -> #90

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

No branches or pull requests

2 participants