• All Files

Viewing New Style Suggestions

You can view the places in your project where you have used local formatting. MadCap Analyzer suggests that you convert these instances of formatting to new styles. You can use the Create New Style dialog to do just that. You can also double-click a row to open the file where the formatted content exists.

Local formatting is simply 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 easy-to-use tools are provided in Analyzer for editing and formatting topics directly in the XML Editor to give them the look and feel you want, 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 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.

Closedhow to view new style suggestions
  1. Open a project.

  2. Do one of the following, depending on the part of the user interface you are using:

    • Ribbon Select the View ribbon. In the Dynamic Reports section, select New Style Suggestions.
    • Analyzer Summary Window Pane Double-click the row that mentions new style suggestions.

    The New Style Suggestions window pane opens, listing all of the new style suggestions for the project.

  3. To see more of the information in the window pane, drag the divider bar to make the pane wider:
    • Selector Displays the parent tag(s) where the formatting is found in the topic (e.g., p, div, ul, li).
    • Properties Displays the formatting already set on the tag (including the local formatting that you may have applied to the content).
    • File Displays the name of the file.
    • 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 also have the option to view all items at once in one long list. This is called the View All option. You can toggle these views by clicking the View All/View as Pages button in the local toolbar. The button displays the opposite of whatever view is currently activated (e.g., If the View All option is currently active, the button shows View as Pages to indicate that if clicked, the button will switch the window pane to the View as Pages option).

Closedhow to convert suggestions to new styles
  1. In the New Style Suggestions window pane, select the row that you want to convert to a new style.
  2. In the local toolbar, click the Create Style button. The Create New Style dialog opens.
  3. In the Stylesheet field, select the stylesheet where you want to create the new style.

  4. In the Class field, type a name for the new style class.

    example

    If you have selected a row based on the p style and you type YellowBackground in this field, a new class called p.YellowBackground will be created.

  5. Click OK.
  6. If a message displays, stating that the backups folder is not empty, click OK to empty the folder and continue.

  7. Another message lets you know how many files were changed. Click OK.

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

Closednote

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