Документерра: руководство пользователя

Полнотекстовый поиск: Поддерживаемые операторы поиска

Благодаря собственному алгоритму полнотекстового поиска Документерры процесс работы с документацией станет более эффективным. Вот несколько причин, по которым полнотекстовый поиск необходим для написания технических текстов. Например, вы хотите, чтобы ваши пользователи читали документацию, но им трудно найти нужную страницу в объемном руководстве пользователя. Здесь на помощь приходят ключевые слова и таксономии — вы можете даже добавить слова, которых может не быть в статье, и читатели найдут статью через поиск, используя эти ключевые слова.

Примечание
Формат веб-справки WebHelp использует упрощенный функционал поиска и, в отличие от онлайн-публикаций, не поддерживает операторы поиска.

Такой поиск облегчает поиск не только для читателей, но и для технических писателей. Например, вам нужно дать ссылку на страницу, но сначала вам нужно найти страницу. Ответом снова является полнотекстовый поиск, и поддерживаемые операторы поиска сделают процесс поиска более эффективным. Они описаны ниже.

Оператор Пример поискового запроса Результат
AND user AND guide

Если вы введете в поиск "user AND guide" (без двойных кавычек), вы получите страницы, которые содержат следующие результаты:

  • пользователь может найти руководство на своем языке

Но в результатах не будет страниц, которые содержат:

  • Пользователь может авторизоваться в системе

Таким образом, вы получите страницы, которые включают в себя как слова, которые находятся до, так и после оператора «И».

OR login OR permission Если вы выполните поиск по запросу "login OR permission" (без двойных кавычек), вы получите страницы, включающие либо слово «логин», либо слово «право доступа», либо и то, и другое.
Двойные кавычки "login screen" Если вы выполните поиск по запросу "login screen" (с двойными кавычками), вы получите страницы, включающие именно эту фразу.
знак минус notification -administrator Используйте знак минус, если вам нужно найти документы, не содержащие определенного слова. Таким образом, если вы введете в поиск "notification -administrator" (без двойных кавычек), вы получите статьи, которые содержат слово «notification», но не содержат слова «administrator».
круглые скобки (guide OR user) AND login

Используйте круглые скобки для управления порядком действий в сложных поисковых запросах. Правила работы со скобками такие же, как и в математике. Пример поискового запроса означает, что система найдет страницу, содержащую слово «login», а также хотя бы одно из других слов — «guide» или «user».

Вот несколько примеров, которые помогут вам понять принцип работы со сложными поисковыми запросами:

Пример поискового запроса Результат
user AND guide OR login  Если вы введете в поиск "user AND guide OR login" (без двойных кавычек), вы получите страницы, содержащие как слова «user», так и «guide», а также вы получите результаты со словом «login» (независимо от того, есть ли в них «user» или «guide»).
login OR permission -administrator Согласно этому поисковому запросу, вы получите страницы, содержащие слова "login" или "permission", но все эти страницы не будут включать слово "administrator".

Документерра также поддерживает поиск по подстановочным символам. Например, если вы введете в поиск "app*" (без двойных кавычек), вы получите темы, включающие такие слова, как «apple», «application» и другие слова, начинающиеся с «app». Подстановочные символы разрешены только в том случае, если в слове есть хотя бы 2 символа, не являющихся подстановочными знаками, в противном случае слово игнорируется. Кроме того, запрос не может содержать более 2 слов с подстановочными символами. 3-е и последующие слова с подстановочными символами в запросе игнорируются.

Если необходимо исключить страницу из результатов полнотекстового поиска, обратитесь к следующему разделу:  Общие свойства страницы.