folialint(1)

πŸ’… folialint β€” bestie edition ✨

okay so you found folialint in the General Commands Manual and you're like "what does this diva do" β€” she checks whether your FoLiA documents are actually valid, and honestly? she's the friend who reads your essay before you submit it. πŸŽ€


🌸 NAME 🌸

folialint β€” check validity of FoLiA documents πŸ‘‘


✨ SYNOPSIS ✨

folialint [options] FILE(S)

like. give her the files. she'll tell you what's wrong. no cap.


πŸ¦‹ DESCRIPTION πŸ¦‹

folialint checks the validity of FoLiA files, but on a surface level β€” think vibe check, not a full forensic audit πŸ”

here's the checklist she runs, bestie:

  • Is the tag structure according to the definition?
  • Are all required elements and attributes present?
  • Are the attributes and values valid?
  • Are all annotations correctly declared?
  • Is all text consistent?

she's thorough in a specific way and we love her for it πŸ’–


πŸ’… OPTIONS πŸ’…

  • --output file β€” write output to file. (default is stdout). Assumes only 1 inputfile. one file in, one file out, that's the deal 🫢
  • --nooutput β€” suppress all output except errors. silent mode. she's just observing πŸ‘€
  • --nochecktext β€” Disable checking text consistency. (for older FoLiA versions this wasn't forced to be so. Which is wrong) 🚩
  • --fixtext β€” Attempt to fix text problems like wrong offset's. > Might be dangerous, and the default is to DON'T do it. like, literally don't. the default is DON'T. 😭
  • -a or --autodeclare β€” Attempt to automaticly fix missing annotations. (default: false) she tries her best 🧚
  • --strip β€” strip all information from the file that makes comparison hard. Notably date/time information. This also enable --canonical output, meaning that otherwise unsorted tags are output in the same order every time. ✨
  • --permissive β€” Accept documents with missing namespace declarations. she's being nice about it 🌈
  • --warn β€” add some extra (warning) checks:
    • About unused set declarations
    • About possible incompatabilities between the current library version and the document version.
  • --canonical or --KANON β€” output annotation declarations and FoLiA nodes in a fixed (canonical) order. This might make tree comparisons easier. (yes the all-caps one is iconic, we don't question it πŸ‘‘)
  • -d or --debug level β€” run with a debug level of level
  • -V or --version β€” Show VERSION
  • -h or --help β€” Show some help πŸ™ˆ

πŸ’€ BUGS πŸ’€

possible

(that's it. that's the whole section. she said "possible" and logged off. main character energy fr fr)


🩷 AUTHORS 🩷

Ko van der Sloot: lamasoftware@science.ru.nl


πŸŽ€ the sign-off πŸŽ€

this was folialint, version 2.0, dated 2020 sep 02 β€” a whole legend, honestly. go validate something, bestie. slay πŸ’–βœ¨πŸ¦‹