O
banco de conhecimentos de
CommentCaMarche / Kioskea (chamado também
KB,
FAQ ou
Dicas) utiliza um layout gráfico de tipo
Wiki.
Eis as possibilidades que ela oferece no plano sintático :
Os títulos
- O título geral é colocado entre dois sinais "igual" ("="). Ele é utilizado unicamente para o título da dica.
- O título de nível 1 é colocado entre dois duplos sinais "igual" ("==").
- * O título de nível 2 é colocado entre dois triplos sinais "igual" ("===").
- .. etc ...
Observações:
- A numeração (1, 1.1, 1.1.1, 1.1.2, 1.2, 1.3, 2 ....) é indicada manualmente (facultativo). Ela faz parte do nome do título;
- Não dê os mesmos nomes aos títulos e subtítulos, isto pode provocar problemas para o índice;
- Não inclua nenhum link nos títulos nem nos subtítulos pelas mesmas razões.
Sintaxe
=Título de nível 1=
==Título de nível 2==
=====Título de nível 5=====
As listas
Sintaxe :
* Ponto nível 1
** Ponto nível 2
*** Ponto nível 3
Observe que é desaconselhado começar por um ponto de nível 2, pois a afixagem sera precedida de um ponto de nível 1 vazio! Cuidado também para não saltar de níveis entre cada item pelas mesmas razões.
Sintaxe recomendada
*Test1
*Test2
**Test2.1
**Test2.2
***Test2.2.1
***Test2.2.2
**Test2.3
***Test2.3.1
****Test2.3.1.1
**Test2.4
**Test2.5
*Test3
*Test4
Resultado:
- Test1
- Test2
- Test2.1
- Test2.2
- Test2.3
- Test2.3.1
- Test2.4
- Test2.5
- Test3
- Test4
Sintaxes desaconselhadas
Começar por um nível diferente de 1
Sintaxe :
****Exemplo
Resultado :
*
Saltar os níveis de pontos
Sintaxe :
*Test1
*Test2
***Test2.1.1
*Test3
Resultado :
O índice
A palavra chave TOC com letra maiúscula e colocada entre duplos sinais '__' cria automaticamente o índice (incluindo os links para as subtítulos do artigo
__TOC__
Observações : tenha o cuidado de:
- Colocar o índice entre o título geral da dica (nível 1) e o primeiro título secundário (nível 2)
- Não deixe muitas voltas à nova linha entre o índice e o corpo da dica nem entre os diferentes níveis de título, pois isto acarreta uma má afixagem do índice.
Os links
Para criar um link, basta utilizar a seguinte sintaxe:
[url texto_do_link]
Deixe um espaço entre o URL e o texto,
é muito importante! Se nenhum texto estiver indicado, o URL sera utilizado como texto.
Link rápido
Você pode fazer um link direto para um artigo utilizando a seguinte sintaxe:
[contents/web/referencement.php3 Palavra chave]
Por exemplo:
[contents/pc/carte-mere.php3 placa mãe]
vai criar automaticamente um link para o artigo da placa mãe.
Por exemplo:
Porque o Kioskea não tem bate-papo
Foi colocado "[",agora sem espaço o URL do artigo/dica "espaço" (um toque)nome do artigo/dica e feche a chave sem espaço"]"
Outros links
- Inserir link hipertexto: utilizar a função para buscar uma dica, artigo, software ou um produto rapidamente. O link será colocado automaticamente na mensagem.
- Inserir link dinâmico [/ CCM]: substitui a palavra selecionada pelo link hipertexto o mais apropriado à palavra selecionada. Esta função é equivalente à dupla chave.
A anchor
(em inglês => âncora: referência hipertexto)
A anchor é constituída pelo título de nível 1 e 2 e o nome desta anchor retoma o nome do título em maiúscula, sem acento, sem caracteres especiais e sem espaço.
[/faq/#anchor-para-o- título-1-ou-2 anchor para o título 1 ou 2]
Note que a sintaxe exata é colocar entre chave ("[]"):
- O símbolo sustenido ("#")
- seguido imediatamente do nome do título ou subtítulo (sem espaço entre eles dois)
- seguido por um espaço
- terminado pelo texto visível do link para a anchor.
É preciso então:
- utilizar somente maiúsculas e letras sem acento,
- não pontuar,
- substituir os espaços por "-",
- não colocar links nos títulos e subtítulos
Assim:
- Nada de "( )",
- Os " ' " são substituídos por " - ",
- Os "ç" são substituídos por "c",
- "1 - título" torna-se "#1- título"
Observação :
- Anchor inteligente! Se você colocar um link em uma dica para um título ou um subtítulo, não faça o link à mão livre, insira o índice, pré visualize sua dica (botão "pré visualizar"), faça um clique direito sobre o título que será o alvo depois copie o URL e cole.
Cole o endereço no lugar em que você deseja inserir seu link depois suprima tudo aquilo que tem a partir de
http até o sustenido (#), por exemplo :
[/faq/5924-layout-da-página-dos-artigos-do-banco-de-conhecimento#5-os-anchors isto é o nome do meu link]
Ficará assim:
[faq/sujet-5924-layout-da-página-dos-artigos-do-banco-de-conhecimento#5-os-anchor isto é o nome do meu link]
As imagens
Acrescentar uma imagem
Você tem três possibilidades:
- Manualmente: Basta seguir a seguinte sintaxe:
[Imagem: url_da _imagem]
- Com o botão Inserir Imagem se sua imagem estiver hospedada na Web ;
- Com o campo Enviar um arquivo se sua imagem estiver presente no seu disco rígido (por exemplo, uma captura de tela): utilizar os botões Parcorrer. Depois de ter clicado em Baixar, a imagem será uplaudade no Kioskea; e o código será inserido completamente no final da dica. A você cabe cortar/colar para colocar a imagem no lugar desejado dentro da dica.
Para maiores informações sobre as imagens do banco de conhecimento:
Inserir uma imagem nos artigos e dicas
veja igualmente aqui :
Inserir uma imagem nas dicas do Kioskea
Acrescentar uma imagem clicável
Com efeito, isto poderá ser útil em caso de necessitar aumentar a imagem para ver os detalhes. A baliza que deverá ser introduzida é a seguinte:
[url_da_imagem [Imagem: url_da_imagem]]
Então: com o URL uploadado em sua dica faça o seguinte,
- copie o URL de http até o formato por exemplo png.
- abra uma chave diante da chave do URL uploadado e cole o URL, dê um espaço. Suprima "-s-" do URL copiado
- Feche novamente com uma chave o primeiro URL
Ficará assim:
[URL copiado+um espaço depois de ter suprimido o que foi explicado acima[URL original fechado com "]]"duplo
Atributos
É possível adicionar atributos complementares, que podem ser acumulados. Os atributos são separados pelo sinal "|" (AltGr+6). Os atributos podem ser colocados em qualquer ordem mas o atributo ALT deve ser sempre o último.
Lista dos atributos
- Posicionamento da imagem à esquerda:
[[url-de-l-imagem|left]]
- Posicionamento da imagem à direita:
[[url-de-l-imagem|right]]
- Posicionamento da imagem no Centro (padrão):
[[url-de-l-imagem|center]]
- Dimensionamento da imagem (en pixels) :
[[[url-de-l-imagem|123px]]]
- Atributo ALT da imagem, trata-se do último atributo antes da chave:
[[url-de-l-imagem|texto]]
Balizas código, negrito, itálico e sublinhado
Para estas balizas, basta selecionar o texto que você desejar carregar seu layout gráfico e clicar sobre um dos botões para este fim, ao alto na zona da edição:
Código
Com esta baliza, o entalhe é preservado e o texto é colocado em azul:
<
code>Code</code>
O que resulta:
Code
Note que ao contrário das outras balizas, a baliza Código coloca-se automaticamente em nova linha e coloca tudo o que tiver depois dele também em nova linha:
Resultado:
Isto é um Teste da baliza <
code>Code<
/code> retorno automático em nova linha
Resultado:
Isto é um Teste da baliza
Code
retorno automático em nova linha
Negrito
<
gras>Texto em negrito</gras>
Resultado:
Texto em negritos
Itálico
<
ital>Texto em itálico</ital>
Resultado:
Texto em itálico
Sublinhado
<
souligne>Texto sublinhado</souligne>
Resultado:
Texto sublinhado
Vela igualmente:
Dicas e conselhos para a redação
A ver igualmente
Comunidade de assistência e de conselho.
Artigo original publicado por
teutates. Tradução feita por
ninha25.