Setting keys based on a variable

Oct 13, 2025 by pinkandtrash.com 44 views

Introduction

When working with LaTeX3, it's common to encounter situations where you need to set keys based on variables. This can be particularly useful when creating commands that retrieve data from a key-value structure. In this article, we'll explore how to set ltx3 keys based on a variable, and provide examples to illustrate the concept.

Understanding ltx3 keys

Before we dive into the details, let's briefly review what ltx3 keys are. In LaTeX3, keys are used to store and retrieve data from a key-value structure. Keys are typically defined using the cs_set function, which sets a key to a specific value. For example:

\cs_set:Npn \l_my_key ( #1 ) { #1 }

This code defines a key called \l_my_key and sets it to the value of the argument #1.

Setting keys based on a variable

To set a key based on a variable, you can use the cs_set:Npn function in combination with the tl_set:Nn function. The tl_set:Nn function sets a token list (tl) to a specific value, which can then be used to set the key.

Here's an example:

\cs_set:Npn \l_my_key ( #1 ) { #1 }
\tl_set:Nn \l_my_variable { Hans Meier }
\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }

In this example, we first define a key called \l_my_key and set it to the value of the argument #1. We then set a token list called \l_my_variable to the value "Hans Meier". Finally, we redefine the key \l_my_key to use the value of the token list \l_my_variable.

Using a command to set keys

To make the process of setting keys based on a variable more convenient, you can create a command that takes a variable as an argument and sets the key accordingly. Here's an example:

\cs_set:Npn \set_key:Nn #1 #2 { \cs_set:Npn \l_my_key ( #1 ) { \tl_use:N #2 } }
\set_key:Nn \l_my_variable { Hans Meier }

In this example, we define a command called \set_key:Nn that takes two arguments: a variable and a token list. The command then sets the key \l_my_key to use the value of the token list.

Retrieving data from a key-value structure

Once you've set a key based on a variable, you can retrieve the data from the key-value structure using the tl_use:N function. Here's an example:

\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }
\tl_show:N \l_my_key

In this example, we redefine the key \l_my_key to use the value of the token list \l_my_variable. We then use the tl_show:N function to display the value of the key.

Conclusion

In this article, we've explored how to set ltx3 keys based on a variable. We've shown how to use the cs_set:Npn function in combination with the tl_set:Nn function to set a key based on a variable. We've also created a command that takes a variable as an argument and sets the key accordingly. Finally, we've demonstrated how to retrieve data from a key-value structure using the tl_use:N function.

Example Use Cases

Here are some example use cases for setting ltx3 keys based on a variable:

Creating a command that retrieves data from a key-value structure
Setting keys based on user input
Creating a key-value structure that can be used to store and retrieve data

Code Snippets

Here are some code snippets that demonstrate how to set ltx3 keys based on a variable:

\cs_set:Npn \l_my_key ( #1 ) { #1 }
\tl_set:Nn \l_my_variable { Hans Meier }
\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }

\cs_set:Npn \set_key:Nn #1 #2 { \cs_set:Npn \l_my_key ( #1 ) { \tl_use:N #2 } }
\set_key:Nn \l_my_variable { Hans Meier }

\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }
\tl_show:N \l_my_key

Introduction

In our previous article, we explored how to set ltx3 keys based on a variable. In this article, we'll answer some frequently asked questions about setting ltx3 keys based on a variable.

Q: What is the difference between `cs_set:Npn` and `cs_set:Npx`?

A: cs_set:Npn and cs_set:Npx are both used to set a key to a specific value. The difference between them is that cs_set:Npn sets the key to a token list (tl), while cs_set:Npx sets the key to an e-TeX primitive (x). In general, you should use cs_set:Npn unless you have a specific reason to use cs_set:Npx.

Q: How do I set a key to a value that contains a backslash?

A: To set a key to a value that contains a backslash, you can use the tl_set:Nn function to set a token list (tl) to the value, and then use the cs_set:Npn function to set the key to the token list. Here's an example:

\tl_set:Nn \l_my_variable { \Hans Meier }
\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }

Q: How do I set a key to a value that contains a space?

A: To set a key to a value that contains a space, you can use the tl_set:Nn function to set a token list (tl) to the value, and then use the cs_set:Npn function to set the key to the token list. Here's an example:

\tl_set:Nn \l_my_variable { Hans Meier }
\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }

Q: How do I retrieve the value of a key that was set using `cs_set:Npn`?

A: To retrieve the value of a key that was set using cs_set:Npn, you can use the tl_use:N function to use the token list (tl) that was set to the key. Here's an example:

\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }
\tl_show:N \l_my_key

Q: Can I use `cs_set:Npn` to set a key to a value that contains a command?

A: Yes, you can use cs_set:Npn to set a key to a value that contains a command. However, you need to make sure that the command is fully expandable, meaning that it can be expanded without any side effects. Here's an example:

\cs_set:Npn \l_my_key ( #1 ) { \textbf{#1} }
\tl_set:Nn \l_my_variable { Hans Meier }
\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_variable }

Q: Can I use `cs_set:Npn` to set a key to a value that contains a conditional?

A: No, you cannot use cs_set:Npn to set a key to a value that contains a conditional. Conditionals are not fully expandable, meaning that they can have side effects when expanded. Instead, you should use a different approach, such as using a separate key to store the conditional value.

Q: How do I set a key to a value that depends on another key?

A: To set a key to a value that depends on another key, you can use the cs_set:Npn function to set the key to a value that depends on the other key. Here's an example:

\cs_set:Npn \l_my_key ( #1 ) { \ifcs_set:NpN \l_my_other_key { #1 } { #1 } }
\tl_set:Nn \l_my_other_key { Hans Meier }
\cs_set:Npn \l_my_key ( #1 ) { \tl_use:N \l_my_other_key }

Q: Can I use `cs_set:Npn` to set a key to a value that depends on a conditional?

A: No, you cannot use cs_set:Npn to set a key to a value that depends on a conditional. Conditionals are not fully expandable, meaning that they can have side effects when expanded. Instead, you should use a different approach, such as using a separate key to store the conditional value.

Conclusion

In this article, we've answered some frequently asked questions about setting ltx3 keys based on a variable. We've covered topics such as setting keys to values that contain backslashes, spaces, and commands, as well as retrieving the value of a key that was set using cs_set:Npn. We've also discussed how to set a key to a value that depends on another key, and how to use conditionals in key-value structures.