Variable Warehouse Maps
Variable warehouse maps contain variable content that you can reuse through keyword elements and keyref attributes.
Number of Variables Warehouse Maps
Depending on the size of your documentation set and the amount of the variables that you use in it, you can either create a single variable warehouse map or multiple variable warehouse maps.
The following example illustrates a single variable warehouse map that contains variables of different categories. This approach is sufficient if you maintain a limited amount of documentation. Maintaining a large variable set may slow down variables processing and makes it difficult to search for variables.
Global Variables Strategy
You can include variable warehouse maps in the global shared map so that they are available in every deliverable map that you create in Heretto CCMS. For more information, see Shared Maps.
The following example illustrates the same variables as in Single Variable Warehouse Map divided into content-specific variable warehouse maps.
This approach is recommended if you maintain a large amount of documentation.
Context-Specific Variables Strategy
Using content-specific variables enables you to reuse more topics.
- The “Classic Variables Warehouse” map is added to the “Classic Toaster” map
- The “Lightning Variables Warehouse” map is added to the “Lightning Toaster” map
- Both maps reuse the following topics:
<keyword keyref="vars/product_name"/> OverviewSafety Notes from <keyword keyref="vars/company_name"/>Toasting Bread with <keyword keyref="vars/product_name"/>
- The
Defrosting Bread with <keyword keyref="vars/product_name"/>topic is used only in the “Lightning Toaster” map
Guidelines
Keep the following guidelines in mind when working with variable warehouse maps:
- Keep the variable warehouse maps in a dedicated folder in the content library. For example, keep them in the _shared folder.
- Assign meaningful and consistent
@keysattribute values to the variables. This way, each author will be able to easily add a variable in the Content Editor.For example, you can assign the following
@keysattributes: product_a_name, company_name, or admin_interface.