Documentação do Usuário

Começando

Começando

Visão geral de conteúdo

Os princípios de armazenamento de informações no BookStack são baseados nas idéias de uma pilha normal de livros. Assim como os livros normais, os livros do BookStack podem conter capítulos e páginas. Você começa criando um livro que atua como o mais alto nível de categorização. Idealmente, você teria livros separados para tópicos separados.

Dentro de um livro, você pode criar páginas diretamente ou criar capítulos. Os capítulos fornecem um nível adicional de agrupamento de páginas para manter as páginas organizadas, mas são opcionais. Toda a informação que você escreve é ​​mantida dentro das páginas. Embora os livros e capítulos não contenham informações, eles podem receber uma breve descrição para ajudar na busca e visibilidade.

Depois de começar a empilhar livros, você pode começar a usar as Estantes de livros para organizar seus livros. Estantes podem conter vários livros e um único livro pode ser colocado em várias estantes de livros.

Codificação de cores padrão

Estantes de livros, livros, capítulos e páginas definiram o código de cores no BookStack para garantir que sejam facilmente identificáveis. Os exemplos abaixo mostram o esquema de cores padrão. Observe que isso pode ser substituído por seu administrador.

 Livros     Capítulos Páginas Rascunho Páginas Estantes               

Começando

Quando você começa com sua nova instância do BookStack, pode organizar as coisas de duas maneiras; Você pode planejar sua estrutura de livro / capítulo / página ou pode deixar que as coisas cresçam naturalmente ao longo do tempo. Se você já conhece ou já tem o conteúdo que vai entrar no BookStack, então é melhor planejar antes do contrário, se você está começando do zero, você vai querer deixar que tudo ache seu próprio lugar.

Se você decidir crescer naturalmente, provavelmente começará com um livro para cada categoria principal e adicionará páginas diretamente nesses livros. Ao começar a obter muitas páginas em cada livro, você começará a usar capítulos para agrupar essas páginas. Uma vez que um capítulo fique muito grande, você pode achar melhor dividi-lo em seu próprio livro. Dentro do BookStack você pode facilmente mover capítulos e páginas entre livros e capítulos, assim você não deve se preocupar em ter que mudar as coisas no futuro.

Começando

Organizando o Conteúdo

Quando sua instância do BookStack começar a crescer, você descobrirá que pode reorganizar seu conteúdo. Dentro do BookStack, existem duas opções para mover o conteúdo; Você pode mover páginas e capítulos individualmente ou pode classificar livros inteiros.

Observe que, para mover o conteúdo, você precisa ter permissão de "edição" para o conteúdo que está sendo movido e o pai para o qual ele está sendo movido.

Movendo livros e capítulos únicos

Livros e capítulos podem ser movidos diretamente para um novo capítulo ou livro. Para mover um capítulo ou uma página dessa forma, vá para uma página ou capítulo e selecione 'Mover' no menu flutuante, encontrado no lado direito da barra de ferramentas superior:

Menu Mover Página

Ao clicar na ação "Mover", você será levado a uma tela na qual poderá selecionar um novo local para o seu capítulo ou página. Aqui você pode procurar um livro ou capítulo específico usando a barra de pesquisa na parte superior da tela de seleção. Depois de selecionar um novo pai para o seu capítulo ou página, pressione 'Mover Página' ou 'Mover o Capítulo' e seu capítulo ou página será movido para o novo capítulo ou livro. Se você mover um capítulo, todas as páginas filhas permanecerão nesse capítulo e qualquer atividade relacionada será exibida sob o novo livro pai.

Classificando livros

A interface 'Book Sort' permite que você mova várias páginas e capítulos com facilidade em uma simples interface de arrastar e soltar. Para classificar um livro, simplesmente vá até o livro e selecione "Classificar" no menu flutuante (3 pontos verticais ao lado do botão de edição) no canto superior direito da página e você será direcionado para a visualização de classificação:

Livro Sort

Inicialmente, apenas o livro de onde você veio será exibido à esquerda. Você pode adicionar livros extras à interface de classificação, selecionando-os à direita. Aqui você pode simplesmente arrastar e soltar capítulos e páginas ao redor e também entre diferentes livros. Depois de ter organizado o seu conteúdo, pressione 'Salvar' e todos os livros incluídos serão reorganizados.

Funções Comuns

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:

 

 

Funções Comuns

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)
Funções Comuns

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

Características avançadas

Características avançadas

Reutilizando o Conteúdo da Página

No BookStack, você pode achar que deseja incluir o mesmo bloco de conteúdo em vários lugares. Você pode copiar e colar esse conteúdo em várias páginas, mas, se esse conteúdo precisar ser alterado, será necessário atualizá-lo várias vezes em diferentes páginas. Introduzido no BookStack v0.14 é a capacidade de incluir outras páginas e também incluir blocos únicos de conteúdo de outras páginas.

Observe que o comportamento de inclusão não é recursivo, portanto, a inclusão só funcionará em um único nível. Isso garante desempenho e impede que os usuários quebrem páginas criando loops de inclusão.

Incluir tags

Para incluir o conteúdo de uma página em outra, você pode usar a seguinte sintaxe:

{{@page_id}} ou {{@page_id#content_id}}

Aqui estão alguns exemplos disso em uso:

Você simplesmente insere isso no editor de páginas e, quando a página é visualizada, o conteúdo será buscado dinamicamente. Isso significa que você pode atualizar o conteúdo referenciado e ele mostrará as mesmas alterações em qualquer página em que o conteúdo estiver incluído.

Agarrando facilmente a sintaxe

Encontrar o ID de uma página pode ser difícil, portanto, uma maneira rápida e fácil de encontrar tags de inclusão é incorporada ao BookStack. Veja uma página com algum conteúdo que você deseja reutilizar. Use o mouse para selecionar algum conteúdo e você verá um popup aparecer. Por padrão, isso contém um link direto para esse conteúdo. Se você clicar no ícone de link à esquerda, ele alternará para mostrar a tag de inclusão para esse conteúdo. Basta copiar isso e colocá-lo em outra página. Remova o #ID e o conteúdo para incluir todo o conteúdo da página, em vez de apenas um único bloco.

Forçando IDs de conteúdo

Ao incluir um bloco específico de conteúdo, o id do bloco é usado (parte após o hash). Por padrão, eles são gerados pelo BookStack quando você salva uma página. Se você estiver usando o editor WYSIWYG, o ID permanecerá o mesmo, a menos que o bloco seja removido ou reformatado. No editor de marcação, ele muda a cada gravação e faz referência ao conteúdo de modo que, embora permaneça o mesmo, há uma boa chance de um ID ser alterado.

Devido ao fato de que os códigos podem mudar, é recomendável forçar os códigos em seu conteúdo:

Editor WYSIWYG

No editor WYSIWYG, você pode forçar uma ID entrando na visualização do código-fonte e adicionando-a manualmente:

Forçando IDs WYSIWYG

Editor de Markdown

No editor de marcação, você pode simplesmente inserir HTML com um ID para garantir que ele não seja alterado:

1
2
3
4
5