Como formatar o artigo

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

it:Come formattare articolo es:Cómo formato artículo 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.



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 wiki

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ítulos

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ítulo

O título do nível 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ível 2 corresponde ao primeiro título de capítulo ou seção.
Exemplo para o título desta seção :

==Capítulos ==

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

Exemplo Resultado 
===Nível de título 3===
====Nível de título 4====
=====Nível de título 5=====

Nível de título 3

Nível de título 4

Nível de título 5


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

Estilos

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

Bold (realce)

Aqui está como acabar em negrito em seu artigo.

Exemplo Resultado 
'''texto bold (realce) '''

texto bold (realce)


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

  • Texto visível de uma GUI
  • Mudança de contexto para um controle, como alterar o usuário ou servidor
  • Hostnames como Servidor - 1
  • Como usuários ikoula
  • Rápida
  • Lista de termos, como :
    • MySQL : mecanismo de banco de dados
    • 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 reverso .

Exemplo Resultado 
''em itálico texto ''

em itálico texto


Notas e avisos

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

Exemplo Resultado 
<div style="background-color: #FFCC99;"> '''Note''': Ceci est une note.</div>



<div style="background-color: #FF9999;"> '''Warning''': Ceci est un avertissement.</div>
Note: Ceci est une note.


Warning: Ceci est un avertissement.



Blockquotes

O Blockquotes 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>. Votre texte sera alors formaté dans un cadre avec une police différente.

Exemplo Resultado

Importante texto ''em itálico ''
ou
<pre>Texte important ''em itálico ''</pre> 

Importante texto em itálico

ou 

Texte important ''em itálico ''

Como você observou, o uso da tag <pre> fait que tout autre formatage à l'intérieur du bloc sera ignoré et considéré comme du texte à afficher. Si vous utilisez la première méthode, avec l'espace en début de ligne, sachez qu'un retour à la ligne fermera le cadre.
Nous préconisons d'Use a tag GeSHi ou la méthode des notes et avertissements pour afficher du code source ou des informations importantes.

Code source

Lorsque vous publiez un code source, vous devez appliquer la balise <syntaxhighlight>. Cela permettra à votre code de bénéficier d'une coloration syntaxique, le rendant plus lisible. Afin d'adapter la coloration au langage utilisé, ajoutez l'option lang="langage" dans la balise.

Exemplo Resultado

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

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


Vous trouverez sur le site de l'extension GeSHi la liste des langages supportés et quelques options supplémentaires, telle l'ajout de numéros de ligne ou la mise en évidence d'une ligne dans le code.

Référence à une application

Lorsque vous mentionnez une application, préférez utiliser la capitalisation du site officiel. Si le site web n'est pas consistent, choisissez une forme et essayez de l'être dans votre article.
Par contre, ne capitalisez pas les noms de paquets ou des commandes, si ces derniers ne le sont pas.
Exemplo :

A MySQL  database vs. the mysql command or the mysql-server package.



Listes

A chaque type de liste son utilisation.

Listes non-ordonnées

Ces listes sont utiles pour :

  • les prérequis
  • les checklists
Exemplo Resultado 
* élément 1
* élément 2
  • élément 1
  • élément 2


Listes de définitions

Ces listes sont utiles pour :

  • les termes et explications
  • explications pour les variables dans une ligne de commande ou un fichier
Exemplo Resultado 
;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


Listes ordonnées

O listes ordonnées sont à utiliser avec parcimonie. Elles peuvent s'avérer pratiques pour lister l'ordre d'un processus, tel que le traitement d'une requête DNS.

Exemplo Resultado 
# élément 1
# élément 2
  1. élément 1
  2. élément 2


Ces listes sont utiles pour :

  • décrire un processus de traitement

Dans certains cas, l’utilisation d'un tableau sera préférable aux listes.

Tableaux

Voici un exemple simple de tableau. Cela peut être utile pour présenter plus facilement un code exemple et son résultat. O tableaux sont structurés comme suit.

{| début de tableau
|+ descriptif du contenu, optionnel; un seul par tableau positionné entre le début du tableau et la première ligne
|- début de ligne, optionnel sur la première ligne -- le moteur de wiki prend en charge la première ligne
! cellule entête, optionnel. O entêtes peuvent être mises soit sur la même ligne séparées par des doubles points d'exclamations (!!), soit sur des lignes séparées, chacune ayant son unique point d'exclamation (!).
| cellule de donnée , requis! O cellules de données consécutives d'un tableau peuvent être soit mises sur la même ligne séparées par une double barre verticale (||), soit sur des lignes séparées, chacune ayant son unique barre verticale (|).
|} fin de tableau


Exemplo Resultado 
{|
|Orange 
|Apple 
|-
|Pão 
|Torta 
|-
|Manteiga 
|Sorvete 
|}
Orange Apple
Pão Torta
Manteiga Sorvete

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.

Exemplo Resultado 
<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.

Exemplo Resultado 
[[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.

Imagens

O images sont considérées comme des fichiers. Vous pouvez donc les inclure et les mettre en ligne de la même manière que les fichiers.
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]]

O options et la description sont facultatives.

Exemplo Resultado 
[[File:sample_image.jpg|200px|thumb|right|modèle image]]
  • 200PX  : tamanho para exibir
  • thumb : a imagem é com tinta em um cenário que irá mostrar a descrição
  • 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 sobre o 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 maiúsculas
  • Use a tag <span>
  • utiliser le symbole + si elles doivent être pressées simultanément
Exemplo Resultado 
Suporte na <span style="background-color: #E6E6E6;">CTRL</span>+<span style="background-color: #E6E6E6;">ALT</span>+<span style="background-color: #E6E6E6;">SUPP</span> Então '''Gerenciador de tarefas '''

Suporte na CTRL+ALT+SUPP Então Gerenciador de tarefas


Nomes de host

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

  • dns_serveur
  • bdd_master
  • proxy_nginx
  • etc.


Nomes de domínio

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ínio - 1TLD , domínio - 2TLD etc. |

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.Domain.TLD , slave.Domain.TLD , bdd.Domain.TLD etc. |

Endereços IP

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. Qualquer 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ções

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.

Nous vous recommandons de mettre en gras les éléments que vous mentionnez et qui sont dans l'interface graphique, que ce soit un bouton, un lien, une case à cocheretc. |
Não se esqueça de adicionar uma descrição, quando você virar a imagem on-line.

Conclusão

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 artigos ! Além disso, você também pode consultar o nosso artigo sobre o estilo iKoulae boa escrita !


Este artigo pareceu-lhe ser útil ?

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=1213"