Filter By Attribute

Elements in a structured document can have one or more attributes associated with them. Using FrameMaker, you can filter a structured document based on the value of these attributes. Other XML applications may also use the same attribute-value pair to filter the documents. In this way, single sourcing workflows can be preserved across other XML applications.

The Filter by Attribute feature simplifies the task of filtering a structured document for complex output scenarios. You define a filter using a Boolean expression containing attribute-value pairs. You can create multiple filters, save them, and use them for filtering a document based on different output scenarios.

When a filter is applied to the document, elements that have filter attributes that do not meet the filter criteria are filtered out. You can specify how the filtered out content is treated, as hidden, highlighted with a color, or applied with a condition tag. When an element is filtered out, all the child elements are also filtered out.

Each attribute can have more than one value defined, each with its own conditions, such as Equals To, Any, and Contains Only. You can provide a list of values with the delimiter that you defined for attribute settings.

The following table compares the Show/Hide feature using Conditional Text and the Show/Hide feature using Filter By Attribute.

A filter is defined by a Boolean expression of attribute-value pairs. You can build a filter using the Build Expression dialog box, which provides a simple interface to build the expression using Boolean operators. You can define attribute-value pairs using the Define Attribute Values dialog box. You can select multiple values for each attribute.

You can save a filter as a named expression. You can build and save multiple filter expressions in a structured document. However, you can apply only one filter at a time. The last filter you apply in a document is the active filter.

Use the Manage Attribute Expressions dialog box to manage the filters.

1. Select Special > Filter By Attribute. The Manage Attribute Expressions dialog box appears.

2. Click New. The Build Expression dialog box appears.

3. Enter a unique name for the filter in the Expression Tag field.

4. Select an attribute from the Attributes list.

5. Specify a value in the New Value field, and click Add. The new attribute value is included in the Defined Values list.

   If you want to remove a value, select it in the Defined Values list, and then click Delete. You can add multiple values to an attribute, each with its own conditions such as Equals To, Any, or Contains Only.

   Note: Attribute names are case-sensitive, but attribute values are not case sensitive.

6. Click Add Attribute to include the attribute in the Expression list.

   Note: Use the Clear button to delete all expressions in the Expression area.

7. Click a button to insert a Boolean operator in the expression. You can build a complex expression through the Boolean operators and multiple attribute-value pairs. Click Clear to clear the expressions built.

8. Click OK to close the Build Expressions dialog box. The new expression is added to the Manage Attribute Expression dialog box. Click OK to complete the procedure.

You can import the Filter By Attribute settings that you defined in a structured document to other structured documents. The properties of the filter include the following:

• Filter expressions. The filter expressions that you created in the source document.

• Attribute values that are defined in the filter. Each attribute can be more than one values.

• The Show Per Expression state. For example, if your source document has many filters defined, but when these filters are imported to target documents, the first filter is chosen for Show Per Expression, the same settings are applied to the target documents.

When you import filters, the attribute values in the source documents are added to the attribute values in the target documents. If attributes in the target documents already have some values, the imported values are appended to them. FrameMaker reports an error if the target documents do not have attributes present in the filter expressions in the source document.

1. On the document window, select File > Import > Formats.

2. On the Import Settings dialog box, deselect all options, and then select Filter By Attribute.

3. In the Import From Document pop-up menu, select the source document that is open.

4. Click Import.

Use the following instructions to apply a filter you have created to your structured document.

1. Select Special > Filter By Attribute. The Manage Attribute Expressions dialog box appears.

2. Select Show As Per Expression to preview the elements that satisfy the filter when it is applied to the document.

   Note: If you select the Show All option, then the active filter, if any, is disabled, and all elements in the document are available for viewing and editing in FrameMaker. Also, any conditional text that is hidden appears. You can’t undo the Show All operation.

3. Select a filter in the list.

4. In the Filtered Text option, select how the content that does not meet the filter conditions should be treated. You can choose from the following:

   • Hide the content that is filtered out

   • Preview the filtered out content with a specified color.

   • Apply a condition tag to the filtered out content. In addition, you can also remove any condition tag already applied to the filtered out content.

5. Click Apply.

   Note: You can’t undo the Apply command after applying a filter.

When you save a document as a FrameMaker or MIF file, all filters using attribute values, including the filter you have applied to the document, are saved. The attribute values you have defined for this feature are also saved.

Use the following steps to modify a filter:

1. Select Special > Filter By Attribute. The Manage Attribute Expressions dialog box appears.

2. Select a filter from the list.

3. Click Edit. The Build Expression dialog box appears.

4. Modify the filter in the Expression area.

5. Click OK to close the Build Expression dialog box.

The modified content of the filter appears in the Selected Expression area of the Manage Attribute Expressions dialog box.

Use the following steps to delete a filter:

1. Select Special > Filter By Attribute. The Manage Attribute Expressions dialog box appears.

2. Select a filter in the list.

3. Click Delete.

4. If the filter you are deleting has been applied to the document, FrameMaker displays a message indicating that the selected expression is currently applied to the document. Click OK.

5. Click OK to confirm the deletion.

6. Click Done to close the Manage Attribute Expressions dialog box.

You can disable the option of applying a condition tag to content filtered with a Filter By Attribute option.

 Set ApplyAsCondition=Off in the maker.ini file.

Note: Use caution when editing an ini file.