CIF_DDLM_DIC_CHECK(1)

πŸ“¦
version 3.12.0 Β· 2 versions
  • 3.12.0 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 3.4.0 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– CIF_DDLM_DIC_CHECK πŸ’–

okay bestie, gather round, because we're about to talk about cif_ddlm_dic_check β€” that's the section 1 general commands manual page, the one you pull up when you need to vibe check your DDLm dictionaries πŸ¦‹


✨ NAME ✨

cif_ddlm_dic_check β€” check DDLm dictionaries against a set of best practice rules.

like, it's literally a dictionary hall monitor. but make it cute. πŸŽ€


🌸 SYNOPSIS 🌸

cif_ddlm_dic_check --options cif_core.dic

πŸ’… DESCRIPTION πŸ’…

Check DDLm dictionaries against a set of best practice rules.

that's it, that's the whole job. it reads your dictionary, it holds up the best-practice checklist, and it tells you what's giving and what's not. πŸ‘‘


⭐ OPTIONS ⭐

  • --report-redundant-range-limits β€” report explicit range limits that match implicit range limits imposed by the content type. so if you wrote out a limit that the content type was already enforcing on its own, this calls it out. lowkey redundant, highkey reportable. πŸ™ˆ
  • --no-report-redundant-range-limits β€” do not report explicit range limits that match implicit range limits imposed by the content type. this one is the Default. 😌
  • --check-references-in-descriptions β€” check if the data names referenced in the free-text descriptions and usage examples of data items and categories are defined in the dictionary. this check uses ad hoc code to recognise data names and therefore might produce false-positive validation messages. so like... it's trying its best, but it is pattern-matching, so don't come for it when it gets a little overexcited. πŸ’€
  • --no-check-references-in-descriptions β€” do not check if the data names referenced in the free-text descriptions and usage examples of data items and categories are defined in the dictionary. also the Default. 🌈
  • -I, --add-ddlm-import-path './ddlm/cod/' β€” prepend an additional directory to the dictionary import path. the dictionary import path specifies a list of directories in which to look for files that are imported by DDLm-compliant CIF dictionaries. directories provided using this option are assigned the highest priority and are searched prior to the directories listed in the COD_TOOLS_DDLM_IMPORT_PATH environment variable or the default import path (directory of the importing dictionary). so yeah, this one jumps the queue. main character energy fr. πŸ”₯
  • --clear-ddlm-import-path β€” remove all directories from the dictionary import path that were added using the --add-ddlm-import-path option. neither COD_TOOLS_DDLM_IMPORT_PATH environment variable nor the default import path is affected by this option. it's a very targeted little reset, bestie β€” it only clears what you added. ✨
  • --help, --usage β€” output a short usage message (this message) and exit. the classic escape hatch. 🫢
  • --version β€” output version information and exit. know your era. πŸ’œ

🧚 ENVIRONMENT 🧚

  • COD_TOOLS_DDLM_IMPORT_PATH β€” a list of directories in which to look for the DDLm-compliant CIF dictionaries that are imported by other DDLm-compliant CIF dictionaries. list elements are separated by the colon symbol (':'). directories listed in COD_TOOLS_DDLM_IMPORT_PATH have a lower priority than those provided using the command line option (--add-dictionary-import-path), but higher than the default import path directory (directory of the importing dictionary).

so the priority order is giving: command line option on top πŸ‘‘, then COD_TOOLS_DDLM_IMPORT_PATH, then the default import path directory at the bottom of the pile. πŸ“


😭 REPORTING BUGS 😭

report cif_ddlm_dic_check bugs using e-mail: cod-bugs@ibt.lt

if it's acting up, tell the devs! they wanna know! don't suffer in silence, that's not the vibe. πŸ’–


ok so real talk, bestie: every flag, every default, every path and every env var on this page is here, untouched, no cap. the vibe is mine, the facts are theirs. 🧚✨

and that's the whole page!! CIF_DDLM_DIC_CHECK(1), section 1, General Commands Manual β€” go forth and validate, you absolute icon. slay. πŸ’…πŸ‘‘