Welcome to the Slackware Documentation Project

Tutorial e Diretrizes Wiki

Namespaces

Por favor, conheça os conceitos por trás dos namespaces no DokuWiki:https://www.dokuwiki.org/namespaces

Artigos simples

Quando você está criando apenas uma única página, então está OK usar um dos nossos namespaces existentes:

  • howtos:
    O lugar lógico para todos os seus tutoriais
  • security:
    Documentação sobre como lidar com problemas de segurança no Linux (não apenas no Slackware); COMO é sobre como proteger seu computador e aplicativos Linux; como navegar com segurança na Internet; etcetera.
  • slackware:
    Artigos diretamente relacionados à distro
  • wiki:user:
    Onde todo usuário do Wiki pode criar sua própria “home page”
  • Ou qualquer um dos namespaces localizados (nl: de: fr: etcetera) que por sua vez contém os mesmos sub-namespaces mencionados acima

Artigos complexos

Se você adicionar novos tutoriais, etc, que são divididos em vários artigos, conter capturas de tela etc, é aconselhável colocá-los em seus próprios sub-títulos.namespace. Caso contrário, você inundará o namespace atual e a manutenção dos arquivos enviados se tornará uma bagunça para os usuários e administradores.

Quando você adiciona um link dentro de uma página existente que aponta para sua nova página em seu próprio subespaço de nomes, você também precisa adicionar seu próprio namespace ao link.

Você faz isso usando colons, e se você iniciar seu “namespacing” com um ponto '.' você faz o namespace relativo ao namespace das páginas atuais, que é padrão.

Imagine que você esteja editando a página principal de HOWTOs e queira adicionar seu próprio HOWTO chamado “icecast streams” e deseja usar várias páginas conectadas com capturas de tela. Você normalmente adicionaria um link para ele na Página principal do HOWTOS usando o nome da página “.icecast_streams:start”.
Neste Wiki, o HOWTOs index A página é preenchida automaticamente usando a tag “howtos”, então use suas tags com sabedoria.
Esse nome (dentro de um link interno normal) colocaria a página sob o howtos:icecast_streams: namespace. Você pode colocar todos os seus arquivos enviados nesse mesmo namespace.
Note que substituí o espaço em “icecast streams” por um sublinhado. Evitar espaços nos nomes de páginas e namespaces!

Por favor, tente manter uma estrutura de namespace limpa, será muito difícil consertar todos os links se tivermos que fazer correções em locais de páginas e namespaces.

Sintaxe e Formatação

Primeiro familiarize-se com a Sintaxe do DokuWiki. Não é o mesmo que a sintaxe do MediaWiki.

Tente manter a formatação da página o mais limpa possível:

  • O cabeçalho do título principal de uma página deve estar em H1, os títulos abaixo de H2, os títulos em H2 devem ser H3 etc.
  • Não use réguas horizontais a menos que seja necessário (por exemplo, elas não são necessárias se houver um título acima ou abaixo de onde você deseja marcar uma “nova seção”).
  • Envolva sequências de texto contendo comandos de exemplo, nomes de arquivos e texto de computador com uma marcação de “código de texto”. Por exemplo: man rc.inet1.conf. Existe um botão “TT” na barra de botões acima, que irá inserir exatamente essa marcação.

Aqui está um exemplo de como uma página pequena poderia parecer, usando namespaces para subpáginas, etc:

====== Esta é a página ======

Você poderia escrever uma descrição do seu artigo aqui.
Lembre-se de que você pode usar subpáginas (sub-namespaces), quando apropriado.

===== A primeira seção =====

Alguns bla bla

[[.subpage:start | Meu artigo em profundidade]]

===== A segunda seção =====

Mais texto

[[.another_subpage:start | Mais informações com screenshots]]

<!-- You can leave comments in your page - they will not be visible in the resulting Wiki article -->
<!-- Tags are essential for creating a Table Of Contents (TOC) -->
{{tag>howtos software}}

Imagens

Talvez você queira incluir capturas de tela bastante grandes em seus artigos, mas exibi-los em tamanho real diretamente no artigo pode fazer com que as coisas pareçam ruins. Felizmente, você pode redimensionar a imagem diretamente no artigo. Você também pode definir o alinhamento da imagem, alguns exemplos mostrarão mais que palavras:

Redimensionar para determinada largura:

{{wiki:dokuwiki-128.png?50}}

E alinhamento à esquerda/centro/direita como este:

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Veja DokuWiki informações sobre imagens e outros arquivos para mais informações.

Código

Você pode inserir code usando a tag code, assim:

<code c> float a; </code>
float a; 
float b;
a = b * 10 + 2 * sin1(x);

Como este exemplo mostra, a legibilidade é aprimorada muito se você aplicar códigosyntax highlighting ao documentar scripts de shell e tal.

Verificação ortográfica

Por favor, muitos visitantes não têm o inglês como idioma principal. As verificações gramaticais em particular são difíceis para autores não ingleses, então não hesite em contate um de nossos editores de sites para ajudá-lo a criar textos em inglês legíveis e fluentes.

Modelo de texto

Você vai notar que sempre que você criar uma nova página, você já terá algum texto pré-preenchido. Este texto vem de um dos nossos modelos - cada namespace tem um texto de modelo ligeiramente diferente.
O aspecto mais importante do modelo é que ele adiciona padrão tags para sua página. Essas tags nos permitirão preencher nosso Índice automaticamente

Um exemplo de um texto de modelo:

<!-- Add your text below. We strongly advise to start with a Headline (see button bar above). -->


<!-- Please do not add anything below, except additional tags.-->
<!-- However we request that you remove the tag-word "template" below. Otherwise your page will not show up in the Table of Contents -->

<!-- Do not remove this line and the tag definition below. Thanks! slackdocs@-->
{{tag>howtos template}}

Uso de Páginas de Discussão

É uma boa idéia usar as páginas de “discussão” (vinculadas como uma guia no topo de cada artigo) para discutir o conteúdo do artigo, apontar erros, esclarecer dúvidas, trazer algo à atenção do autor e/ou propor quaisquer alterações importantes.

Se você quiser adicionar um comentário a uma página de discussão, reserve alguns momentos para pensar sobre o que deseja escrever antes clicando na guia editar esta página. Tente manter o tempo durante o qual você mantém a página bloqueada tão curta quanto possível, para que você não seja um obstáculo para outras pessoas que também querem comentar. Quando você decide adicionar um comentário a uma página de discussão, há algumas diretrizes que você deve seguir para manter as discussões legíveis e ordenadas:

  • Assine todos os seus comentários clicando no botão Inserir assinatura na barra de ferramentas superior do editor WYSIWYG ou usando o atalho de teclado ALT+SHIFT+Y.
  • Use um Título H2 para adicionar um comentário completamente novo clicando no azul H na barra de ferramentas do editor WYSIWYG superior ou usando o atalho de teclado ALT+SHIFT+2
  • Adicione todos os comentários na parte inferior da página, a menos que você esteja respondendo. Nesse caso, adicione seus comentários diretamente abaixo da postagem à qual você está respondendo. Use os caracteres > para encadear suas discussões, adicionando quantas forem necessárias. Por exemplo:
===== Tópico =====

Comentário Original
> A primeira resposta
>> A segunda resposta
>>> A terceira resposta

Será um pouco parecido com isto:

Você pode se inscrever nas alterações da página de discussão se quiser ser notificado de respostas clicando na guia Gerenciar inscrições enquanto estiver na página de discussão.

Considerações sobre idiomas

Em inglês por favor

O inglês é o idioma principal do projeto de documentação do Slackware. Isso parece natural, já que o Slackware Linux possui um instalador somente em inglês e documentação em inglês. A equipe administrativa quer evitar que esse projeto fique preso em uma bagunça babilônica.

Então, como as contribuições não inglesas estão sendo manipuladas?

por favor, verifique Criando uma página em seu próprio idioma nas Diretrizes de Tradução.


Em outras línguas
Traduções desta página?:
QR Code
QR Code pt-br:slackdocs:tutorial (generated for current page)