Understand Dynamic Content, learn how to tag content, and how to create Dynamic Content Filters in Adobe FrameMaker. Understand how the Dynamic Content Filtering mechanism works with two example scenarios.
In Adobe FrameMaker, the Dynamic Content feature allows you to publish content that your users can easily filter based on parameters that you define. For example, you can create Dynamic Content Filters to filter content by region (e.g., “USA”, “CANDA” and “UK”), by audience (e.g., “Administrator” and “End User”) or by content delivery platform (e.g., “Web”, “App”, or “Print”). Dynamic Content also allows you to easily single-source content. To define filter criterion, you can use Conditional Tags or element attributes.
When you publish to Responsive HTML and Mobile App output, a filter tab is displayed that allows users to filter the contents based on the criterion selected. If the user applies a filter, the search limits the results to the filtered content.
Dynamic Content Filters can be applied to Responsive HTML5 and Mobile App outputs.
To create Dynamic Content Filters in your published output generated with Adobe FrameMaker, you need to tag your content with Conditional Tags or element attributes. Tagged content can then be filtered in the published output.
Unstructured content can be tagged with Conditional Text.
Structured content can be tagged with element attributes.
In DITA, you can use attributes like @audience
, @otherprops
, @platform
, @product
,
and @rev
.
You can apply multiple Conditional Tags to the same content. For example:
For one paragraph, create a Conditional Expression “USA AND CANADA” and then provide a filter criterion “North America” in the published output, which combines both.
For another paragraph with a variation of the same content, create a Conditional Expression “UK AND GERMANY” and then provide a filter criterion “Europe” in the published output, which combines both.
In the published output, a user then has the option to filter content based on the region. You could also create another Conditional Expression such as “US AND UK” to create a filter criterion titled “English Speaking Markets”.
Also, you can apply Conditional Tags to content in any combination. For this reason, you need to keep in mind how the output will display based on the output filtering mechanism. For an example of how filtering works, see Use Dynamic Content Filters in the published output.
When you use Dynamic Content Filters, you are not required to tag all your content. Any untagged content is regarded as unconditional. Unconditional content will always display to the user regardless of the filter applied.
You can create one dynamic filter for each content delivery channel.
To create a Dynamic Content Filter in Adobe FrameMaker, do the following:
Open the document, book, or DITA map that you want to publish.
Choose Publish panel.
to open theRight-click on the content delivery channel Responsive HTML5 or Mobile App and select Edit Settings from the context menu. The Publish Settings dialog is displayed.
In the Publish Settings dialog, select the tab General. Select Use Dynamic Content Filter in the output. Click Customize. The Dynamic Content Filter dialog is displayed.
In the Dynamic Content Filter dialog, click the Add New Group icon to create a filter criteria group.
Define a display name for this criteria group.
Click the Add Criteria icon to create a new filter criterion. Adobe FrameMaker automatically recognizes if you are editing the settings for unstructured or structured content.
For unstructured content, the Tags and Expressions dialog is displayed. The available Conditional Tags and Conditional Expressions are displayed.
Select the Conditional Tags or Conditional Expressions to include in the criteria group.
Click OK to close the Tags and Expressions dialog.
For structured content, the Select Conditional Attribute dialog is displayed.
Select one of the available element attributes from the Attribute drop-down list.
In the Attribute Value text field, define the attribute value that will be used to filter the content.
In the Display in Output as text field, define the name that will be displayed in the published output for this criterion.
Click OK to close the Select Conditional Attribute dialog.
Define if you want to filter content by default in the published output. To set the default filter criterion, right-click the filter criterion. Select Select by default.
To change the display name of a filter criterion or a filter criteria group, right-click on the display name. Select Rename from the context menu.
To allow your users to select multiple filter criteria, select Allow Multiple Selection in a Group.
Use the navigation arrows to move the filter criteria group groups and the filter criterion within a filter. For example, to move a filter criterion out of a group, click the left arrow. This moves the filter criterion to the same level as the containing group and just above the group. Use the right arrow to move a filter criterion that is outside any group into the available next group below it. You can also move the filter criterion up and down within one filter criteria group.
Click Save.
In the Publish Settings dialog, click Save and Close.
After you have defined a Dynamic Content Filter, you can generate the output.
The published output contains a filter icon in the function bar (navigation area). Click the filter icon to display the Dynamic Content Filters available.
To filter the contents, select the filter criteria groups or a specific filter criterion within a filter criteria group.
The following sections explain for two scenarios the possible results of applied filters to describe how the Dynamic Content Filtering mechanism works:
Select one criterion in a filter criteria group
In the “Region” filter, if you select “US”:
All content marked only with “US” displays.
All content marked with a combination of “US” and any other criterion displays.
Content marked with “US” and “UK” displays, but content marked only with “UK” is hidden. Also, content marked with “UK” and “CANADA” will be hidden.
All content marked with Conditional Tags or element attributes in the filter criteria group “Audience” is not displayed unless the content is combined with “US”.
Content marked with “US” and “PDF” will display. But content marked only with “PDF” is hidden. Also, content marked with the Conditional Tags “UK” and “Print” is hidden.
All untagged content displays.
Select one criterion in one filter criteria group and another criterion in a second filter criteria group
If you select “US” in the “Region” group and “Print” in the “Platform” group:
All content marked with only “US” displays.
All content marked with only “PDF” displays.
All content marked with any other Conditional Tag or element attribute or combination of other Conditional Tags is hidden.
All content marked with a combination of the Conditional Tags “US” and “PDF” displays.
Content marked with a combination of “US” with any other condition is hidden.
Content marked with a combination of “PDF” and any other conditional is hidden.
Content marked with “US”, “Print”, and “Online” displays.
Content marked with “US” and “Online” or “Print” and “Online” is hidden.
All untagged content displays.