Context maps and assignment maps

Both context maps and assignment maps specify the map to use to resolve key-based references in a topic.

You can use keys to reference other objects or to include standard text strings in topics. A key is like a variable; you define the variable in a map and then you use it in a topic. For example,

<title>Log into <ph keyref="product-name"/></title>

The title of this topic references a key named "product-name". In all maps that use this topic, there is a corresponding key definition named "product-name" with a value such as "WidgetPro".

When you open the topic with a map in context, the "product-name" key can be resolved so that you see "Log into WidgetPro" as the title of the topic. If you open the topic without a map in context, you see this as the title of the topic: "Log into [product-name]".

Missing key definitions do not just create missing text. You can reference images, conrefs, or cross-references with keys as well, so missing key definitions in those cases can cause a topic to appear to have quite a lot of missing information. Therefore, to ensure you are seeing all the content of a topic, you should always choose a context map when editing a topic.

Context maps are always important but they are especially essential when working in a DRM environment because all references are done with keys.

When you open a topic from within a map, that map is automatically chosen as the context map. If you search for and open a topic on its own, you need to select a context map. Because a topic can be used in multiple maps, you might have several maps to choose from. Choose the one that aligns with the content and context for your current task. See Select a context map.

If you open a topic and change your mind about the best context map, or if you forget to select one when opening the topic, you can select or change the current context map of an open topic using the Details panel in Topic Editor.

Assignment maps

An assignment map is a context map associated with an assignment. For example, when Writer A assigns a topic to Writer B for a peer review, they choose the appropriate context map for the assignment. This becomes the assignment map.

Writer A can't necessarily depend on Writer B to know the appropriate context map, so pre-choosing the context map for the assignment ensures that Writer B sees the content exactly as Writer A intends, which is especially important for topics that are shared among multiple maps.

When Writer B opens the assigned topic, the assignment map automatically becomes the context map.