Como formatar o artigo

Fonte: Pt Ikoula wiki
Revisão em 15h05min de 6 de outubro de 2015 por Ikbot (discussão | contribs)
Ir para navegação Ir para pesquisar

en:How to format article fr:Comment formater son article

Este artigo foi traduzido por um sistema de tradução automática. Você pode visualizar a fonte do artigo aqui.

fr::de:Artikel formatierenfr:de:Artikel formatieren




Este artigo descreve como formatar o seu tutorial. Seguindo este guia e um o estilo de escrita, seu tutorial aplicará as recomendações de ikoula.


Sintaxe wik

TUTORIAIS ikoula deve ser formatada usando o sintaxe wiki. Este artigo vai lhe dar os exemplos mais comuns desta sintaxe. Você pode encontrar mais detalhes no seção de ajuda do MediaWiki Quanto a formatação do wiki.


Capítul

Para cortar seus tutoriais em capítulos, você pode usar os níveis de título. Assim que você coloca um título na página, todos os seguintes itens serão considerados como parte do novo capítulo, até o próximo título do mesmo nível.
Isso pode ser muito útil para melhorar a legibilidade do seu artigo cortando as diferentes fases de realização.

Os diferentes níveis de títul

O título do nív 1 corresponde ao título do artigo. Ele é criado automaticamente quando você criar sua página. As faixas são construídas em torno de seu título por sinais "=". O título do nív 2 corresponde ao primeiro título de capítulo ou se
Exemplo para o título desta seção :

==Chapitres==

Mais você vai assinar em torno de seu título, quanto mais você descer da árvore.

Exempl Resultad 
===Titre de niveau 3===
====Titre de niveau 4====
=====Titre de niveau 5=====

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5


É interessante notar que uma tabela de conteúdo aparece automaticamente na cabeça do artigo, assim como ex 4 capítulos ou subcapítulos.

Estil

Você pode formatar o texto usando a sintaxe wiki e algumas tags HTML.

Bol

Aqui está como acabar em negrito em seu artigo.

Exempl Resultad 
'''texto bold ('''

texte en gras


Aqui está uma lista de itens que devem ser em negrito.

  • Texto visível de uma
  • Mudança de contexto para um controle, como alterar o usuário ou servidor
  • Hostnames como Servido1
  • Como usuários ikoula
  • Rápid
  • Lista de termos, como :
    • MySQL: mecanismo de banco de dad
    • Apache: webserver
  • Elementos que o jogador não deve perder, fazê-lo sem muita coisa.


Italic

Itálico só deve ser usado para introduzir termos técnicos. Por exemplo : o nginx servidor será usado como proxy revers.

Exempl Resultad 
''em itálico text''

texte en em itá


Notas e avisos

O uso de algumas tags HTML pode ser necessário destacar certos elementos, tais como notas ou avisos.

Exempl Resultad 
<div style="background-color: #FFCC99;"> '''Not''': Esta é uma nota.</div>



<div style="background-color: #FF9999;"> '''Aviso ''': Este é um aviso. </div>
Note: Ceci est une note.


Warning: Ceci est un avertissement.



Blockquotes

O Blockquote são blocos onde seu texto é formatado de forma diferente. Para fazer isso, basta colocar um espaço no início da frase, ou coloque seu texto das tags <pre>. Então, seu texto será formatado em um cenário com uma fonte diferente.

Exempl Resultad

Texte important ''italique''
ou
<pre>Texte important ''italique''</pre> 

Texte important italique

ou 

Texte important ''italique''

Como você observou, o uso da tag <pre> fato que qualquer formatação dentro do bloco será ignorado e considerado o texto para exibir. Se você usar o primeiro método, com o espaço no início da linha, estar ciente de que um retorno à linha irá fechar o quadro.
Nós recomendamos para usar a tag GeSHi ou o método de Notes e avisos para visualizar o código fonte ou informações importantes.

Código fo

Quando você publicar o código fonte, você deve aplicar a tag <syntaxhighlight>. Isso permitirá que seu código para beneficiar um realce de sintaxe, tornando-se mais legível. A fim de adaptar-se a coloração para a linguagem usada, adicione lang="idioma" na marca.

Exempl Resultad

<syntaxhighlight lang="php">
<?
     $hello = "Hello World";
     echo $hello; // comment
?>
</syntaxhighlight> 

<?
    $hello = "Hello World";
    echo $hello;         // comment
?>


Você vai encontrar no site da extensão GeSHi a lista de idiomas suportados e algumas opções adicionais, como a adição de números de linha ou destacar uma linha no código.

Refere-se a um aplicativo

Quando você menciona um aplicativo, prefira usar a capitalização do site oficial. Se o site não estiver consistente, selecione uma forma e tentar ser em seu artigo.
Por outro lado, não capitalize não os nomes dos pacotes ou ordens, se eles não são.
Exempl :

Um vs de banco de dados MySQL. o comando mysql ou o pacote mysql-server.



Lista

Cada tipo de uso da lista.

Não-ordenados lista

Essas listas são úteis p :

  • os pré-requi
  • as listas de
Exempl Resultad 
* élément 1
* élément 2
  • elemento 1
  • elemento 2


Listas de definição

Essas listas são úteis p :

  • termos e explicações
  • explicações para as variáveis em uma linha de comando ou arquivo
Exempl Resultad 
;mot 1
: définition 1
;mot 2
: définition 2-1
: définition 2-2
mot 1
définition 1
mot 2
définition 2-1
définition 2-2


Ordenou listas

Listas ordenadas são para ser usado com moderação. Pode ser prático listar a ordem de um processo, como o processamento de uma consulta DNS.

Exempl Resultad 
# élément 1
# élément 2
  1. élément 1
  2. élément 2


Essas listas são úteis p :

  • descrever um processo

Em alguns casos, o uso de uma tabela será preferível listas.

Tabelas

Aqui está um exemplo simples de uma tabela. Isso pode ser útil para o código de exemplo mais facilmente presentes e seu resultado. As tabelas são estruturadas da seguinte maneira.

{| início tabela
|+ Visão ge conteúdo, Opcional; um por tabela posicionada entre o início da matriz e a primeira linha
|- início da lin, Opcional na primeira linha -- o mecanismo wiki suporta a primeira linha
! célul cabeç, opcional. Os cabeçalhos podem ser colocados também na mesma linha, separada por pontos de exclamações duplo (!!), ou separado no linhas, cada uma com seu exclusivo ponto de exclamação (!).
| célula d dados , neces! As células de dados da tabela consecutivos podem ser também colocadas na mesma linha separada por uma barra vertical dupla (||), ou separado no linhas, cada uma com sua única barra vertical (|).
|} participante


Exempl Resultad 
{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
Orange Apple
Bread Pie
Butter Ice cream

Para obter mais informações sobre tabelas, favor consultar o Manual wikimedia

Scripts e arquivos

Certifique-se de descrever o papel dos arquivos ou scripts que você menciona. Desta forma, o leitor terá o mesmo nível de informações que você e será mais capaz de entender a sua abordagem.

Scripts

Quando você dá o conteúdo de um script ou um arquivo de configuração, certifique-se que é comentado, de preferência a nível das linhas em questão. O objetivo é que o leitor compreender todas as ações descritas, por isso é importante ser mais educativo quanto possível. Desta forma, será mais capaz de personalizar, actualizar ou diagnosticar problemas com o seu servidor a longo prazo.

Se os arquivos que você postar tem peças longas e /ou não é interessante para o seu tutorial, você pode omitir estas festas com a elipse (...).
Recomendamos o uso da Balise para exibir o conteúdo dos scripts ou arquivos. Este último lhe permitirá, além do realce de sintaxe, basta indicar os números das linhas e destacar o mais importante. É recomendável que você usar o realce para indicar as linhas onde existem alterações para executar.

Exempl Resultad 
<syntaxhighlight lang="apache" line start="10" highlight="5">
<VirtualHost *:80>
    DocumentRoot /www/example1
    ServerName www.example.com
    # Other directives here
</VirtualHost>
</syntaxhighlight>

10<VirtualHost *:80>
11    DocumentRoot /www/example1
12    ServerName www.example.com
13    # Other directives here
14</VirtualHost>


Arquivo

Você tem a possibilidade de inserir um arquivo ou uma imagem no seu tutorial. A maneira mais simples de conseguir a coisa é mencionar o documento em seu artigo, depois de colocar online uma vez concluída a escrita. Se o arquivo não existir, ele será ser apontado por um link vermelho. Clicando neste link, você chegará a uma página que lhe permite fazer upload de seu arquivo.

Exempl Resultad 
[[Media:mon_fichier.txt]]

Media:mon_fichier.txt

É interessante notar que o link para o arquivo depende exclusivamente o nome do arquivo. É recomendável que você use nomes como descritivos como arquivos possíveis. Não se esqueça de incluir uma descrição do arquivo quando você colocá-lo on-line.

Image

Imagens são tratadas como arquivos. Você pode, portanto, incluí-los e colocá-los on-line da mesma forma como arquivos.
A única diferença com um arquivo é que a imagem será exibida no texto. O que lhe dá mais opções para exibir.

A sintaxe para cumprir é : 

[[File:sample_image.jpg|options|description]]

Descrição e opções são opcionais.

Exempl Resultad 
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200P : tamanho para exib
  • thumb : a imagem é com tinta em um cenário que irá mostrar a descr
  • right : alinhamento da imagem certa
modèle image


Você pode encontrar mais informações sobre as diferentes opções disponíveis sobre a manipulação de imagem manual do MediaWiki.
Evite usar imagens muito pesadas e preferem usar formatos jpg, jpeg e png.

Chaves de teclado

Para descrever as teclas do teclado, siga estas recomendações :

  • escrevê-los em letras
  • Use a tag <span>
  • Use o símbolo + Se eles têm que ser pressionadas simultaneame
Exempl Resultad 
Suporte na <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Ent '''Gerenciador de tarefas '''

Appuyer sur CTRL+ALT+SUPP Ent Gerenciador de tarefas


Nomes de ho

É recomendável que você usar nomes de host o mais específico possível, que é em relação ao papel do servidor.
Exempl :

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • etc.


Nomes de domí

Quando você está lidando com nomes de domínio, prefiro usar o campo Domain.TLD como o domínio padrão. Se você tiver vários nomes de domínio para mencionar, você pode escolher usar nomes como domíni1TLD, domíni2TLDetc. |

Para subdomínios, recomendamos que você use um nome em conexão com o papel para o qual será anexado este subdomínio, como master.Domaine.tl, slave.Domaine.tl, BDD.Domaine.tletc. |

Endereços

Para evitar para divulgar seu IP em seus tutoriais e ser o mais claro possível, nós convidamos você a conhecer o endereços reservados a documentação. No nosso caso, nós preferimos usar o bloco de endereços 203.0.113.0/24 por tudo o que é o endereço público. Qua 203.0.113.0 à 203.0.113.255.

Para os endereços de redes locais e localhost, você pode manter o IP que você costuma usar. Significa :

  • 10.0.0.0/8 - 10.0.0.0 – 10.255.255.255
  • 172.16.0.0/12 - 172.16.0.0 – 172.31.255.255
  • 192.168.0.0/16 - 192.168.0.0 – 192.168.255.255
  • 127.0.0.0/8 - 127.0.0.0 – 127.255.255.255



Liga

Créer un lien

Screenshots

Se seu tutorial descreve as acções a realizar em uma interface gráfica, é melhor incluir capturas de tela para torná-la mais clara. Tenha cuidado, porém não ser também. Não é questão de ter uma imagem para cada botão, texto ou link caixa, mas apenas o que é preciso para drive bem sucedido para segui-lo.
Se você deseja capturar destacar itens, por favor, sinta-se livre para adicionar setas ou frames para o ponto. Isto só será o tutorial só abrangente.

Recomendamos que você coloque os elementos que você menciona na gordura e que estão na interface gráfica, que é um botão, um link, uma caixa de seleção, etc. |
Não se esqueça de adicionar uma descrição, quando você virar a imagem on-line.

Conclusã

Por favor, inclua uma conclusão curta para o seu tutorial que irá resumir o que foi feito e apresentar o que pode ser feito posteriormente.
Você tem tudo que você precisa para criar seus próprios a ! Além disso, você também pode consultar o nosso artigo sobre estilo iKoulae boa escrita !


Este artigo pareceu-lhe ser út ?

0



Não tem permissão para colocar comentários.

Obtida de "https://pt-wiki.ikoula.com/index.php?title=Como_formatar_o_artigo&oldid=1807"