Search information

On this page you can learn how to make use of the search functionalities in this documentation.

How the search algorithm works

This documentation uses Lunrjs for the search.
With every search Lunr returns a list of matching documents with a score of how closely they match the search query as well as any associated metadata about the match.

It is recommended to always search full words, as the algorithm might not work properly when only typing half the word.

There are a bunch of additional functionalities you can use when searching specific topics. If you are interested in more details, check out the Lunrjs documentation.

Wildcards

The Lunr search engine provides you with the possibilities to use Wildcards. A wildcard is represented as a "*" character and can be placed anywhere within the search term.
Examples:

• If you want to find all sites, that contain words starting with "meas" use "meas*" as search term.
• If you want to find all sites, that contain words ending in "ator" use "*ator" as search term.
• If you want to find all sites, that contain words starting with "x" and ending in "yz" use "x*yz" as search term.

Boosts

In multi-term searches, a single term may be more important than others. For these cases Lunr supports term level boosts. Any document that matches a boosted term will get a higher relevance score and appear higher up in the results. A boost is applied by appending a caret (^) and then a positive integer to a term.
"measurement^10 mode"
The above example weights the term "measurement" 10 times higher than the term "mode".

The boost value can be any positive integer, and different terms can have different boosts:
"measurement^10 mode^5 impedance"

Fuzzy matches

Lunr supports fuzzy matching search terms in documents, which can be helpful if the spelling of a term is unclear, or to increase the number of search results that are returned. The amount of fuzziness to allow when searching can also be controlled. Fuzziness is applied by appending a tilde (~) and then a positive integer to a term.

The following search matches all documents that have a word within 1 edit distance of "modf":
"modf~1"

Term presence

By default, Lunr combines multiple terms together in a search with a logical OR. That is, a search for "measurement mode" will match documents that contain "measurement" or contain "mode" or contain both. This behaviour is controllable at the term level, i.e. the presence of each term in matching documents can be specified. By default, each term is optional in a matching document, though a document must have at least one matching term. It is possible to specify that a term must be present in matching documents, or that it must be absent in matching documents.
To indicate that a term must be present in matching documents the term should be prefixed with a plus (+) and to indicate that a term must be absent the term should be prefixed with a minus (-). Without either prefix the terms presence in matching documents is optional.

The example below searches for documents that can contain "reference", must contain "python" and must not contain "java".
"reference +python -java"
To simulate a logical AND search for e.g. "measurement AND mode" mark both terms as required:
"+measurement +mode"

SCPI Commands

If you want to look for specific SCPI-Commands, the search should provide you with every match to your query.
However, when including the colon, make sure to not put it as the first character in the query as the search engine Lunr has a problem with leading colons trying to perform a field search.