Space-specific variables
Space-specific variables provide a flexible and efficient way to manage reusable text across your documentation. By defining variables and specifying their scope, you can ensure consistent and accurate information is presented to your audience. Use the Dynamic Components tab to create and manage these variables, and insert them easily into your documents with the {{ shortcut. This feature is essential for maintaining high-quality and uniform documentation.
Reusable variables are short pieces of text that you can define once and use multiple times across your content. This feature ensures that common terms, phrases, or pieces of information remain consistent throughout your documentation. By defining a variable once, you eliminate the need to manually update text in multiple locations whenever a change is necessary.
To create a space-specific variable, follow these steps:
Navigate to the bottom menu of the left navigation panel
- Go to the Dynamic Components
- Select the Variables option tab.
Insert a Name for Your Variable:
- In the variables section, input a unique name for your new variable. This name will be used to reference the variable throughout your documentation.
Define a Global Value:
- Set a global value for the variable. This value will apply to all spaces within your documentation unless otherwise specified.
Add a Target Space Audience:
- If you want the variable to be specific to certain spaces, you can add a target space audience. This means the variable will only apply within the specified spaces, allowing for more tailored content.
Once you have created your variables, using them in your documents is straightforward:
- Insert the Variable:
- While editing your document, type {{
- Select a Variable:
- A menu will appear, displaying all available variables. You can filter through this list to find the specific variable you need.
- Select the desired variable from the menu to insert it into your document.
By leveraging space-specific variables, you can maintain consistent terminology and information across different sections of your documentation while also allowing for customization where needed. This not only streamlines the content creation process but also enhances the overall quality and coherence of your documentation.
