Skip to contents

Specification

Specifying the file identifier

The file identifier is specified as follows:

<!--[BOOKMARK-ID::value]-->

(where “value” is the identifier)

Identifiers must start with a letter and may only contain letters, digits, and underscores.

If omitted, the filename will be truncated to the portion before the first period (which will usually just remove the extension) and all characters other than letters, digits, and underscores are removed, and the result will be used as identifier.

General specification

<!--[BOOKMARK-START::YAML::lg1_1]
type: Learning Goal
content: >
  Dit is een leerdoel over
  bla bla bla dgdhdhd
  dhhdhd ddhhd hdhd hd hdhhd 
[BOOKMARK-END]-->

<!--[BOOKMARK-START::YAML::lg1_2]
type: Learning Goal
content: >
  Dit is een ander leerdoel over
  bla bla bla dgdhdhd
  dhhdhd ddhhd hdhd hd hdhhd
bloomType: knowledge
[BOOKMARK-END]-->

<!--[BOOKMARK-START::R::ib1_1]
### creeer hier een itembank cluster
result <- list(res,
               type = "Learning Goal",
               content = "bla bla");
[BOOKMARK-END]-->

Shorthand specification

For simple info, it’s possible to use a shorthand specification, which must always contain an identifier, a key, and a value. This will be parsed into an R object with the name of the key and containing the value, stored in the object for the specified identifier.

<!--[BOOKMARK::id::key::value]-->

Running functions

To run a function that can process the information in the produced object, the following fragment can be used.

<!--[BOOKMARK-START-FUNCTION::md4e_showLearningGoals]
bloomType: knowledge
[BOOKMARK-END-FUNCTION]-->

The function will always receive two arguments. The first, ‘x’, will be the object with information. The second, ‘id’, will be the identifier of the file from which the function is called. Additional arguments specified in YAML will be passed after that (in the YAML bit, therefore, ‘x’ or ‘id’ cannot be specified).

If no other arguments need to be passed, the following shorthand can be used:

<!--[BOOKMARK-FUNCTION::md4e_showLearningGoals]-->