Padrao

De UnderLinux Wiki

Visando uma melhor organização e visualização dos documentos contidos no UnderLinux-Wiki, ao criar/modificar as páginas deve-se ser observada as seguintes características:

Linguagem

Ao se escrever um artigo, deve-se tomar cuidado com a linguagem utilizada, preocupando-se em guardar as regras da norma culta da língua portuguesa.

Também deve-se verificar a síntaxe correta dos comandos utilizados para que o leitor possa implementar sem erros o tutorial.

Título

Todos os documentos devem conter um título esclarecedor sobre o conteúdo do texto.

Para adicionar o título, acrescente na primeira linha do texto a seguinte sintaxe:

<center><font size=5pt>'''Título'''</font></center>

Parágrafo

Os parágrafos devem ser criados utilizando a seguinte sintaxe:

<p style="text-indent: 26px;" align="justify">Parágrafo</p>

Código

Vide: Class code

Marcação de texto

<pre> Aqui adicione o seu texto. </pre>

Aqui adicione o seu texto.

Códigos especiais

Você pode usar no seu texto estes códigos abaixo. Eles podem ser usados de diversas formas, use como achar melhor em seu Tutorial ou Artigo.

Código quote

class=”quote”

<p class="quote">class=”quote”</p>

Código yellowbox

class=”yellowbox”

<p class="yellowbox">class=”yellowbox” </p>

Código greenbox

class=”greeenbox”

<p class="greenbox">class=”greeenbox”</p>

Código bluebox

class=”bluebox”

<p class="bluebox">class=”bluebox” </p>

Código redbox

class=”redbox”

<p class="redbox">class=”redbox” </p>

Código greybox

class=”greybox”

<p class="greybox">class=”greybox” </p>

Código alertbox

class=”alert”

<p class="alert">class=”alert” </p>

class=”alert2″

<p class="alert2">class=”alert2″ </p>

Código favorite

class=”favorite”

<p class="favorite">class=”favorite” </p>

Código download

class=”download”

<p class="download">class=”download” </p>

Código info

class=”info”

<p class="info">class=”info” </p>

Código question

class=”question”

<p class="question">class=”question” </p>

Código construction

class=”construction”

<p class="construction">class=”construction”</p>

Código code

class=”code”

<p class="code">class=”code”</p>

Lista

Para se criar uma lista utilize a seguinte sintaxe.

*Item1
*Item2
*Item3
**Item4
**Item5
***Item6
**Item7
*Item8

Isto produzirá o seguinte:

• Item1
• Item2
• Item3
  • Item4
  • Item5
    • Item6
  • Item7
• Item8

Estrutura

Artigos

Um artigo é um texto mais direto que um tutorial, logo pode ser escrito sem a utilização de tópicos.

Autor

Embora essa simplicidade, ainda faz-se necessário a inclusão do tópico "Autor" no final do artigo.

Este tópico deve conter nome ou nickname do(s) autor(es) bem como o e-mail para contato usando a seguinte sintaxe:

*'''Autor1''' (fulano@server.com)
*'''Autor2''' (sicrano@server.com)

Pode-ser colocar também um link para a página de apresentação do autor dessa forma:

*'''[[Usu%C3%A1rio:Autor1|Autor1]]''' (fulano@server.com)
*'''[[Usu%C3%A1rio:Autor2|Autor2]]''' (sicrano@server.com)

Tutoriais

Para uma melhor compreenção. Todos os tutoriais devem apresentar no mínimo a seguinte estrutura de tópicos:

• Introdução
• Conteúdo
• Autor

É preferível utilizar mais tópicos e sub-tópicos como no exemplo abaixo.

• Introdução
• Pacotes necessários
• Instalação
  • Instalação das dependências
  • Instalação do sistema
• Configuração
• Testes
• Conclusão
• Fontes
  • Livros
  • Links
    • Artigos
    • Tutoriais
    • How-to
• Autor

Perceba que o tópico Conteúdo pode mudar de nome tranformando-se em outros tópicos e sub-tópicos, mas os tópicos Introdução e Autor devem manter-se os mesmos.

Para produzir esta estrutura e consequentemente a listagem automática do conteúdo utilize a seguinte sintaxe:

==Introdução==
==Pacotes necessários==
==Instalação==
===Instalação das dependências===
===Instalação do sistema===
==Configuração==
==Testes==
==Conclusão==
==Fontes==
===Livros===
===Links===
====Artigos====
====Tutoriais====
====How-to====
==Autor==

Introdução

Este tópico deve conter uma breve instrodução do que o tutorial contém. Pode-se adicionar o motivo pelo qual o autor resolveu escreve-lo. O ideal é que não ultrapasse 3 parágrafos.

Conteúdo

Este tópico é o tutorial em sí. Quando for editado deve-se tomar cuidado na organização em sub-tópicos.

Autor

Este tópico deve conter nome ou nickname do(s) autor(es) bem como o e-mail para contato usando a seguinte sintaxe:

*'''Autor1''' (fulano@server.com)
*'''Autor2''' (sicrano@server.com)

Pode-ser colocar também um link para a página de apresentação do autor dessa forma:

*'''[[Usu%C3%A1rio:Autor1|Autor1]]''' (fulano@server.com)
*'''[[Usu%C3%A1rio:Autor2|Autor2]]''' (sicrano@server.com)

Entrevistas

Introdução

As entrevistas devem ser precedida por uma breve descrição do entrevistado e suas atividades/contribuições para o SL de no máximo 3 (três) parágrafos.

Pode-se ainda utilizar uma foto do entrevistado na introdução.

Entrevista em sí

A entrevista deve utilizar da seguinte sintaxe para manter uma melhor legibilidade.

<div align=justify>
'''nome_do_entrevistador:''' Pergunta 1

'''nome/sobrenome_do_entrevistado:''' Resposta 1

'''nome_do_entrevistador:''' Pergunta 2

'''nome/sobrenome_do_entrevistado:''' Resposta 2
</div>

Entrevistador

Este tópico deve conter nome ou nickname do(s) entrevistador(es) bem como o e-mail para contato usando a seguinte sintaxe:

*'''Entrevistador1''' (fulano@server.com)
*'''Entrevistador2''' (sicrano@server.com)

Pode-ser colocar também um link para a página de apresentação do usuário dessa forma:

*'''[[Usu%C3%A1rio:Entrevistador1|Entrevistador1]]''' (fulano@server.com)
*'''[[Usu%C3%A1rio:Entrevistador2|Entrevistador2]]''' (sicrano@server.com)

Imagens

O uso de imagens para ilustração dos documentos é liberado, desde que respeitando a Política de uso de imagens.