Pesquisando Conteúdo

A capacidade de pesquisar sua documentação é vital para o uso no dia-a-dia. Existem alguns locais no BookStack onde você pode pesquisar seu conteúdo. Abaixo está uma lista de funções de pesquisa no BookStack:

  • Barra de pesquisa de cabeçalho - A barra de pesquisa / link no cabeçalho de cada página permite que você pesquise em qualquer lugar. Essa pesquisa é uma pesquisa global que examina todos os livros, capítulos e páginas do seu sistema. Depois de realizar uma pesquisa nessa caixa, você será levado a uma página de pesquisa que inclui opções e recursos que podem ajudar você a criar uma pesquisa mais avançada.
  • Barra de pesquisa de livros / capítulos - Ao visualizar um livro ou capítulo, uma barra de pesquisa pode ser encontrada na parte superior da barra lateral esquerda. Essas pesquisas analisam todos os itens filhos.
  • Move & Link Selection - Ao escolher mover uma página / capítulo ou ao selecionar uma página / capítulo / livro para vincular dentro do editor, os itens mais populares são exibidos, mas você também pode pesquisar.

Pesquisa Avançada Sintaxe

Todos os locais de pesquisa acima no BookStack compartilham a capacidade de usar a sintaxe de pesquisa avançada. Uma maneira fácil de ver essa sintaxe em ação é usar a pesquisa global no BookStack e, em seguida, jogar com os filtros de pesquisa que atualizam o termo de pesquisa com a sintaxe abaixo. Abaixo estão os detalhes dos diferentes tipos de sintaxe que podem ser usados:

Tipo de pesquisa Sintaxe Exemplos Descrição
Pesquisas normais <term_a> <term_b> reunião de londres A palavra normal pesquisa o nome e a descrição ou o corpo do seu conteúdo. Quando vários termos são pesquisados, apenas um termo deve corresponder ao seu conteúdo, mas o conteúdo que contém os dois termos será maior nos resultados.
Pesquisas Exatas "<termo>" "reunião de londres" Correspondências exatas exigirão que a string inteira entre aspas exista em seu conteúdo exatamente no mesmo formato. Use isso se você estiver procurando por uma frase exata contendo ou se precisar pesquisar um termo com espaços.
Pesquisas de tags [<nome>] 
[<operador> <valor>] 
[<nome> <operador> <valor>]
[location] 
[= london] 
[location = london] 
[participantes> 5]
As pesquisas de tags permitem que você encontre páginas com tags específicas aplicadas. Você pode pesquisar pelo nome da tag, pelo valor da tag ou pelo nome e valor. Ao pesquisar por valor de tag, um operador deve ser usado para definir o tipo de correspondência. Você pode usar =!=<><=>=ou likecomo operadores. Ao usar o likeoperador, você pode usar %símbolos para representar curingas em sua pesquisa.
Filtrar pesquisas {<filter_name>} 
{<filter_name>: <filter_value>}
Ver abaixo Os filtros executam funcionalidades avançadas adicionais para tornar suas pesquisas ainda mais poderosas. Alguns filtros aceitam valores, mas alguns não precisam. Veja abaixo uma lista completa dos filtros disponíveis.

Filtros Disponíveis

Os filtros são definidos como recursos de pesquisa avançada que podem ser usados ​​em seu termo de pesquisa. A tabela abaixo mostra todos os filtros disponíveis no BookStack e como eles podem ser usados.

Sintaxe Exemplos Descrição
Filtros de data
{updated_after: <date>} {updated_after: 2016-12-30} Adiciona a condição de que o conteúdo deve ter sido atualizado pela última vez após a data especificada. 
A data deve estar no formato AAAA-MM-DD
{updated_before: <date>} {updated_before: 2016-12-30} Adiciona a condição de que o conteúdo deve ter sido atualizado pela última vez antes da data especificada. 
A data deve estar no formato AAAA-MM-DD
{created_after: <date>} {created_after: 2016-12-30} Adiciona a condição de que o conteúdo deve ter sido criado após a data especificada. 
A data deve estar no formato AAAA-MM-DD
{created_before: <date>} {created_before: 2016-12-30} Adiciona a condição de que o conteúdo deve ter sido criado antes da data especificada. 
A data deve estar no formato AAAA-MM-DD
Filtros do usuário
{updated_by: <user_id | me>} {updated_by: 10} 
{updated_by: me}
Adiciona a condição de que o conteúdo deve ter sido atualizado pela última vez pelo usuário do ID numérico fornecido. Se "eu" for usado no lugar de um ID numérico, ele localizará o conteúdo que foi atualizado pela última vez pelo usuário que efetuou login.
{created_by: <user_id | me>} {created_by: 10} 
{created_by: eu}
Adiciona a condição de que o conteúdo deve ter sido criado pelo usuário do ID numérico fornecido. Se "eu" for usado no lugar de um ID numérico, ele localizará o conteúdo que foi criado pelo usuário conectado no momento.
Filtros de Conteúdo
{in_name: <search>} {in_name: reuniões em Londres} 
{in_name: reuniões}
Exigirá que o conteúdo tenha o <search>termo determinado no nome, em vez do nome ou corpo do conteúdo.
{in_body: <search>} {in_body: Reuniões em Londres} 
{in_body: Meetings}
Exigirá que o conteúdo tenha o <search>termo determinado no corpo, em vez de o nome ou o corpo do conteúdo.
Filtros de Opção
{é restrito} {é restrito} Exigirá que o conteúdo tenha permissões de nível de conteúdo ativas. Não retorna itens com apenas permissões de ativos herdados.
{viewed_by_me} {viewed_by_me} Exigirá que o conteúdo seja visto pelo usuário atual pelo menos uma vez.
{not_viewed_by_me} {not_viewed_by_me} Não retornará nenhum conteúdo que tenha sido visualizado pelo usuário atual.
{type: <content_types>} {type: page | chapter | book} 
{tipo: page | chapter} 
{type: book}
Restringe os tipos de conteúdo que estarão nos resultados da pesquisa. 
O uso disso dependerá do tipo de pesquisa. Por exemplo, em uma pesquisa de capítulo, apenas as páginas são mostradas, portanto, isso não tem efeito.

Exemplos de pesquisa

Abaixo estão alguns exemplos de uso da sintaxe acima e filtros com descrições:

  • "my cat" {viewed_by_me} {updated_after:2017-01-24}
    • "my cat" - Pesquise conteúdo que contenha a frase exata "meu gato"
    • {viewed_by_me} - que foi visto por mim
    • {updated_after:2017-01-24} - e foi atualizada pela última vez a partir do dia 24 de janeiro de 2017.

 

  • textbook discussion [meeting] {type:page} {created_by:me}
    • textbook discussion- Pesquisar conteúdo para as palavras textbookoudiscussion
    • [meeting]- mostrar apenas conteúdo que tenha uma meetingtag aplicada
    • {type:page} - só mostra páginas, oculta capítulos e livros
    • {created_by:me} - isso foi criado por mim.

 

  • {type:book|chapter} {created_by:me} {created_after:2016-08-12} {created_before:2017-02-18}
    • {type:book|chapter} - Pesquisar todos os livros e capítulos
    • {created_by:me} - que foram criados por mim
    • {created_after:2016-08-12} - após o dia 12 de agosto de 2016
    • {created_before:2017-02-18} - mas antes do dia 18 de fevereiro de 2017