ATF Checker - Githubissues

cdli-gh / Framework

CDLI General issues & CDLI Framework Update project work packages

24 stars 15 forks source link

ATF Checker #91

Closed epageperron closed 4 years ago

epageperron commented 5 years ago

Summary

This ticket comprises all the tasks related to the ATF Checker

Other links or relevant information

ATF structure check

[ ] Checker must parse atf files for content structure as per @stinnney's ATF checker

Check: http://oracc.museum.upenn.edu/doc/help/editinginatf/cdliatf/index.html http://oracc.museum.upenn.edu/doc/help/editinginatf/quickreference/index.html

ATF content check

[ ] Checker must parse atf files for content
- [ ] checker must pull json files from ucla url by default
- [ ] checker must accept custom files when specified by user
- [ ] Check that the API provides proper output to check against catalogue
  - [ ] Check designation info ( for after the "&P000000 = " )
  - [ ] Check that the language matches
    - [ ] Create output for sign and work tokens in the API
    - [ ] checker checks VS sign token / period
    - [ ] checker checks VS word token data / period
    - [ ] checker checks VS catalogue data

usage / availability of the product

[ ] User and coder documentation
[ ] Error reporting must have two levels, proper error and warning
[ ] Error reporting must indicate which line of the original file, which text, ( P55555) which line of that text ( eg. obverse, column 2. line 3)
[ ] Each error must be qualified so the user can know what the problem is
[ ] Must be usable as a standalone (user can specify which files to use for tokens list)
[ ] Must be available as a service at cdli:
- [ ] on demand (so we need a view somewhere on the website with short instructions and a upload button) ,
- [ ] and on upload of ATF (upload blocked if errors detected)

epageperron commented 4 years ago

https://gitlab.com/cdli/framework/issues/77