Ir para o conteúdo principal

Utilização do sitema de manuais

1 - Como acessar e fazer login

Abra o endereço do Sistema de Manuais no navegador pelo endereço:

https://manuais.araquari.ifc.edu.br/

No topo da página, clique em Entrar:

image.png

Entre com seu Araquari.ID e clique em Entrar:

image.png

Ao logar, você volta ao site já autenticado e passa a ver as estantes que você tem permissão de acesso e edição, aqui muitas vezes, pode gerar uma interpretação errada do usuário, achando que ele está com algum problema de login, mas tudo dependerá de como cada adminitrador de estantes, livros, páginas e capítulos restringir seus conteúdos, lembre que o site de manuais tem perfis de publicação: aquilo que é público (para todos), aquilo que é restrito para o departamento, e aquilo que é restrito apenas a usuários logados. Mais pra frente iremos entender um pouco mais como funcionará a permissão de visualização dos conteúdos.

image.png

2 - Como navegar pelo conteúdo e criar livros, capítulos e páginas

Você poderá navegar livremente pelos conteúdos que o seu perfil de usuário ao logar está permitido, você também poderá clicar na barra superior para filtrar por Estantes e Livros ao lado do seu nome no canto superior direito.

Neste tutorial, iremos simular o usuário "teste.teste" que faz parte do grupo DAP, e que tem autorização para criar, editar e excluir conteúdos dentro da estante DAP - Direção de Administração e Planejamento, clique na estante para acessá-la:

image.png

Ao clicar na estante, você verá livros já públicados, se nenhum livro estiver públicado, aparecerá uma página sugerindo a criação do seu primeiro livro. Já com a estante acessada, você verá um menu lateral onde Ações poderão ser realizadas nesta estante, sendo as permitidas:

  • Novo livro: criar um novo livro na estante.
  • Visualiação em lista: mudará a forma de ver os livros na estante.
  • Editar: Editar a estante (NÃO MEXER NESSE ITEM).
  • Favoritos: Adiconar um item como favorito.

image.png

Para criarmos nosso primeiro livro, vá na guia lateral em ações e clique em Novo livro:

image.png

Ao clicar, devemos preencher as primeiras informações deste livro, neste exemplo, chamaremos o livro de "Exemplo 01". Iremos ignorar neste momento as opções Imagem de capa, Tags de Livro e Modelo de página padrão. Clique em Salvar Livro.

image.png

Ao clicarmos em salvar livro, você será direcionado automaticamente para criação de página e capítulos, conforme mostra a imagem abaixo; perceba que a opção lateral de Ações também ficou disponível e é nela onde faremos a maior parte das configurações:

image.png

A primeira ação que devemos fazer para esse novo livro, é definir a permissão/visualização que ele terá, deveremos considerar se ele é um livro público, acesso interno do departamento e/ou acesso interno para usuários logados.

Clique em Permissões e vamos enteder como configurar cada uma delas:

image.png

Ao clicarmos vamos nos deparar com a seguinte configuração, mantendo como está, o Livro adotará o padrão do sistema, onde o proprietário é o próprio criador do livro e a opção abaixo onde vemos "Todos os outros" marcado apenas a opção "Herdar padrões", ele automaticamente se comportará como um livro público onde qualquer usuário NÃO LOGADOS poderá visualizar o livro. Aqui entram alguns detalhes improtantes:
Cápitos e páginas, se as permissões não forem alteradas, elas herdarão a configuração do livro;

Neste momento devemos considerar que usuários NÃO LOGADOS estaráo permitidos, no entando, usuários LOGADOS não conseguiram ver o livro criado ao acessarem o sistema. Para evitarmos isso, deveremos inserir na permissão o perfil "Usuários logados" para esse livro, que veremos logo mais abaixo.

image.png

Ainda na mesma página, para inserimos os usuários logados, clique na opção Substituir permissões para função e selecione o perfil "Usuários logados" conforme mostra a imagem abaix:

image.png

Ao selecionarmos "Usuários logados", ele abirá a caixa deste perfil, marque as opções que achar necessário, neste exemplo, marcamos que usuários logados irão apenas visualizar este livro, em seguida clique em Salvar Permissões para finalizar:

image.png

OBS: Vamos entender um pouco esse comportamento: O sistema trata de forma purista e direta o que cada perfil poderá acessar, e faz essa separação para que você tenha controle total do conteúdo, parece um pouco estranho permitir que usuários NÃO LOGADOS (perfil público) acessem determinado conteúdo, e usuários LOGADOS não, mas image se removermos a opção de usuários "Não logados" que é chamado no sistema por "Todos os outros", você poderia então permitir que determinado conteúdo seja mais restritiro para por exemplo, apenas diretores e coordenadores.

Atente-se nesse momento sobre o níveis de permissão que você deseja conceder, sendo eles:

Visualiar: Apenas visualizar o conteúdo
Criar: Pode criar objetos dentro do livro criado (capítulos e páginas)
Atualizar: Pode atualizar objetos exsites, mas não pode criar novos e nem excluir objetos
Excluir: Pode excluir qualquer objeto, mesmo de outros usuários.

Seguindo, ao salvarmos as permissões, e etendermos que o livro tem perfil público, iremos criar nosso primeiro caítulos e nossas primeiras página. 

O processo de criação é basicamente o mesmo, e neste momento podemos criar cápítulos para organizar as páginas, ou páginas soltas sem a necessidade de capítulos, vamos então criar uma página, clique em Criar uma nova página, que também pode ser feito do lado direito no menu Ações:

image.png

Ao criar a página, você será automaticamente direcionado para uma página com um parão de editores de textos tradicionais, conforme é mostrado abaixo:

image.png

Você poderá renomear a página, e usar o editor com as funcionalidade mais comuns de um editor de texto, como negrito, itálico, criação de tabelas, ordenação de texto, usar marcadores, listagens de númernos e afins.
A grande diferença pros demais marcadores estrá na opção Parágrafo do editor de texto, e é nele que as principais funcionalidades estarão disponíveis e que farão a interação direta com o usuário:

image.png

Cabeçalhos, serão os Itens do texto, como Título 1, Título 2, Título 2.2, é em si a ordenação do conteúdo e servirá também para um menu lateral que iremos ver a seguite. Já a opção parágrafo, é de fato o texto limpo, bloco de citação é uma citação importante no meio do texto, como por exemplo uma lei, e as frases de destaque é se você desejar dar enfâse com cores no conteúdo.

Para exemplificarmos, o sistema tem um "Modelo padrão de documentação, que é acessível no contato direito, pelo menu "Modelos", conforme mostra a imagem abaixo:

image.png

Se clicarmos no modelo padrão, ele carregará o conteúdo de um modelo de documentação que poderá facilitar sua documentação, conforme abaixo:

image.png

Veja que ele cria uma documentação básica para ser seguida como padrão para suas demais documentações, isso facilita a uniformidade de docuemntação do seu departamento. Se rolarmos, iremos identificar no texto, várias marcações que foram citadas para o menu parágrafo, seja alguns exemplos:

image.png

Vemos dois títulos e um subtítulo, vemos em azul uma frase em destaque, e entre àspas um bloco de citação, tudo isso é possível ser aplicavel selecionando texto, clicando na função parágrafo e em seguida selecionando o que deseja usar.

Antes de seguirmos, se clicarmos em Salvar Página, conforme abaixo:

image.png

Veremos que página foi salva com o conteúdo que estava nela, sendo que no lado esquerdo, temos a navegação da página, que são os Cabeçalhos definidos no menu parágrafo, e abaixo a navegaão do livro onde a página foi criado.

image.png

OBS: Os cabeçalhos facilitam muito a navegação para manuais longos, muitas vezes o usuário quer ir direto a um ponto do manual, e poderá utilizar essa navegação para auxiliá-lo.

Atente-se também, que logo ao lado, foi habilitado o menu de ações dessa página, onde você poderá editá-la, copiá-la (para reaproveitar o conteúdo, mover entre livros e estantes que você tenha permissão de acesso, verificar todas revisões (alterações realizadas), excluir, e o mais importante, as Permissões dela, conforme mostra a imagem abaixo:

image.png

As permissões trabalham igualmente o conceito dos livros e as aestantes, então, caso você deseja permitir essa página como pública, ou caso deseja restringí-las a certos grupos, é nesse guia que você fará.

Vale a pena reforçar aqui, todo os objetos, estantes, livros, capítulos e páginas, podem ser customizáveis a nível de permissão, você pode ter um livro público, mas dentro dele ter capitulos e páginas acessíveis por diversos públicos. Por exemplo, você pode ter uma página de manual para toda a comunidade acadêmica, mas no mesmo capítulo, conter uma página com informações sensíveis que deve ser restrita somente ao departamento, a intenção aqui é agrupar no mesmo Livro ou Capítulo o assunto, mas permitir diferentes acessos sem precisar espaalhar seu conteúdo.

Se clicarmos na guia Exemplo 01 (livro que criamos para esse exemplo):

image.png

Retornaremos para o menu de criação de páginas e capítulos que foi visto anteriormente:


image.png

Se clicarmos em novo capítulo:

image.png

Iremos criar nosso primeiro capítulo para esse livro, escolha um nome e clique em Salvar Capítulo:

image.png

Ao salvarmos, seremos direcionados para dentro do capítulo, onde poderemos criar páginas diretamente nele:

image.png

O processo de criação é exatamente o mesmo da página "solta" que criamos anteriormente, vamos criar aqui então duas páginas com o nome Página de capítulo 01 e Página de capítulo 02, e veja que após criarmos e retornarmos a navegação para o livro Exemplo 01, ele criará com a guia Vermelha um capítulo contendo as duas páginas:

image.png

Vemos no exemplo acima, que existe as páginas, identificadas pela cor verde, e os capitulos, identificados pela cor vermelha, e que dentro dele existem, páginas também identificadas pela cor verde.

A criação de capítulos, está muito mais para uma ordenação de conteúdos, facilitando a navegação por conteúdos e concentrando o mesmo, ao invés de deixar várias páginas soltas. O sistemas não obriga a usar capítulos, é uma escolha individual, mas recomendamos, sempre que existirem várias páginas para um tema, inseri-los num capítulo.

O seu livro ele poderá conter quantos capítulos e quantas páginas forem necessárias, e a ordeção dessas páginas e capítulos ocorre pelo menu, ordenar, visto no canto direito: 

image.png

Ao clicarmos, você será direcionado para ordenção daquele Livro, conforme abaixo:

image.png

Você poderá agora ordenar os capítulos e as páginas conforme entender melhor, veja que ele sugere logo abaixo ao nome do livro Exemplo 01, algumas sugestões, como ordenar por nome, data de criação, e etc, mas o sistema te permite arrastar e soltar os cpítulos e livros conforme sua necessidade, é só com o mouse até os 3 indicadores: image.pngclicar e manter pressionado, e em seguida arraste conforme voce quer deixar o capítulo, e neste momento você podera colocar páginas soltas dentro do capítulo, ou colocar páginas que foram criadas dentro do capítulo fora dele, veja na imagem abaixo após arrastar:

image.png

Veja que a ordem ficou completamente alterada da inicial, ao clicarmos em Salvar Nova Ordenação, você verá o livro com a nova ordenação que você acabou de definir:

image.png

OBS: A ordenação é muito importante para você determinar conteúdos de maior ou menor relevância no seu manual.