Map Elements Attributes
Edit Map Element Attributes
Edit the attributes of an element in a map to manage its properties.
Chunk Attribute
When you specify a chunking attribute value, it overrides the default chunking behavior, which is to show each topic on its own page. For example, if you have a parent topic with several children, you can use the chunking attribute to specify if the topics appear on a single page or separate pages when publishing to Heretto Portal or HTML.
Here's an example map with some hierarchy:
When you publish this map with no chunking attribute applied, each topic is shown on its own page. This HTML example highlights this behavior.
When you publish this map with the to-content
value for the
chunking attribute applied to the parent topic, the parent topic and its children show as one page.
This is what a topic with the chunk="to-content"
attribute applied looks like in the Content Editor.
This PDF example highlights the behavior in the output.
You can apply the chunk
attribute to the map
element or elements inside a map, like topicref
. When you apply a chunk
attribute to a topicref, the chunking behavior applies only to the topic and any children of that topic. When you apply a chunk
attribute to a map, the chunking behavior is established for the entire map.
We recommend applying the chunk
attribute to topicref
elements in a map, instead of the map
element. When you publish a map to Heretto Portal, the structure of the map is ignored (expected behavior) and so are attributes added to the map
element.
Collection-Type Attribute
- Unordered
- Links generate from parents to children and from children to parents.
- Family
- Links generate from parents to children, from children to parents, and from sibling to sibling. Parent topic shows on a different page than children topics.
- Sequence
- Links generate from parents to children and from sibling to sibling in sequential order. Parent topic shows on a different page than children topics.
- Choice
- Links generate from parents to children and from children to parents, but where one child topic is selected to proceed.
Unordered Collection Type
If you're documenting unrelated items that don't follow a specific order, use an unordered collection type. For example, each topic is about a different aspect of a software that is unrelated to the others. In this map, Classic Software is the parent topic and the other topics are children of Classic Software:
When published the parent topic contains links to each of the children topics:
Each of the children contains a link to the parent topic, but not to one another:
Family Collection Type
In a family collection type, all items are related to one another. For example, you have a map discussing troubleshooting strategies for a printer. In this map, Printer Troubleshooting is the parent topic and each of the strategies are children of that parent topic:
When published, the parent topic contains links to each of the children topics:
Each of the children topics contains links to the parent topic and all related topics:
Sequence Collection Type
A sequence collection type is good for information that must be presented in a specific order. For example, you have a series of software installation tasks that need to be completed in order. In this map, Classic Software is the parent topic and each of the procedure topics are children of that parent topic:
When published, the parent topic contains numbered links to each of the children topics:
Each of the children topics contains links to the parent topic and to the previous and next topics in sequence:
Choice Collection Type
A choice collection type is good for information that requires you to choose from two or more options. For example, you are creating a new file in Classic Software and have the option to choose from a blank file, default template, or uploaded template. In this map, Creating a New File is the parent topic and each of the options for creating a file are children of that parent topic:
When published, the parent map contains links to each of the children topics:
Each of the children topics contains links to the parent topic, but not to one another: