Structure rule properties

Add & manage content

Platform_KC
Cloud

Structure rules define the properties applied to content. The properties include the number of times the content can or must be used, the content's location within the book or topic, and the objects or templates that can be used.

Topic Structure Builder

1

The Name is used to identify the rule and is displayed in the structure builder and the Editor's Rule tab.

2

The Description is used to briefly describe the rule's use. The description is only displayed in the structure builder.

3

Use the Sequence to define whether the content using this rule must occur at a fixed point in the structure, or if the position is variable.

4

Define the minimum number of times the content based on this rule must occur. Alternatively, choose 0 (zero) to make the rule optional.

Define the maximum number of times that content can or must occur. Alternatively, select Unlimited to remove restrictions on the maximum number of times the content is used.

5

Select the objects that validate for this rule. When you select a template you allow the author to use any object based on that template. Alternatively, add one or more objects to provide a limited selection.

Minimum and maximum occurrence

The occurrence attributes define the number of times the rule is used.

  • Rule has a set number of occurrences - set the same level for the minimum and maximum occurrences.
  • Rule has a variable number of occurrences - set a minimum number of times the rule must be used and the maximum number of times the rule must be used. The rule can be used any number of times between the two settings.
  • Rule has an unlimited number of occurrences - set the minimum number of times the rule must be used then select the Unlimited option. The rule can be used any number of times so long as it meets the minimum requirement.
  • Rule is optional - set the minimum to zero and set the maximum number of times the rule can be used. The rule can be used up to the maximum level set, or it can be omitted.
  • Rule is used to prohibit "inline" content within a paragraph - set both the minimum and maximum levels to zero. The content defined by the type of rule cannot be used (for example, you cannot use any images when the prohibit settings are applied using a file rule) .

Sequence

The sequence attribute defines the order that the rule is used in the topic.

  • Fixed rules must occur in the same order in the topic that they are added to the structure.
  • Flexible rules have a relationship to adjacent flexible rules in the same group and allow some variation in their order. To form a group, the flexible rules must be at the same level in the structure or fall between two fixed rules. These rules can occur in any order within that group.

Allowed objects

The objects that are allowed by the rule. If templates are included all objects based directly on the template are allowed. You can add templates, objects, or a combination of the two.

  • Choosing templates enables the author to assign any object based on that template. For example, by selecting the List Template authors can assign any of the list number, list bullet, list alpha, or list continue styles.
  • Choosing individual objects ensures only the selected objects can be assigned. You can select a single object, or provide the author with a limited number of options by selecting several objects.
  • Styles - when an author is working in a structured topic, the available styles are shown in the paragraph style drop-down list and toolbar. Only the paragraph styles added as allowed objects or the styles based on templates in the allowed object list are available in the structure. As with normal topics, authors only see the styles they have permissions to use.
  • If inline rules for character styles have not been created, then all character styles are available.