The glossary is an html page built from the collection of turtle files.
The builder, found in ./builder, is written in node.
The turtle files follow SKOS. The turtle files require a bit of getting used to. If you have suggestions on editor support, add them here.
Definitions are recorded in turtle format, where the definition field supports markdown.
One definition per file.
In certain places, use camel case names. Treat acronyms, such as
HTTP or JSON, as single words. Thus the camel case of
"HTTP exceptions" is httpException and not HTTPException.
Files are named <camelCaseName>.ttl.
Each turtle file must include the two namespace prefixes as follows:
@prefix : <http://glossary.orcfax.io/#> .
@prefix skos: <http://www.w3.org/2004/02/skos/core#> .Use a template (look in ./templates) to ensure these appear or
copy and paste from a good example.
The name of the entity is :<camelCaseName>, matching the
filename.
Preferred labels are lower cased unless they never appear in
lowercase form. For example domain, and ITN.
Open a new file /content/<camelCaseName>.ttl.
Use a template (/templates/*) or copy the content of another
definition file to bring in the correct prefixes.
Add the new definition. Use markdown for styling and links.
Add additional W3C-SKOS properties as appropriate
(e.g. skos:related); the list of supported properties can be
found in .github/ISSUE_TEMPLATE/orcfax-glossary-entry.md.
Rebuild the site.
Submit a PR.
Nominate a reviewer.