Scroll Viewport builds on Elasticsearch, a full-text search engine, to provide a functional, help-center optimized search experience. It indexes and shows search results from all pages that are part of your Viewport site.
As part of the help center theme, all Scroll Viewport sites feature prominent search components throughout the site, allowing your site visitors to search for help no matter where they navigate in the site.
Scroll Viewport indexes all pages that are part of your Viewport site. That means only the content of the spaces and Scroll Documents that you have added as a content source to your site are displayed in the search results.
The only exceptions are:
Pages with the Confluence page label scroll-help-center-exclude-page
These pages will not show up in your search results. Also note that the restricted pages are not part of your site.
Highest Weight on Pages with Search Terms in the Title
Pages with the search term in the title are ranked higher in the search results page than pages that contain the search term only in the article body. A hit in the title is weighted three times more relevant than a hit in the body.
If you want a specific page of your help center to appear on the top of the search results page, we recommend you include its key words in the title.
Scroll Viewport search uses a fuzzy search feature to display pages that contain words that are similar to the entered search term.
We use the so-called Levenshtein distance to display terms that would only require only a few character edits to turn into your entered search term (Example: Turning ‘test’ into ‘text’ only requires changing the ‘s’ to 'x').
If you enter more than one search term, Viewport will returns all pages that contain any of the entered search terms. That means the search results will also include pages that contain only one of the entered search terms.
Difference to Confluence Search
To generate and publish your site, Scroll Viewport pulls content from Confluence pages and stores the content in a separately hosted location. Once the site is first generated, your content is completely separated from your Confluence instance and all its infrastructure, including the Confluence search.
To build a search for your site, Scroll Viewport uses Elasticsearch and only ever indexes the pages that it pulls from Confluence (i.e. only the pages that are part of the content sources you have added to your site and where the page label scroll-help-center-exclude-page is not applied).
Therefore, the search on your Viewport site will normally include less content than the search in your Confluence instance and display and rank results differently (see The Search Experience In the Help Center Theme).
The Search Experience In the Help Center Theme
All page templates of the help center theme contain a search bar, allowing your site visitors to search for content no matter where they are in the site.
In the help center theme, search results are displayed via a quick search option (except if searching from article pages set to ‘simple search’) and on a dedicated search results page.
Search bars are sized differently and come with or without a quick search functionality, depending on the specific page you are on and your template layout choices.
Look and Feel
Content Source Page - Hero Layout
Content Source Page - Detail Layout
Comes with two template options:
If search for the Article template in the theme editor is set to ‘enhanced’.
If search for the Article template in the theme editor is set to ‘simple’.
As the name says, quick search allows for a quick search experience.
On the pages where quick search is available (see table above), your site visitors will see the most relevant search results appear as they type into the search bar.
They can click to directly open one of the listed page without having to navigate to a dedicated search results page first.
Search Results Page
Typing a search term and clicking enter or the magnifying glass icon will direct your site visitors to a full screen search results page.
Below a search bar, the page lists all relevant pages that match the entered term (see Search Ranking).
The results page also include a page count, search filters and a page summary.
The page summary includes additional information about the individual page to help contextualize it:
the content source it is part of
the page title
the content snippet in the page that includes the search term(s) (in bold)
the version (only if the page is part of a Scroll Document)
If performing a quick search with more than seven search results to display, your site visitors can click a → more link at the bottom of the quick search list. This will allow them to access the full screen search results page with all search results that were found.
There will be a maximum of ten search results shown per page. Remaining results are shown on following pages.
On the search results page
The search results page includes a filter bar that allows your site visitors to specify the scope of their search.
Currently, it’s possible to filter by:
Version (only if a Scroll Document content source)
On the content source page
By default, the search on the content source page is location aware. The filters are always set to match the current content source from where the search is started from.
Example: If you search from an article that is part of the content source CleverApp, you search will automatically be scoped to that content source and exclude matching results that are part of another content source, e.g SmartApp.
The scope can be expanded again to include all content sources and all versions using the filters on the search results page.
On the portal page
By default, the search on the portal page will search all content sources. Optionally, you can add a “Content source filter” to your portal page search (Edit theme → Templates → Portal). The filter will allow users to set the scope of their search right from the help center’s landing page.