Joomla! Documentation™

A documentação do Joomla! é distribuída com o MediaWiki. Seu crescimento e sucesso dependem de pessoas como você. Obrigado por dar o primeiro passo para contribuir com o Projeto Joomla!. Esta página mostrará como começar e várias maneiras de ajudar no esforço de documentação.

New Documentation

Começando!

Há algumas coisas que você precisa fazer primeiro.

Ler as diretrizes da wiki

Você precisa revisar as diretrizes da Wiki da documentação do Joomla! antes de começar a editar.

Criar uma conta de usuário

Para editar a wiki da documentação do Joomla!, você precisará de uma conta de usuário. Você pode registrar uma aqui. Depois, certifique-se de confirmar seu endereço de e-mail. A confirmação do seu endereço de e-mail lhe dará permissão para editar qualquer página, exceto algumas que são protegidas.

Observação: se você não fizer nenhuma edição dentro de 5 dias após a criação da sua conta, ela será automaticamente excluída por motivos de segurança.

Criar uma página de usuário

Depois de criar uma conta, confirmar seu endereço de e-mail e fazer login, recomendamos que você reserve alguns minutos para criar uma página de usuário. Criar uma página de usuário serve para alguns propósitos:

• Permite que os usuários descubram mais sobre você.
• Permite que você faça algumas edições iniciais para que o Filtro de spammer e abuso da wiki possa ver que você não é um usuário falso. Observe que, para suas primeiras edições, não inclua links externos, pois isso será o que provavelmente acionará os filtros.

Uma dica rápida para começar sua página de usuário:

• No menu do usuário, vá para sua página de Nome de usuário (ou use o primeiro item do menu no menu suspenso da extrema direita)
• Clique no botão suspenso de ações
  
• Clique em "Criar"
• Adicione o código ao editor {{subst:Newuser}}
• Preencha o resumo (por exemplo, Esta é minha nova página de usuário)
  
• Clique no botão "Salvar"

Junte-se aos canais de comunicação da documentação

A ferramenta oficial de comunicação do Joomla! é o Mattermost. Veja esta página para informações sobre como participar da conversa e, quando estiver lá, participe do canal PD Documentation para participar da discussão sobre a documentação do Joomla!

O que devo fazer primeiro?

Existem várias áreas de documentação que sempre precisam de atenção. Você pode começar escolhendo aquela que é mais confortável para você trabalhar ou pode se envolver mais trabalhando em várias ao mesmo tempo. Depois de ter uma conta na Wiki, você está livre para trabalhar em qualquer aspecto da documentação que lhe agrade. Até mesmo as contribuições mais simples, como correções ortográficas e correções gramaticais, são uma ajuda tremenda!

1. Ajudar com o conteúdo da documentação.
2. Tarefas de manutenção.
3. Juntar-se ao ou iniciar projeto de documentação.
4. Ajudar com telas de ajuda.
5. Explicação da tradução de páginas

Ajudar a gerenciar nosso conteúdo

1. Edição, reescrita e reorganização de páginas. Verifique nossas páginas de necessidades para áreas que precisam de ajuda imediata. Elas são chamadas de Páginas de necessidades porque precisam de pequenas tarefas para serem concluídas. Algumas delas são tão simples quanto revisar conteúdo ou adicionar uma imagem. Outras exigem mais conteúdo ou melhorias. Escolha algumas, dê a elas um pouco de amor. Esta é uma ajuda tremenda para os usuários do Joomla! que confiam em nossa documentação.
2. Divirta-se e navegue por artigos redundantes, fora da versão (por exemplo, 1.0 e 1.5) ou que precisam ser divididos devido a informações específicas da versão. Então sinta-se à vontade para usar as predefinições {{delete}}, {{merge}} ou {{JSplit}} nos artigos. Clique nos links das predefinições anteriores para ver como usá-las e aplicá-las a artigos que você acha que precisam dessas predefinições marcadoras. Adicione-os ao topo de uma página e a página será marcada.
3. Crie uma nova página ou tutorial. Se você quiser começar uma nova página, faça uma pesquisa extensa primeiro. Não crie um novo artigo se já existir um. Use o recurso de pesquisa da wiki de documentação para ver se seu tópico já está em um artigo. Duplicações serão mescladas e/ou excluídas. Não tenha medo de modificar, reformatar ou melhorar o trabalho de outra pessoa na wiki de documentação do Joomla!. Esta é uma wiki de documentação colaborativa. Apenas certifique-se de seguir nossas diretrizes e orientações.
   1. Using Wikilinks. It's very easy to link pages using a standard syntax. If you create a link to an article that doesn't exist yet, the link will be colored red. Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created. Once the page has been created, the link will change from red to blue indicating that the article now exists.
   2. Using the URL. To use when you want to create a page from scratch. You can use the Wiki's URL for creating a new page. The URL to an article of the Wiki is usually something like this: https://docs.joomla.org/YOURTITLE. If you replace YOURTITLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the Create this page link will take you to the edit page for that article, where you can create the new page by typing your text, and clicking Submit.
4. Ajude a atualizar imagens nos artigos. Verifique a categoria Necessita atualização das imagens para uma lista de páginas que precisam ter suas imagens atualizadas. Nossas orientações para ajudá-lo podem ser encontradas no artigo Diretrizes para nomear imagens.

Manutenção da Wiki

Manter uma wiki e mantê-la organizada exige muito trabalho contínuo por parte de administradores, editores e usuários. Há sempre tarefas que precisam de atenção, como: Categorização, atendimento em páginas com necessidades, que estão em construção, ou marcação de páginas para exclusão, mesclagem ou divisão. Para todas as tarefas de manutenção e ideias de como você pode ajudar, visite nossa página de Manutenção da documentação.

Projetos de documentação

• A equipe de documentação está trabalhando em tutoriais para iniciantes. Nosso objetivo é torná-los fáceis de entender e navegar, algo que um iniciante possa seguir facilmente e aprender conceitos básicos. Pense em quando você era novo no Joomla! e adicione um tópico sobre algo com o qual você lutou como iniciante na página. Melhor ainda, junte-se ao Projeto de tutoriais para iniciantes.
• Participe do Projeto de tutoriais de desenvolvedores e compartilhe seus conhecimentos. Assine seu nome usando quatro tils ( ~~~~ ) na página do Projeto de tutoriais de desenvolvedores e liste o que você pode fazer. Sinta-se a vontade para criar novos tópicos de tutoriais na lista de sugestões.

Telas de ajuda

Desconhecido para muitos, todas as páginas da Tela de ajuda são criadas e servidas para cada instalação do Joomla! no mundo todo a partir desta wiki! Elas são necessárias para iniciantes e até mesmo para aqueles com conhecimento intermediário do Joomla!.

As telas de ajuda do Joomla! 4.x precisam ser revisadas e atualizadas. Qualquer contribuição que você der a elas será apreciada por muitos usuários no mundo todo e estamos procurando voluntários para ajudar com essa importante tarefa. Uma matriz precisa ser colocada em prática, assim como um plano de ação.

Coisas para lembrar

Aqui estão algumas coisas para lembrar como colaborador da documentação do Joomla!.

• Não tenha medo de quebrar uma página, se fizer isso e algo der muito errado, reverta sua edição. Clique na aba Histórico da página e você verá links para desfazer e reverter.
• Escreva artigos com a sensação de que eles serão traduzidos para outro idioma. Usar gírias ou dialetos locais pode não traduzir para outro idioma ou suas inferências podem ser compreendidas. Saiba mais sobre Traduzindo documentação do Joomla!.
• Não tenha medo de baixar e ler as Diretrizes gerais de texto da interface do usuário do Joomla! en-GB que se aplicam a toda a documentação do Joomla!. Há dicas úteis sobre como escrever para a documentação do Joomla!.
• Palavras para observar ao escrever para feedback instantâneo use os navegadores Google Chrome ou Mozilla Firefox. Ambos têm verificação ortográfica integrada que sublinha uma palavra com erro de ortografia.
• Não se esqueça de adicionar a predefinição {{inuse}} a um artigo no qual você vai trabalhar por um longo período de tempo, mais de um minuto. Isso ajuda a evitar conflitos de edição.

Socorro, não conheço a marcação wiki!

Se você é novo no uso de wikis e na marcação simples para criar páginas, use o seguinte para obter ajuda:

• O novo WikiEditor contém botões e links rápidos para facilitar a construção de páginas. Clique na palavra Avançado para um menu suspenso com mais botões e links de formatação rápida.
• Use a Folha de dicas da wiki da JDOC para aprender os comandos básicos de sintaxe. Há também um menu suspenso da marcação comum no editor. Basta clicar na palavra Ajuda uma vez e ela aparecerá.
• Ainda com medo? Experimente estas ferramentas para ajudar você a criar ótimas páginas wiki.

• Complemento do Microsoft Word para marcação wiki, salve documentos do Word na marcação wiki.
• As versões 2.4 e posteriores do OpenOffice.org têm um filtro de exportação do MediaWiki incorporado. Basta abrir um documento do Writer e clicar em "Arquivo - Exportar". Em seguida, altere o formato do arquivo para MediaWiki.
• Aqui está uma lista de ferramentas disponíveis para converter outros formatos para marcação wiki, por exemplo, HTML, Excel, CSV. Alguns deles são conversores online, cortam e colam HTML para uma saída em marcação wiki.

Obtenha ajuda em Mattermost (Temos muitos canais lá. Por exemplo, um para o Grupo de tradução da documentação do Joomla! e um para o Grupo de trabalho da documentação do Joomla!).

• Poste uma pergunta em uma página de discussão de um administrador ou editor.