Formatação Padrão
Formatação padrão dos documentos da plataforma
Pré-requisitos:
Antes de começar a conhecer os padrões dos documentos inseridos na plataforma, é necessário que tenha visto o livro que orienta na criação dos livros, capítulos e páginas. Para acessar o livrelivro clique aqui.
Callouts
Existem 3 maneiras que devem ser utilizados os callouts (podendo variar dependendo da situação):
- Para utilizar exemplos e contraexemplos ("Success" e "Danger");
- Para informar ou destacar uma determinada ação ou informação ("Info");
- Para alertar sobre alguma ação ou etapa do processo ("Warning" );
Os callouts de "Success" e "Danger" são excelentes para demonstrar como se deve fazer ou não algum processo, um bom exemplo da utilização deles é a página de espaçamento.
O callout de "Info" destaca um informação na qual é considerada importante na página ou tema inserido.
O callout de "Warning" deve-se utilizar para informar atenção sobre um determinado assunto.
Links
Ao adicionar um conteúdo que tenha ligação direta à outro tema já existente na plataforma, deve-se utilizar o link para referenciar a outra página de maneira que quem esteja lendo, caso queira conhecer esta outra página, basta clicar em alguma palavra ou imagem que contenha o link, que será redirecionado para a mesma.
Links para outras páginas
Quando você utilizar um link que irá redirecionar para outra página, deve-se selecionar a opção "New window", que irá abrir uma nova guia com o conteúdo do link adicionado, que caso você queira voltar para a página anterior, basta fechar a nova página que foi aberta ao clicar no link.
Além disso você deve deixar o link sublinhado, que indicará que é um link e que irá te redirecionar para outra página em uma nova guia.
Links para a mesma página
Quando adicionar um link que aponta para a mesma página, deve-se selecionar a opção de "None", que não irá abrir uma nova guia, mas sim redirecionar direto para a parte da página na qual você adicionou o link.
Caso o link que você for adicionar seja na mesma página e ele seja um título ou subtítulo de algum tópico, você consegue selecionar ele pela aba de adição do link, conforme será mostrado a seguir:
Como visto acima, ao clicar na caixa de Url, a própria Wiki, irá apresentar todos os títulos e subtítulos da página, e selecionando o desejado e salvando, ao clicar na palavra na qual você adicionou o link, será redirecionado direto para aquela parte da página.
Para links que serão direcionados para a própria página, não é necessário deixa-lo sublinhado, mas sim em negrito.
Formatação do texto
A formatação vai depender muito do que estiver sendo adicionado, mas por padrão deve-se seguir algumas maneiras para tornar plataforma mais organizada e padronizada.
A cor padrão é preto, salvo exceções bem especificas e que sejam realmente necessário.
Negrito
Negrito deve ser sempre utilizado para destacar alguma palavra chave ou de extrema importância, de forma que ao ler apenas os termos em negrito, seja possível entender aquele trecho.
Além disso, negrito também é utilizado nos títulos e subtítulos das páginas.
Outro uso para a formatação em negrito é para um link que aponte para a mesma página.
Itálico
O Itálico deve ser utilizado ao adicionar uma palavra estrangeira, que será uma maneira de fácil identificação que a palavra não é oriunda da nossa língua nativa. Que é um método bastante utilizado nos sites de pesquisas.
Sublinhado
O Sublinhado está sendo destinado a links que direcionam a para uma nova página, que deve ser aberta em uma nova guia.
Sobrescrito
O uso de sobrescrito está restrito para a adição de referências. Onde deve-se utilizar um valor numérico após a palavra ou frase que será referenciada no final da página.
Subscrito
O uso de subscrito está restrito para descrições de imagens. Ao adicionar uma imagem, logo em seguida, utilize o subscrito de forma centralizada para identificar a imagem.
Fluxogramas
Ao adicionar um fluxograma na Wiki, caso o mesmo não seja tão grande, adicione diretamente o fluxograma, mas se for um fluxograma grande, que ficará difícil visualizar os textos contidos nele, adicione uma imagem e crie um link nela que direcione para outra página, pois nesta nova página será muito mais fácil de ser visualizada.