Interpolatiekeys voor het aanpassen van tekst- en systeem-e-mailsjablonen

Documentatie Sitebeheer
1

:bookmark: This guide provides a detailed overview of interpolation keys used for customizing text and system email templates in Discourse.

:person_raising_hand: Required user level: Administrator

While Customizing text in Discourse or Customizing specific email templates you may have noticed that there are placeholder variables available in some templates.

In Discourse we call these Interpolation Keys.

Understanding interpolation keys

Interpolation keys are placeholders available in certain Discourse templates. They allow you to insert dynamic content into your text and email templates.

Example of Interpolation Keys for the Account Created email template:

image
image1705×681 59.3 KB

These keys, such as %{username} or %{site_name} , will be replaced with actual data when the email is sent.

In general, these placeholders can be moved around within the template they belong to, but they are only available in that template and cannot be moved around to different templates, as they are all backed by server code that’s tied to the corresponding template.

However, certain template groups allow additional interpolation keys to be added beyond those already present in the default template.

Additional Interpolation Keys

Welcome User System Message

For system_messages.welcome_user templates, you can add these additional keys:

  • username: The username of the user
  • name: The full name of the user
  • name_or_username: Either the user’s full name or username

These values are provided by the SystemMessage class at runtime (See system_message.rb for the related Discourse code).

User Notification Emails

For user_notifications and related email templates (including unsubscribe_mailing_list and unsubscribe_link), many additional keys are available, including topic_title, username, site_name, url, unsubscribe_url, and others.

For the complete and up-to-date list of all allowed custom interpolation keys and which template groups they apply to, refer to the ALLOWED_CUSTOM_INTERPOLATION_KEYS in the Discourse source code for translation_override.rb.

Last edited by @SaraDev 2024-07-26T20:16:22Z

Check documentPerform check on document:
9 likes
Template Interpolation Key Usage
Email notification template GUI complains about %{base_url}
Customizing specific system email templates
The following interpolation key is invalid: name
`admin/customize/email_templates` page should include brief documentation of those templates
2

That’s not correct. Currently that works only for system_messages.welcome_user, but we could extend it to all other keys. This is pr-welcome material.

4 likes
3

Thanks for pointing that out, this has been updated in the guide.

2 likes
4

Hi!

How can I modify the value for some of these interpolation keys? For instance, %{search_answer}

Thanks!

5

Hi!
It says that this key is not valid:

image
image925×819 42.9 KB

P.S.
I’m replacing in text not email (does it make a difference)? Thanks!

6

I don’t think those are global and free to use everywhere.

1 like
7

Thanks @Jagster ! I’m using them in the text customization so based on the topic post, it’s supposed to work?

8

Topic is actually about email templates and those texts. So, you can’t use interpolations keys outside right context. That’ts why we have other keys for emails, other for some AI prompts etc.

Sure, plugins can do a lot of things, but this time not out of the box.

And disclaimer: I’m just another end user and I can be horrible wrong too. But I’m quite sure I’m right — and that’s why your try doesn’t work :man_shrugging:

9

Okay, thank you so much for your support. It looks like it’s not working even in used in an email template:

image
image822×479 19.7 KB

10

My bet is you can use %{username} in ”User did…” templates, and all other templates don’t support it.

But we’ll see tomorrow when all gurus are waken.