Viewing Local Style Suggestions

You can view the places in your project where you have used local formatting. The analysis tool suggests that you replace these instances of formatting with existing styles in your stylesheet that match the formatting that you have applied manually. This is different from a new style suggestion in the following way: With a new style suggestion, the properties in the tag do not match an existing style exactly; therefore, the analysis suggests that you create a new style. On the other hand, if you make formatting changes that happen to result in an exact match to all of the properties in an existing style, the analysis suggests that you replace the formatting with that style (rather than creating a new style).

Local formatting is a way to change the look and feel of content directly so that the changes are applied only to that specific content (as opposed to applying the changes throughout your project via the use of styles). Many tools are provided in Flare for editing and formatting topics directly in the XML Editor, without having to know XML at all. Simply open the topic that you want to format, and use the tool that suits your needs best. For example, if you want certain text to be bold, you can highlight the text and click the Bold button Bold text with local formatting. in the Text Format toolbar. This direct approach to formatting topics (sometimes called "inline" formatting) can be very attractive because it is quick and easy. However, it is recommended that you use style classes instead of local formatting whenever possible. Although local formatting is very convenient in the short-term, using style classes is much more efficient and can save you a great deal of time in the long-term.

How to View Local Style Replacement Suggestions

  1. Open a project.
  2. Do one of the following, depending on the part of the user interface you are using:
    • Ribbon Select Analysis > Suggestions > Replace Local Style Suggestions.
    • Analysis Summary Window Pane Double-click the row that mentions local style replacement suggestions.

    The Replace Local Style Suggestions window pane opens.

  3. To see more of the information in the window pane, drag the divider bar to make the pane wider.
    • Selector Displays the base tag(s) where the formatting is found in the topic (e.g., p, div, ul, li), followed by a period and the name of the style class that is suggested for you to use.
    • Properties Displays the formatting properties already set on the tag, which matches the formatting properties that you have applied manually.
    • File Displays the path and name of the file where the formatting is found.
    • Folder Displays the folder where the file is found.
  4. If a certain number of items have been found, page navigation buttons in the local toolbar may be enabled. You can use these buttons to go to additional pages to display more items. You can also click View All in the local toolbar to see all results on a single page. Keep in mind that the more items you have in the project, the longer it will take to load this view.

How to Replace Local Formatting With Existing Styles

  1. In the window pane, select all suggestions that you want to convert. If you want to select all rows click Click to select all rows.. You can hold the SHIFT key to select a range, or you can hold the CTRL key to select individual items.
  2. In the local toolbar, click the Apply button.
  3. In the message that opens, click OK. Another message lets you know how many files were changed.
  4. Click OK. All of the selected suggestions are converted to styles.

    Note If you want to undo the conversions, you can use the Backups window pane (View > Backups). See Restoring Backup Files.

What’s Noteworthy?

Note You can also include this information in reports that you create. See Reports.