Viewing Snippet Suggestions

You can view content that matches existing snippets in your project, and you can quickly convert these occurrences to snippets. You can also double-click a row to open the topic in question, with the potential snippet content highlighted.

How to View Snippet 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 > Snippet Suggestions.

    • Analysis Summary Window Pane Double-click the row that mentions snippet suggestions.

    The Snippet Suggestions window pane opens.

  3. To see more of the information in the window pane, drag the divider bar to make the pane wider.
    • Suggestion Displays the suggestion that the analysis is making to you (i.e., "Replace with Snippet").
    • Snippet Path Displays the location in your project's Content Explorer where the snippet is found, as well as the name of the snippet (e.g., Resources/Snippets/NewSnippet.flsnp).
    • File Displays the path and name of the file where the content in question is found.
    • Folder Displays the folder where the file is found.
    • Xml Text Displays the exact XML tag structure of the content in question.
  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 Convert Suggestions to Snippets

Do one of the following, depending on whether you want to convert multiple suggestions to a snippet simultaneously, or if you want to convert only one snippet suggestion at a time.

To Convert Multiple Suggestions Simultaneously

  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 snippets.

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

To Convert One Suggestion at a Time

  1. In the Snippet Suggestions window pane, select the row that you want to convert to a snippet.
  2. You can either double-click on the specific row, or right-click on the row and select Open. The file opens with the suggested content highlighted.

  3. In Flare, insert the snippet (e.g., select Insert > Snippet).

    See Inserting Snippets for more information about inserting snippets.

What’s Noteworthy?

Note Keep in mind that in order for content to be found and included in the Snippet Suggestions window pane, it must match the tag of the existing snippet exactly. For example, let's say that your snippet is a paragraph within a div tag. If you simply type the same text as the snippet on a simple paragraph in a topic, that content will not be found as a snippet suggestion. However, if you were to place that paragraph within a div tag in the topic, then it would be found as a snippet suggestion.

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