Skip to content
Mubelotix edited this page Jun 1, 2024 · 2 revisions

Basics

Admarus works well for latin languages. As of today, only english is officially supported. All words with more than 3 letters are indexed. Casing has no effect on search. Automatic search of plurals will be supported soon.

Operators

Admarus supports AND, OR and NOT operators. Operators must be uppercase or they will be considered as words.

OR is the default operator, used when none is specified.

bitcoin OR filecoin
bitcoin filecoin

harry AND potter

bitcoin AND NOT(crypto)

These operators have shorthand signs: + or & for AND, / or | for OR, and ! for NOT.

bitcoin / filecoin
bitcoin | filecoin
bitcoin filecoin

Harry + Potter
Harry & Potter

Bitcoin & !crypto

Brackets can be used to group complex expressions.

bitcoin OR (hedera AND hashgraph)

(harry AND potter) OR (mad AND max)

bitcoin AND (NOT(crypto) OR king)

There is another uncommon operator, called NAmong, matching a document when at least n of the k inner expressions match.

2(harry, potter, gryffindor)

2(harry, potter)
harry AND potter

1(harry, potter)
harry OR potter
harry potter

Filters

Admarus supports some key-value selectors.

Language

The lang filter allows selecting the language of documents. Casing of values is ignored.

bitcoin + lang=en

bitcoin + NOT(lang=zh)

bitcoin + (lang=en / lang=fr)

This mechanism was found to be insufficient as autocompletion in many code editors add the english language by default. As a result, many documents in different languages are still marked as english. That's why Admarus also implements automatic detection of the language (but only english is supported yet). The filter is still useful as it allows the query to be routed much more efficiently.

Rich Content

Warning: this section is about a feature that's currently being implemented

Admarus supports schema.org structured data. Documents containing specific objects can be queried using the schema filter.

cat + schema=ImageObject

harry + potter + schema=VideoObject

pizza + schema=Recipe

1984 + schema=Book

leonardo + vinci + schema=Person

5(never, gonna, give, down, rules) + schema=MusicRecording

Documents can match multiple values for a single key.

fireworks + schema=ImageObject + schema=VideoObject

Note that Admarus automatically converts raw img, video, picture and audio html elements into the corresponding schema.org types in order to improve compatibility.

Clone this wiki locally