When you set up a review, you define the settings for the book to use a specific variant criteria value. Any variant objects used by the book that match the variant value selection are used in the review. The review settings enable you to select one value for each variant criteria that is relevant to the content you want to review.
Selecting variant values for the review
The variant values in the Review form add variant topics to a review.
When you select the book for the review, variant criteria groups that have been used by content in the book appear in the variant selection list.
To add the variant values, expand the variant criteria group, then select the check box next to a value.
- Variant book: When you have created a variant of a book object, the variant book appears in the review if it matches the criteria selected. Otherwise, the primary book appears in the review.
- Variant topics: When you have created a variant of a topic object, the variant topic appears in the review if it matches the criteria selected. Otherwise, the primary topic shows in the contents.
For more information, see Variants in the Reviews Module - Substitutions and Fall-back Paths.
This screenshot shows the X1000 User Guide book added to the review, and Software Release 1.2 selected as the variant criteria value.
When you display the book in the Reviews module, any variant topics matching the criteria appear in the book's contents. Topics that are actively in the review - that is, they have the review release state assigned - appear with black heading text in the TOC pane, and any topics not actively in the review that do not have the release state assigned appear with gray heading text in the TOC pane.
Using the release state for the review
Each review has a designated release state for the review stage. The review release state should only be assigned to content that you want to include in the review.
When you are including variants in a review, make sure you assign the designated release state to any variant topics that must be included in the review. There is no requirement for the variant's primary object to have the review release state assigned.
Objects in this book that are included in the review (active and inactive objects)
Objects included in the review are shown as inactive - with gray header text. When the object has the review release state assigned it becomes active - with black header text - and can have suggestions and comments added.
- (Active) Variant topics that match the variant criteria value (or values) selected and are in the review release state.
- (Inactive) Variant topics that match the variant criteria value but are not in the review release state.
- (Active) Ordinary topics (with no variants) in this book that are in the review release state.
- (Inactive) Ordinary topics (with no variants) that are not in the review release state.
- (Active) Primary topics - if their variants do not match the selection in the Review form - if the primary topic is in the review release state.
- (Inactive) Primary topics - if their variants do not match the selection in the Review form - that are not in the review release state.
Objects that are not included in the review
- Any variant topics that do not match the criteria values selected.