Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

pt-br:Codex:Regras

Bem vindo! Essa página concentra práticas recomendadas para editores e voluntários do Codex. Se você tiver alguma sugestão para melhorá-la, escreva uma nota no mailing list da documentação do WordPress.

Regras gerais

  1. Escreva "WordPress" da forma correta: WordPress.
  2. Seja legal – sem ataques pessoais ou comportamento rude. Seja profissional, contido e paciente.
  3. Seja preciso, rápido e frequente.
  4. Edite impiedosamente.
  5. Se tiver dúvidas, PERGUNTE.
  6. Divirta-se. :)

Práticas padrão

Novas páginas

Novos artigos são bem vindos. Só que existe um processo...

Se você não é um usuário registrado, siga essas instruções: Contribuindo: Começando do começo.

Se o artigo está bem completo, talvez você deva criá-lo como uma nova página: Veja Criando uma nova página.

Se o artigo está incompleto e há um rascunho, você pode adicioná-lo como uma subpágina da sua página de usuário. Veja Criando uma página de usuário.

Siga o estilo de artigos do Codex estabelecido aqui: Estilos do Codex e Ajuda para edição.

A seguir estão as diretrizes para contribuir para o novo trabalho do Codex:

  1. Se há um artigo parecido com o seu artigo, melhore a página existente (a página mais antiga).
  2. Use a Sandbox para experimentações.
  3. Adicione um link de um outro artigo para o seu artigo e desenvolver as interconexões entre os artigos. Não crie "páginas sem saída" que são páginas sem links para outras páginas do Codex.
  4. Depois que as páginas são criadas, elas já estão ao vivo e todos os links para elas funcionarão. Quando um usuário clica em seu caminho para uma página vazia, desperdiçam seu tempo. só coloque links para páginas que possuem conteúdo o bastante e completo.
  5. Depois de concluído e se mudou para a documentação da sua página de usuário, os links devem ser feitos a partir do "sub" Índice e outros documentos relacionados com o novo artigo. Pergunte se você não tiver certeza de onde se pode criar um link a partir do sub-Índice. Não coloque um link na Página principal sem a permissão da equipe.

Há regras do Codex original que dizem respeito aos artigos e organizações que já estão estabelecidas. O Codex Brasil ainda carece de artigos suficiente para organização em categorias.

  1. Crie páginas adicionando [[Category:pt-br:Nome do artigo]]
  2. Ao criar uma página ou iniciar a tradução, adicione no final {{Codex-pt}} para ser possível rastrear a página criada no futuro.
  3. Se está em processo de tradução incompleta, adicione também {{pt-br-traduz}} isso será útil para as pessoas que quiserem continuar ou terminar o serviço de tradução.

Ao traduzir, remova todos os links que são referencia à paginas não traduzidas. Você pode remover todos o [[ ]]

Há até agora apenas duas categorias criadas para o Codex Brasil:

  • [[Category:pt-br:Funções]] - para as tags de modelos (nível avançado e portanto de menos urgência)
  • {{Codex-pt}} - ao se usar, adiciona todos os artigos que forem em português.

A medida que a quantidade de artigos forem surgindo, criaremos mais categorias, sub-categorias e modelos informativos.

Regras do Codex

Estas regras são estabelecidas pelos administradores do Codex original:

Títulos

Todos os títulos devem estar em maiúscula. Por exemplo, use "Usando o Gerenciador de Links" não "usando o gerenciador de links". Esses títulos devem ser completos. Não é "Intro aos Blogs", mas "Introdução a blogs".

Siga a boa gramática em relação ao uso de iniciais: Em títulos, capitalize a primeira palavra, a última palavra e todas as palavras que estão entre, com excepção de artigos (um, um, e, o), as preposições com menos de cinco letras (em, de, para) e conjunções coordenativas (e, mas). Estas regras aplicam-se aos títulos de obras de longa, curta e parcial, bem como seus papéis artigos (Anson, Schwegler, and Muth. The Longman Writer's Companion 240).

  1. Os títulos são ações ou tarefas orientadas sempre que possível. Assim, "Usando o Gerenciador de Links" é preferível a "O Gestor de Ligações", por exemplo. Que palavras busca um usuário, ao procurar a informação?
  2. Os títulos não devem ter espaços à direita ou à esquerda, ou espaço desnecessário entre as palavras. Tente evitar o uso de símbolos como "-", "#", "?" e "+"
  3. Prefira título curtos.
  4. Por favor, evite usar preposições em títulos, na medida do possível. Nada de 'discutir sobre metas', é mais pratico 'discutir metas'.
  5. O Codex é um wiki dedicado inteiramente ao WordPress, por isso é natural ter "WordPress" nos títulos.
  6. Em caso de dúvidas sobre nomes apropriados e traduções, verifique o Glossário desenvolvidos pelo time de tradutores.
  7. Não use CamelCase (palavras sem espaço) para títulos de página: O Codex não usa CamelCase como alguns outros wikis. Todos os títulos de página e portanto os links devem ser maiúsculas normal. Por exemplo, a página sobre o Codex devia ter o título "Sobre Codex", com o link formatado como: [[pt:br|Sobre o Codex]] e não [[pt:br|SobreCodex]].

Categorias no Codex

Cada artigo no WordPress Codex é classificado com categorias específicas, conforme listado em Special: Categories. Por favor, use uma ou mais das categorias listadas e não crie qualquer nova categoria por enquanto.

Para adicionar uma página à uma categoria, adicione no final, o seguinte código tomando cuidado para não cometer erros na escrita.

[[Category:Nome da Categoria]]

No Codex Brasil, todos artigos devem ter a categoria:

[[Category:Codex-pt]]

Localização: Para documentos de linguagem não-Inglesa no Codex do WordPress, por favor use o código de idioma antes do nome da categoria para a linguagem do grupo documentos específicos:

[[Category:pt-br:Painel de Administração]]

Você também pode incluir a categoria de linguagem específica para todos os documentos nessa língua, tais como:

[[Category:Codex Brasil]]

Link para a Categoria: Para criar um link para uma categoria, use uma vírgula antes da palavra "category" e adicione o link de texto para melhor leitura, tais como:

[[:Category:WordPress_Lessons|WordPress Lessons]]

Aparece como:

Encontre mais informações na WordPress Lessons categoria no WordPress Codex.

Página de Categoria: Páginas de Categoria são criadas automaticamente e personalizadas pela Equipe de Documentação do Codex do WordPress para incluir relacionados e subcategorias.

Mais ajuda: Para obter mais ajuda na compreensão de como as categorias funcionam no Codex do WordPress e MediaWiki, consulteHelp:Editing e MediaWiki Help on Categories (em inglês).


Sub-Páginas

Não crie sub-páginas de uma página, além de sua página de usuário, por enquanto! As exceções a esta são as páginas em Referência de Função/comments_template onde cada função deve ser uma sub-página no formato [[pt:br|Referência de Função|Referência de Função/comments_template]]

Notificações e Discussão

Você vê algo que talvez seja incorreto ou precisa de esclarecimento? A melhor maneira de fazer menção de qualquer problema é usar a função DISCUSSÃO. Por favor, não adicione seus comentários diretamente na página do artigo. No topo de cada página há um guia DISCUSSÃO. Este é o lugar para fazer seus comentários, sugestões, e tal. Obrigado!

  1. deixar mensagens sobre o artigo: Para deixar uma mensagem sobre o artigo, clique na aba Discussão' escreva sua mensagem e assine (veja logo abaixo).
  2. deixar mensagens para os usuários: Deixe uma mensagem para um usuário através da edição da Página de discussão associada ao usuário. O usuário receberá um alerta visual na próxima vez que visitar o Codex para fazer login.
  3. comentários separados: Crie uma linha horizontal entre os comentários na página de discussão, usando quatro traços ---- entre as entradas. Se você está começando um novo tópico de conversa, considere o uso do "+" link seguinte para editar, o que permite que você crie uma nova seção.
  4. Sempre assine seus comentários: Para adicionar a sua assinatura em um comentário, adicionar quatro ~ (til) no final do seu comentário. Isto irá listar o seu nome de usuário e um link para sua página de usuário e adicionar um carimbo de tempo. Isto é muito útil para páginas de discussão.