Use text variables to make the content of your site homes, category homes, and portals dynamic.
| Info |
|---|
Text variables only work in modules developed by Refined. |
...
Text Variables
...
modules dynamic – for example to personally welcome a user to your intranet. They help you automatically updating wordings and phrases used in many places on your site and allow you to smoothly run a site in different languages.
You can use text variables in most places in Refined where you can add text: layouts, categories, modules, announcement banners, and more. Refined features default text variables, as well as the option to create your own custom text variables (available in Refined for Jira version 3.2 and up).
...
Default text variables
These out-of-the-box text variables are available by default.
Variable | Description | Introduced in version |
|---|---|---|
$username | The logged-in user’s username. |
|
$userfullname | The logged-in user’s full name. |
|
$userfirstname | The logged-in user’s first name. | 2.0 |
$sitename | The site’s name. | 2.0 |
$siteid | The site’s ID. | 2.0 |
$categoryname | The category’s name. | 2.0 |
$categoryid | The category’s ID. | 2.0 |
$servicedeskname | The service desk’s name. | 2.0 |
$servicedeskid | The service desk’s ID. | 2.0 |
Custom text variables
A custom text is one that you set up in your system. This lets you create even more dynamic content on your website and lets to create a dictionary for the language switcher.
Create a custom text variable
Go to the Refined Administration.
Click the Languages tab and scroll down to the Dictionarysection.
Click Add text variable.
Add the text variable’s name formatted as $variable$.
Add the text variable’s translation as the default value. If used together with the Languagesfeature, you can add translations for each language. When a user’s language is not included in this list, they’ll see the default value.
| Info |
|---|
When adding many different language values, copying the Default Value field can help speed up the process. It lets you easily start from the same value or even keeping it the same for this language without having to manually retype it. |
Filters
It’s possible to filter on empty/translated values and text/key search. You can also further filter the results by language or tags.
Tags
For each text variable you can add Tags. This can be done when creating the text variable or added in later. Tags are meant to be a tool to help you organize or group your text variables in whatever way you see fit.
When adding a custom variable, you can see multiple fields: one for the default value, and one per language you’ve enabled in Refined.
Examples
| Expand | ||
|---|---|---|
| ||
In this example, we translate a category called Help & info. After completing these steps, the category name will automatically be translated anywhere it appears on your site.
|
| Expand | ||
|---|---|---|
| ||
In this example, we create an announcement banner that notifies users of planned maintenance.
|
| Expand | ||
|---|---|---|
| ||
In this example, we add a text to the top of the Search Highlight to inspire visitors to search for help. The entered text will be a combination of text and a text variable.
|
Nest variables
It’s possible to nest one or more default variables within a custom text variable, for example:
$welcome$ = Welcome to $sitename, $userfirstname!
However, it is not possible to nest custom variables within one another. This means that the following would not work:
$first$ = coffee
$second$ = I like $first$
Note that in the Site Builder you can only use custom text variables that don’t nest any variables at all, or that nest one or more of the following variables:
Variable | Description | Introduced in version |
|---|---|---|
$username | The logged-in user’s username. |
|
$userfullname | The logged-in user’s full name. |
|
$userfirstname | The logged-in user’s first name. | 2.0 |
Scripted text variables
Custom text variables can execute small scripts, which lets you use them to display dynamic values or to add a condition to them. For example, you can create a $greeting$ text variable that says Good morning or Good afternoon depending on the time of day.
Syntax
Wrap your script in curly brackets: { script }. Everything within the brackets will be replaced by the script’s returned value. The script will be executed using a Function() constructor.
Examples
| Code Block |
|---|
$copyrightMessage$: "Copyright ACME {return (new Date()).getFullYear()}"
$greeting$: "{if ((new Date).getHours() < 12) { return "Good morning" } else { return "Good afternoon" }}" |
Limitation
The logic syntax works in every area of Refined where you can use default text variables, except in the Site Builder.
Import or export custom text variables
It’s possible to import and export your custom text variables. When exporting, a zip file is created containing one .properties file per language. You can import a whole zip file with multiple languages or single .properties language files.
| Note |
|---|
When importing a dictionary, all current keys are merged with new ones. Duplicates will be overwritten by the imported file. |
You can edit and create the files in whatever tool you see fit but it’s important that they are saved using UTF-8 encoding to ensure they are read properly upon importing. When the files are exported, any non-ascii characters are escaped and written as their unicode counterpart.