Funções Comuns

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:


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:

 

 

Editor de Página Padrão

O editor padrão no BookStack é o editor "O que você vê é o que você obtém" (WYSIWYG). O uso deste editor é semelhante aos aplicativos típicos de processamento de texto, como o Word ou o Google Docs.

Atalhos do editor

Os seguintes atalhos estão disponíveis no Editor WYSIWYG:

Atalho (Windows e Linux / Mac) Descrição
Ctrl+S / Cmd+S Salvar rascunho
Ctrl+Enter / Cmd+Enter Salvar página e continuar
Ctrl+B / Cmd+B Negrito
Ctrl+I / Cmd+I itálico
Ctrl+U / Cmd+U Sublinhado
Ctrl+1Cmd+1 
Ctrl+2Cmd+2 
Ctrl+3Cmd+3 
Ctrl+4/Cmd+4
Cabeçalho Cabeçalho Grande 
Cabeçalho Médio 
Cabeçalho Pequeno 
Minúsculo
Ctrl+5Cmd+5
Ctrl+D/Cmd+D
Parágrafo normal
Ctrl+6Cmd+6
Ctrl+Q/Cmd+Q
Bloco de citação
Ctrl+7Cmd+7
Ctrl+E/Cmd+E
Bloco de código
Ctrl+8Cmd+8
Ctrl+Shift+E/Cmd+Shift+E
Código Inline
Ctrl+9 / Cmd+9 Chamada 
(Continue pressionando para alternar entre os estilos)

Editor de Markdown

Se você preferir escrever no Markdown, o editor no BookStack pode ser alterado em um nível de instância para usar um editor de marcação, em vez do editor padrão WYSIWYG. A opção para usar Markdown não é atualmente uma configuração de usuário, mas uma configuração de instância global devido à formatação de diferenças entre os dois editores.

Observe que a mudança para o editor de remarcação a partir do editor WYSIWYG pode causar efeitos colaterais indesejados no conteúdo existente. Isso se deve às diferenças na maneira como o conteúdo é armazenado no banco de dados.

Atalhos do editor

Os seguintes atalhos estão disponíveis no Markdown Editor:

Atalho (Windows e Linux / Mac) Descrição
Ctrl+S / Cmd+S Salvar rascunho
Ctrl+Enter / Cmd+Enter Salvar página e continuar
Ctrl+1Cmd+1 
Ctrl+2Cmd+2 
Ctrl+3Cmd+3 
Ctrl+4/Cmd+4
Cabeçalho Grande (h2) 
Cabeçalho Médio (h3) 
Cabeçalho Pequeno (h4) 
Cabeçalho Minúsculo (h5)
Ctrl+5Cmd+5
Ctrl+D/Cmd+D
Parágrafo normal
Ctrl+6Cmd+6
Ctrl+Q/Cmd+Q
Bloco de citação
Ctrl+7Cmd+7
Ctrl+E/Cmd+E
Bloco de código
Ctrl+8Cmd+8
Ctrl+Shift+E/Cmd+Shift+E
Código Inline
Ctrl+9 / Cmd+9 Texto explicativo (informação)
Ctrl+K / Cmd+K Inserir link
Ctrl+Shift+K / Cmd+Shift+K Mostrar seletor de links
Ctrl+Shift+I / Cmd+Shift+I Inserir Imagem