Skip to content

Metadata

Practice Set metadata appears near the beginning of a Kx Markdown Practice Set and describes the set as a whole.

A typical Practice Set begins with metadata such as:

[uuid:dbe9d9f6-7216-46c4-bfc9-e416a2d6ad39]
[id:konnexavida-object-visual-test]
[cat:visual-test-a, object, visual, Konnexavida]
[title: "Object Visual Test"]

Metadata is separate from the content being practiced.

[uuid:dbe9d9f6-7216-46c4-bfc9-e416a2d6ad39]

The UUID uniquely identifies the Practice Set.

See UUID for details.

[id:konnexavida-object-visual-test]

The ID provides a human-readable identifier for the Practice Set.

See ID for details.

[title: "Object Visual Test"]

The optional title provides display text for the Practice Set.

The title and ID serve different purposes. The ID is an identifier, while the title can provide a more natural name for presentation.

See Title for details.

[cat:visual-test-a, object, visual, Konnexavida]

Categories associate the Practice Set with one or more organizational labels.

Multiple categories are separated by commas.

See Categories for details.

A typical Practice Set places its core metadata at the beginning:

[uuid:...]
[id:...]
[cat:...]
[title: "..."]

The Practice Set’s context and practice content follow the metadata:

[uuid:...]
[id:...]
[cat:...]
[title: "..."]
[context]
Supporting information for the Practice Set.
[/context]
- Practice content
- More practice content

Not every Practice Set needs every optional metadata field.

For example, a Practice Set can have the core identifying metadata without a title:

[uuid:52c39371-0b3c-4ea5-9373-09687c8270f0]
[id:computer-internet-vocabulary]
[cat:ch2-3, computer, technology, internet, classroom, vocabulary]
[context]
Vocabulary for using a computer and navigating the Internet.
[/context]
- navegar por la red/Internet
- la computadora
- buscar

Some Kx Toolbox features can add additional Practice Set-level metadata.

Those fields are documented with the features they control rather than being treated as part of the core metadata model.

This keeps the basic Practice Set structure small while allowing richer Practice Sets to add capabilities when needed.

Kx Markdown v0.2.0