Table of Contents
Overview
This article outlines the FreeWheel Hub's best practices and recommendations to get the most of the search experience on the site.
A video walkthrough is also available by viewing the training video on the Welcome to the FreeWheel Hub article, which includes an overview of search features, effective navigation tips, and other key features of the FreeWheel Hub.
Search Bar Locations
Note: Not all product documentation is publicly available, and some, like MRM (TV Platform), SFX, and others require a successful login in order for the search feature to include the associated documentation.
Search can be conducted in two general locations within the FreeWheel Hub:
Global Search
Global search is a universal search bar located on the top right of every page within the Hub: Searching within this search bar opens a widget which provides advanced filtering options (please read below).
Without proper filtering, this global search bar will include search results for all content within the FreeWheel Hub which you have access to (including publicly available materials). FreeWheel does not recommend this approach for most users, who typically focus on a singular FreeWheel product.
Tip: FreeWheel strongly recommends filtering any global search by the specific product space(s) of interest only.
To do so, refer to instructions and screenshot below:
Click the top right search bar, and enter in your keyword(s) search
Under "Filter by" click on Space
Type the name of the FreeWheel product to filter the documentation on. For instance: "Beeswax," "OneStrata," "MRM," or "SFX"
If the FreeWheel product is not listed as an option, this is likely due to the proprietary nature of the documentation. For these cases, please login with the appropriate credentials provided by FreeWheel first.
Local Search
Local search within each Hub space's left navigation bar: Searching within a specific Hub space's left navigation bar will include search results for content within the Hub space only. For example, the search bar in the image below will only search within the "Releases" space.
Filtering
Filtering is helpful in narrowing search results to exactly the content you're looking for. The table below outlines the different filter functions available.
| Filter | Description |
|---|---|
| Contributor | Not in use. All pages on the Hub are published by an administrator - we do not utilize this filter. |
| In Space | Type the name of the Space you'd like to search within. Space names are the names of the User Guides and sections within the Hub, such as MRM User Guide, Releases etc. |
| Last Modified | These checkboxes allow you to select how far back you'd like to search. |
| Of Type | This allows you to select the type of content you'd like to view. The Hub's search automatically searches across all content, but typically users are searching for content within our documentation. In this case, the filter of "Pages" should be used. This will help eliminate the attachments that frequently appear in searches. |
Search Syntax
The Hub has a search syntax that can be utilized to narrow and refine search results. It's important to note that the search ignores common words (e.g. "the" or "an") even when utilizing the syntax below. The table below outlines the accepted syntax, as well as its function.
| Syntax | Description |
|---|---|
| General | |
| Exact Phrase Search | Enclose the search terms within quotation marks to search for that exact phrase. For example, a search for "Agency Tab" will only return results where those two terms appear in succession. |
| OR Search | Include the word OR (must be capitalized) between two terms to search for either one of the terms. For example, a search for Agency OR Advertiser would return results that contain either one of the terms. |
| AND Search | Include the word AND (must be capitalized) between two terms to search for both terms. This differs from the Exact Phrase Search, as it searches for both terms anywhere on the page, not necessarily together as one phrase. For example, a search for Ad Unit AND API will return only results that contain both the terms Ad Unit and API. |
| NOT Search | Include the word NOT (must be capitalized) between two terms to search for the first term and not the second term. For example, a search for Ad Unit NOT API will return only results for Ad Units that don't contain the term API. |
| Fuzzy Search | Include a ~ at the end of your search to search for words spelled similarly. For example, a search for Advirtiser~ will also return results for Advertiser. |
| Wildcards | |
| ? | Include a ? in place of a character to search for words that may contain different letters in its place. For example, a search for Si?e would return results for Size, Site etc. |
| * | Include an * at the end of a base word to search for a multitude of suffixes for the term. For example, a search for Creat* will return results for Creative, Creating, Creation etc. |
Searching Archived Materials (TV Platform only)
In an effort to clean up search results, we've moved older release notes to a Release Archive. By default, Release Notes that are at least two years old will no longer appear in global search results. The Release Notes will remain searchable by using the search bar located on the homepage of the archive.