How to `include` a data structure?

[Roland_Schatzle]

I’m passing a glossary (for glossarium) to a template (via the parameter glossary). The glossary is basically an array of arrays. If I pass it verbatim as in the following example, it works fine:

glossary: (
  (
    key: "Vulnerability",
    description: "A Vulnerability is a flaw in a computer system that weakens the overall security of the system.",
  ),
  (
    key: "Patch",
    description: "A patch is data that is intended to be used to modify an existing software resource such as a program or a file, often to fix bugs and security vulnerabilities.",
  ),
)

But as glossaries may become large, I would like to put it in a separate file. If I try to include that file as follows, things don’t work any more (i.e. Typst doesn’t recognize the file content as an array of arrays):

glossary: include "myglossary.typ"

myglossary.typ contains:

 (
  (
    key: "Vulnerability",
    description: "A Vulnerability is a flaw in a computer system that weakens the overall security of the system.",
  ),
  (
    key: "Patch",
    description: "A patch is data that is intended to be used to modify an existing software resource such as a program or a file, often to fix bugs and security vulnerabilities.",
  ),
)

I assumed include would just replace the file content 1:1. But obviously it doesn’t . So, how can I achieve this?

[Andrew]

Please follow the forum guidelines How to post in the Questions category and update your post.

@reknih

Here are a few examples for titles you should avoid:

• hi peple, I want to write my resumme in typst
  This post title shows what the post author is looking for. However, it does not contain a concrete question on what they need help with. It also contains multiple spelling mistakes. Put effort in your posts, so community members will be more compelled to put effort in helping you.

@reknih

If your question pertains to a bit of Typst markup you have problems with, put it in the question body! You can syntax-highlight Typst code by wrapping it in ` ```typ … ````. It will then look like this:

#set font(size: 12pt)

Hello from *Typst* at $ pi.var + 1 $ o'clock!

If you need to highlight a code or math mode snippet instead, the language tags typc and typm do that, respectively.

[aarnent]

The problem is that using include returns content, and also that your file currently contains content (not data).

The easiest fix is to store the data in a variable inside myglossary.typ and import it (not include):

// myglossary.typ
#let glossary = (
  (
    key: "Vulnerability",
    description: "A Vulnerability is a flaw in a computer system that weakens the overall security of the system.",
  ),
  // ...
)

and

// main.typ
#import "myglossary.typ": glossary
#myfunc(glossary: glossary)

If you really way to use “inline imports” for some reason, you can use eval to turn content back into data:

// myglossary.typ
#(  // Note the "#"!
  (
    key: "Vulnerability",
    description: "A Vulnerability is a flaw in a computer system that weakens the overall security of the system.",
  ),
  // ...
)

and

// main.typ
#myfunc(glossary: eval(
  (include "myglossary_inline.typ").text
))

[Roland_Schatzle]

Ah thank you very much, that helps!