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 a schema change log page with recommended changes #100

Open
PonteIneptique opened this issue Jun 20, 2022 · 5 comments
Open

Add a schema change log page with recommended changes #100

PonteIneptique opened this issue Jun 20, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request schema

Comments

@PonteIneptique
Copy link
Member

We only add one schema.

We should provide a link to help people change their schema version (either with a tool but at least saying what changed).

Version 2021-10-15 -> Version 2022-04-15

  • Added free-text field transcription-software. Recommended values:
    • eScriptorium + Kraken
    • Transkribus
    • OCR For All
  • script is now a list of objects.
    • Basically, all script ISO values should become - iso: IsoValue such as - lat -> - iso: lat
    • Added the ability to specify a little more the script with a new free text field qualify
  • Added an institutions object which reuses the pattern of authors, except that it forces name and does not support firstname
  • orcid is now available for authors objects
  • A new characters field is now available, it supports three sub-properties
    • A unicode normalization mode called mode, which can be None, NFD, NFKD, NFC, NFKC
    • A transliteration boolean to indicated whether script is transliterated (such as hieroglyphs): Default False
    • A members property which accepts a list of characters and represent all glyphs in the ground truth.
@alix-tz
Copy link
Member

alix-tz commented Nov 19, 2023

Do you think a link to this page should be in the navbar, or could it be in the footer?

@alix-tz
Copy link
Member

alix-tz commented Nov 19, 2023

Also, we need to do the same for the newest version: 2023-06-27

@alix-tz alix-tz added documentation Improvements or additions to documentation enhancement New feature or request schema labels Nov 19, 2023
@alix-tz
Copy link
Member

alix-tz commented Nov 20, 2023

Changelog for 2023-06-27 is fairly simple:

Version 2022-04-15 -> Version 2023-06-27

  • Image-Text-Pairs is now available for format objects.
  • A new automatically-aligned boolean is now available to flag datasets resulting from automatic alignment. Default is False.
  • Fixed type definition for transliteration and missing }.

@alix-tz
Copy link
Member

alix-tz commented Nov 20, 2023

But I don't know if it is useful to include the hot fix in the changelog 🤔

@alix-tz
Copy link
Member

alix-tz commented Nov 20, 2023

Keeping track here: Thibault suggested adding a "hotfix since release" subsection and I agree with it :)

Also, the hotfix on transliteration and the "}" needs to be applied to the previous schema as well.

alix-tz added a commit that referenced this issue Nov 21, 2023
because I forgot to pull before I committed my local changes...
alix-tz added a commit that referenced this issue Nov 21, 2023
* add changelog page with info about v2021-10-15 to v2022-04-15

* add changelog for schema version 2023

* new footer integrating link to changelog

* add a little bit of spacing between logs

* adding new i18n fields

* minor fix in capitalization

* updated the footer

* [Automatic] Update language files

* added hotfixes on the page and fixed footer

* fixed footer style

* [Automatic] Update the HTML

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
PonteIneptique pushed a commit that referenced this issue Nov 29, 2023
* add changelog page with info about v2021-10-15 to v2022-04-15

* add changelog for schema version 2023

* new footer integrating link to changelog

* add a little bit of spacing between logs

* adding new i18n fields

* minor fix in capitalization

* updated the footer

* [Automatic] Update language files

* added hotfixes on the page and fixed footer

* fixed footer style

* [Automatic] Update the HTML

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request schema
Projects
None yet
Development

No branches or pull requests

2 participants