Reuse Mechanisms
Best Practices
The Basics
Choose your Weapon (s)
100

Reuse this item by referencing it in any number of maps.

What is a topic?

100

Store content for reuse in these files.

What are Collection Files?

100

Always set this attribute on an element when you intend to reuse the content.

What is @ID?

100

You need to publish a document and change all mentions of the product name in each output. 

What is Keys? You would define a key in the map, and then reference it with @keyref.

For example, the "Product_Name" key is defined in the map with one value, such as DeviceConX. To reference the key, you insert a <ph> element with @keyref set to "Product_Name". In the output, the product name of DeviceConX is inserted.

200

This attribute inserts content via direct reference to a specific element in another topic. 

What is @conref?

200

Always reuse whole sentences to support this step in the document lifecycle.

What is translation?

200

Keys are defined in this Info Type

What is Map (or Bookmap)?

200

Over 50% of a topic's content consists of content that is unique to a specific condition. 

What is a collection file with a conref?

300

Inject content from a source topic into another topic. You won't need to touch the destination topic to do this.

What is conref push?

300

To support reuse, avoid inserting this element in your topics. Use relationships established by your map instead.

What is <xref>? (Cross references)

300

These conditional processing attributes allow you to filter content based on their values.

Example:

"Include or exclude all content with this attribute = this value in my output."

What are @audience, @product, and @platform?

300

A car manufacturer produces manuals that are distributed to various regions, which need to be customized by the local car dealers before publishing. The local dealer uses this mechanism to insert specific content without modifying the manufacturer-supplied content.

What is conref push?

400

Create variables in your document, which you can then use to create multiple outputs by changing their values.

What are Keys?

400

If a version of the content DOES NOT exist under all conditions, use conditional processing attributes. If the content DOES exist for all conditions (though it is slightly different), use this mechanism instead.

What are Keys!

400

Create an indirect reference to an existing topic or element with this attribute.


Hint: @conref inserts a direct reference.

What is @conkeyref?

400

You have a topic that you'd like to use twice in the same map. Once with one set of variable values, and a second time with a different set of variable values. Which mechanism can you use to accomplish this?

What are Key Scopes!
500

Reuse the same content that is profiled in multiple ways within the same publication, each time using a different filter.

What is Branch Filtering?

500

True or False: You can only use one method of reuse in a topic.

What is False?

500

You can use this special file to control the filtering or flagging of profiled content in the output, or to identify which values are to be used for conditional processing during a particular output.

What is a Ditaval filter file?

500

You need to insert a custom screenshot for each customer upon output. Nothing else about the output will change. 

You anticipate the addition of multiple customers with each release. Choose a scalable method.

Create a map with a list of image keys. Profile the content so that the key values (and therefore the image) changes for each customer output.