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

[dicts] clean up DTDs, add/improve documentation #42

Open
Phaqui opened this issue Jan 10, 2024 · 1 comment
Open

[dicts] clean up DTDs, add/improve documentation #42

Phaqui opened this issue Jan 10, 2024 · 1 comment

Comments

@Phaqui
Copy link
Contributor

Phaqui commented Jan 10, 2024

1: Make sure that the .dtd file only exist in giella-core, and that each dictionary refers to that one. An immediate observation
is that the path to the dtd in .xml files are written as a relative path. After the move to github, users may have the dictionaries cloned to an arbitrary path. This could make running xmllint --valid on a dictionary challenging.

2: Document what the different attributes mean, how they are used, and what they are used for. There are two audiences for such documentation:

  • Dictionary authors. They need to know how to express various linguistic properties in the dictionary. For example how to mark transitive/intransitive verbs, noun cases, etc.
  • Programmers: who will need to know how the various pieces are going to be used, or presented. For example, how to display the fact that a verb can only be used in a transitive way.
@Phaqui
Copy link
Contributor Author

Phaqui commented Jan 10, 2024

Comments on 1:

  • The file is /giellalt/giella-core/dicts/scripts/gt_dictionary.dtd, and dictionary files reference it using a relative path.
  • However, some dictionary has their own dtd, in a dtd/xxxyyy.dtd file.
  • One possible fix to the path problem: Put the dtd on a publicly accessible url. This does however mean that an internet connection is required to validate against it.
  • Another fix is to require all users to keep repositories belonging to the same organization in the same folder.

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

1 participant