Document Designer Search
Overview
Admins can use the Search field, in the Properties panel of the Document Designer, to search for characters, words, phrases, and so on in a Document Designer template.
In addition to what can be found by a browser search, Document Designer search functionality will also search Elements in Layouts that are collapsed in the Template Flow. With this functionality, the entire template is always searched, even if some parts of it are not visible to the user.
Administration
What Can Be Searched
The following table describes which Elements and template components can be searched:
| Text* |
x |
x |
x |
| Heading* |
x |
x |
x |
| Table of Contents Title |
x |
x |
x |
| Inline XSL Snippet* |
x |
x |
|
| Global XSL Snippet |
x |
x |
|
|
File Paths of Embedded Documents
(displayed file path only)
|
x |
x |
|
*Applies to Elements both inside and outside of Table cells
- Plain Text Search – Type of Search executed when the Search Attributes Only checkbox is unselected (default). Search term is compared against the text content of textual Elements, the XSL content of the Global XSL Snippet and Inline XSL Snippet Elements, and the displayed file path of Embed Document Elements. Attribute labels in textual Elements are considered part of the normal flow of text.
- Attribute Search – Type of Search executed when Search Attributes Only checkbox is selected. Search term is compared against only the variable names and labels of Attributes contained within textual Elements.
- Match Case – When Match Case checkbox is selected (unselected is default), case sensitivity is applied to both Plain Text and Attribute Searches.
Using Search
Type text into the Search field and either press Enter or click the magnifying glass to open the Search dialog box, shown below. If you opened the dialog box without entering text into the Search field first, enter content in the Search for: field and either press Enter or click Search to start the search.
In the Search dialog box, you can specify additional parameters, such as Match Case and Search Attributes Only.
Click Minimize to hide the Search dialog box and make the Search panel on the left active.
Enter content in the Search for: field, if necessary, and either press Enter or click Search to start the search.
The results of a search appear in the Search dialog box. Search looks for a string throughout the template—including the text content of all textual Elements like Text Elements, Table of Contents Layouts, attribute labels, Heading Elements, and XSL Snippet Elements. The string does not have to be visible to the user for it to be found.
The first time you search for a string, the Search dialog box appears. In the Template Flow, all matching keywords (in open Layouts) will be highlighted. Collapsed Layouts will not be highlighted.
Each result in the Search dialog box has a Go To button associated with it. Clicking Go To for any result:
- Minimizes the Search dialog box
- Makes the Search panel on the left active
- Expands a collapsed Section/Layout, if necessary
- Selects/navigates to the specific match/Element
Using the Search Panel
When searching from the Search panel on the left, all the matching keywords in open Layouts will be highlighted. You can also see which result you are currently viewing, out of the total number of results.
The Search panel includes the buttons in the following table:
| Previous |
|
Move between matching items.
If the subsequent item is in a collapsed Layout, the Layout expands and you will be taken to the matching item.
Note: When search is on the first match, the Previous button is disabled.
|
| Next |
|
Move between matching items.
If the subsequent item is in a collapsed Layout, the Layout expands and you will be taken to the matching item.
Note: When search is on the last match, the Next button is disabled.
|
| Search Results List |
|
Return to the Search Results list. |
| Cancel |
|
Close the Search Results list. |
Notes
When searching for items that are contained within an XSL Snippet, specific tags and terms can be entered into the Search field. The entire XSL Snippet does not need to be entered in the Search field. For example, if an XSL Snippet contained <xsl>data</xsl>, search terms could be xsl or data.
For multi-language templates, search is confined to the currently selected language.
The Search field can be used to search for attribute labels in the template, but not attribute values. The attribute values are inserted into the template when it is generated.
Related Topics
See Also
