Searching content

Section «Knowledge base»

The ability to search your documentation is vital to day-to-day use. There are a few locations within Knowledge base where you can search for your content. Below is a list of search functions within Knowledge base:

  • Header search bar - The search bar/link in the header of every page allows you to search from anywhere. This search is a global search which will look across all books, chapters and pages in your system. After performing a search in this box you’ll be led to a search page that includes options and features that can help you build a more advanced search.

  • Book/Chapter search bar - When viewing a book or chapter a search bar can be found in the top of the left sidebar. These searches will look across all child items.

  • Move & Link selection - When choosing to move a page/chapter or when selecting a page/chapter/book to link to within the editor the most popular items are shown but you also have the ability to search.

Advanced search syntax

All of the above search locations within Knowledge base share the ability to use advanced search syntax. An easy way to see this syntax in action is to use the global search in Knowledge base then play with the search filters which will update the search term with the below syntax. Below are details of the different types of syntax that can be used:

Available filters

Filters are set advanced search features that can be used in your search term. The below table shows all the filters available in Knowledge base and how they can be used.

Date filters:

User filters:

Content filters:

Option filters:

Search examples

Below are some examples of using the above syntax and filters with descriptions:

  • "my cat" {viewed_by_me} {updated_after:2017-01-24}:

    • "my cat" - search for content containing the exact phrase ‘my cat’;

    • {viewed_by_me} - that has been viewed by me;

    • {updated_after:2017-01-24} - and was last updated after the 24th of Jan 2017.

  • textbook discussion [meeting] {type:page} {created_by:me}:

    • textbook discussion - search content for the words textbook or discussion;

    • [meeting] - only show content that has a meeting tag applied;

    • {type:page} - only show pages, hide chapters and books;

    • {created_by:me} - that was created by me.

  • {type:book|chapter} {created_by:me} {created_after:2016-08-12} {created_before:2017-02-18}:

    • {type:book|chapter} - search all books and chapters;

    • {created_by:me} - that were created by me;

    • {created_after:2016-08-12} - after the 12th of Aug 2016;

    • {created_before:2017-02-18} - but before the 18th of Feb 2017.

Did this answer your question?
😞
😐
😁