The converter's command line, across every format this artifact reads.
Converting an ontology is a one-off, and it is the point of the whole repo: a
reader is finished the day its corpus has been converted once into the format vaelii
writes. So the CLI is one verb per thing you do to a corpus, and the format only
appears where it has to. -main's docstring is the usage text a run prints; the
README has the worked examples.
load takes no format. Every converter here writes the same corpus
(vaelii.foreign.corpus), so loading one is format-independent: all the format decides
is which profiles the --profile name is looked up in, and the corpus says which it
is in its own meta.edn.
Nothing here is required by the readers: this namespace depends on all five and none of them depends on it, so the plugin seam still loads exactly the one namespace whose format was asked for.
The converter's command line, across every format this artifact reads. Converting an ontology is a **one-off**, and it is the point of the whole repo: a reader is finished the day its corpus has been converted once into the format vaelii writes. So the CLI is one verb per thing you do to a corpus, and the format only appears where it has to. `-main`'s docstring is the usage text a run prints; the README has the worked examples. **`load` takes no format.** Every converter here writes the same corpus (`vaelii.foreign.corpus`), so loading one is format-independent: all the format decides is which `profiles` the `--profile` name is looked up in, and the corpus says which it is in its own `meta.edn`. Nothing here is required by the readers: this namespace depends on all five and none of them depends on it, so the plugin seam still loads exactly the one namespace whose format was asked for.
(-main & [cmd a b c & more])convert <format> <source> <out-dir> [flags] write a corpus load <corpus-dir> <kb-dir> [--profile <name>] load one into a disk KB report <corpus-dir> print a written corpus's report diff <corpus-dir> <corpus-dir> [--edn] what one says and the other does not formats what can be read, and from what
flags: --limit n, --functional, --context <Name>, --languages en,fr, --no-n-ary, --no-word-forms, --no-node-text, --no-entailment-rules
what a reader filters out by default, and the flag that keeps it anyway:
--obsolete obo: terms the ontology has retired
--editorial cyc: sharedNotes, myCreationPurpose — the KB editors' notes
--code-rules cyc: rules Cyc implements in SubL but states in full anyway
--empty-tails atomic: rows whose tail is the none annotation
--languages rdf: which language-tagged literals survive
convert <format> <source> <out-dir> [flags] write a corpus
load <corpus-dir> <kb-dir> [--profile <name>] load one into a disk KB
report <corpus-dir> print a written corpus's report
diff <corpus-dir> <corpus-dir> [--edn] what one says and the other does not
formats what can be read, and from what
flags: --limit n, --functional, --context <Name>, --languages en,fr,
--no-n-ary, --no-word-forms, --no-node-text, --no-entailment-rules
what a reader filters out by default, and the flag that keeps it anyway:
--obsolete obo: terms the ontology has retired
--editorial cyc: sharedNotes, myCreationPurpose — the KB editors' notes
--code-rules cyc: rules Cyc implements in SubL but states in full anyway
--empty-tails atomic: rows whose tail is the `none` annotation
--languages rdf: which language-tagged literals survive--flag -> [option value] for the flags that are just present or absent.
A :filtered drop is one this table can reverse, and that is what the kind means
rather than a description of it: a reader declining to import an obsolete term, an
editorial note or a language nobody asked for has made a policy decision on somebody
else's behalf, and the person converting the ontology gets to disagree. Each reader
names the option that reverses each of its filtered drops in :drop-flags, and
plugin-test/every-filtered-drop-is-either-reversible-or-explained is what keeps the
two tables from drifting.
`--flag -> [option value]` for the flags that are just present or absent. A **`:filtered` drop is one this table can reverse**, and that is what the kind means rather than a description of it: a reader declining to import an obsolete term, an editorial note or a language nobody asked for has made a policy decision on somebody else's behalf, and the person converting the ontology gets to disagree. Each reader names the option that reverses each of its filtered drops in `:drop-flags`, and `plugin-test/every-filtered-drop-is-either-reversible-or-explained` is what keeps the two tables from drifting.
<format> -> {:reader :corpus-format :source}, the CLI's own registry.
It is deliberately not read from resources/vaelii/foreign.edn: that manifest tells
the engine which kinds it can load, keyed by the kind an engine call site asks
for, while this table is what a person types and carries the prose that goes with it.
Two audiences, two tables, and the plugin test keeps the reader vars in step.
`<format> -> {:reader :corpus-format :source}`, the CLI's own registry.
It is deliberately *not* read from `resources/vaelii/foreign.edn`: that manifest tells
the **engine** which kinds it can load, keyed by the kind an engine call site asks
for, while this table is what a person types and carries the prose that goes with it.
Two audiences, two tables, and the plugin test keeps the reader vars in step.Every option key a command line can set — the vocabulary a reader's :drop-flags is
allowed to name.
Every option key a command line can set — the vocabulary a reader's `:drop-flags` is allowed to name.
--flag -> [option parse] for the flags that take the next argument.
--context is spelled through term/spell like any other context name, rather than
interned as typed. A context name becomes a file name inside the corpus, and this is
the one context name a person supplies rather than a reader mints — so it goes through
the same alnum-only spelling every minted one does. An already-spelled name keeps its
spelling: spell appends the Context ending, so a trailing one is dropped first and
Zoo, zoo and ZooContext all name ZooContext.
`--flag -> [option parse]` for the flags that take the next argument. `--context` is spelled through `term/spell` like any other context name, rather than interned as typed. A context name becomes a file name inside the corpus, and this is the one context name a person supplies rather than a reader mints — so it goes through the same alnum-only spelling every minted one does. An already-spelled name keeps its spelling: `spell` appends the `Context` ending, so a trailing one is dropped first and `Zoo`, `zoo` and `ZooContext` all name `ZooContext`.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |