Search for Files

easyDITA provides you with a robust search engine that enables you to efficiently find resources in your content library.

The Search bar enables you to search for words from anywhere in the current branch. As you type, the results show the top six matches based on the file name or topic title.
Figure 1. Search Bar
Typing in a search term and pressing Enter opens the Filters tab in the content library.
Figure 2. Filters Tab
By default, easyDITA searches all files in the current branch. You can narrow the search scope to a specific folder or a collection.

Complex Search

In the content library,you can search for terms in specific DITA elements and attributes.

Operation

By default, easyDITA searches for a term in the following DITA elements and attributes:

  • concept body element
  • glossary definition element
  • glossary term element
  • keyword element
  • paragraph element
  • prolog element
  • reference body element
  • short description element
  • task body element
  • title element
  • ID attribute

Search Strings

You use search strings to find matches in specific DITA elements or attributes.
Note: You use the Lucene Query Parser Syntax to compose easyDITA search strings. By default, easyDITA returns fuzzy matches. If you want to refine search results, you can use search operators.
Table 1. Searchable DITA Elements

By default, you can restrict your search for a term in a specific element. The available options may vary based on your configuration.

DITA ElementsSearch String Format
Keywords__content_keywords:example
keyword elements__content_keyword:example
glossary term element__content_glossterm:example
glossary definition element__content_glossdef:example
prolog element__content_prolog:example
short description element__content_shortdesc:example
concept body element__content_conbody:example
reference body element__content_refbody:example
task body element__content_taskbody:example
paragraph element__content_para:example
title elementtitle:example
Table 2. Searchable Metadata

By default, you can search for the following metadata items.

MetadataSearch String Format
Owned By__document_owner:username
Broken Links__has_broken_links:true/false
Status__status:example
Custom Metadata__taxonomyName:example
Table 3. Searchable Attributes

By default, you can search for ID attribute values.

AttributeSearch String
ID attributeexample

Complex Search Examples

The following string searches for “the word users” in short description elements.
__content_shortdesc:users
The following string searches for the words “enables users to” in short description elements.
__content_shortdesc:"enables users to"
The following string searches for the word “users” in short description elements and the word “enables” in concept body elements.
__content_shortdesc:users __content_conbody:enables
The following string searches for non-approved topics that also contain the word “user” in title elements.

The NOT operator excludes the search term that follows it.

title:user NOT status:approved

Search for Resources

Type search terms into the Search bar to find files in your content library.

  1. In the Search bar, enter a search term.

    The search ahead feature shows the top matches for that term as you type.

  2. If the file you're looking for displays in the top results, you can navigate to it from there.
    1. Double-click the file to navigate to the file's location in the content library.
    2. Click the Open icon to open the file in the topic editor.
    3. Click the Output icon to open the publishing interface for the file.
    4. Click the Tab icon to open the file in a new browser tab.
    5. Click the More icon to see additional options for the file.

  3. If the file you're looking for does not display in the top matches, press Enter to view all search results and open the Filters tab.

    The Filters tab appears and the search term is entered into the Search field.