Vocabulary metadata
Factor handbook > The language > Vocabulary loader

Prev:Vocabulary roots
Next:Vocabulary icons


Vocabulary directories can contain text files with metadata:
authors.txt - a series of lines, with one author name per line. These are listed under Vocabulary authors.
platforms.txt - a series of lines, with one operating system name per line.
resources.txt - a series of lines, with one file glob pattern per line. Files inside the vocabulary directory whose names match any of these glob patterns will be included with the compiled application as Deployed resource files.
summary.txt - a one-line description.
tags.txt - a series of lines, with one tag per line. Tags help classify the vocabulary. Consult Vocabulary tags for a list of existing tags you can reuse.

Words for reading and writing summary.txt:
vocab-summary ( vocab -- summary )

set-vocab-summary ( string vocab -- )


Words for reading and writing authors.txt:
vocab-authors ( vocab -- authors )

set-vocab-authors ( authors vocab -- )


Words for reading and writing tags.txt:
vocab-tags ( vocab -- tags )

set-vocab-tags ( tags vocab -- )

add-vocab-tags ( tags vocab -- )


Words for reading and writing platforms.txt:
vocab-platforms ( vocab -- platforms )

set-vocab-platforms ( platforms vocab -- )


Words for reading and writing resources.txt:
vocab-resources ( vocab -- patterns )

set-vocab-resources ( patterns vocab -- )


Getting and setting arbitrary vocabulary metadata:
vocab-file-contents ( vocab name -- seq )

set-vocab-file-contents ( seq vocab name -- )