Aqui apresentamos tópicos para trabalhar na documentação do usuário.
Durante o PBF forneceremos uma planilha com todos os tópicos nos quais você pode trabalhar. Você pode colocar seu nome nessa planilha atrás de um tópico em que está trabalhando, para evitar trabalho duplicado.
Você pode encontrar uma lista detalhada em https://github.com/joomla/documentation/issues. Lá você também pode encontrar discussões sobre um assunto e informações de contexto. Você também pode marcar lá que está trabalhando em um artigo específico, para evitar que outra pessoa trabalhe no mesmo tópico.
Em destaque: páginas de visão geral
Ao observar as explicações no guia do usuário, você verá que elas estão agrupadas por assunto. Cada assunto tem um artigo de visão geral, informando que tipo de informação pode ser encontrado nas páginas subjacentes. Por exemplo, em Artigos você encontrará 25 páginas explicando todo tipo de coisas relacionadas a artigos. Na página de visão geral, essas páginas são apresentadas de forma estruturada.
Aqui está uma lista de páginas de visão geral que estão faltando. Quanto mais artigos houver sob essa visão geral, maior a necessidade de uma boa página de visão geral.
Em destaque: tutoriais sobre construção de sites
No momento vamos focar em tutoriais sobre construção de sites. Guias passo a passo mostrando todos os conceitos usados para construir um site com o Joomla.
Como esses tutoriais de construção de sites são estruturados e quais artigos existentes do manual do usuário você pode usar para isso pode ser encontrado nesta planilha (trabalho em andamento).
Você pode encontrar mais em todos os subitens desta issue: ... a fazer...
Veja o menu do lado esquerdo na página de Tutoriais. Lá você pode ver como um tutorial pode se parecer.
Sobre Tutoriais
- Um tutorial quase nunca está completo. Ele apenas mostra uma forma de fazer algo, não todas as possibilidades alternativas de fazê-lo.
- O objetivo principal é mostrar alguns conceitos que você deseja ensinar. Sem explicações longas. Um tutorial é aprender fazendo.
- O tutorial oferece uma série de passos que o leitor pode repetir, levando a um resultado reproduzível. O caminho, porém, é mais importante do que o resultado.
- ordem fixa:
- Comece com uma visão geral dos pré-requisitos: quais tutoriais devem ser feitos antes deste.
- Depois, um resumo sobre o que trata este tutorial (descrevendo brevemente o exemplo).
- Depois os passos a seguir
- Termine com uma conclusão: resumo dos conceitos abordados.
Outros tópicos em que você poderia trabalhar:
- Campos Personalizados.
- Guias de como fazer com mod_articles.
- Tutorial: Adicionar um módulo ao Painel de Controle.
- Substituições de tema.
- Artigos úteis da Revista.
Campos Personalizados
Necessário:
- um tutorial explicando como usar campos personalizados; agora: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
- De todos os artigos atualmente em "campos" há 4 artigos gerais (campos e grupos de campos, parâmetros de campo, sites multilíngues e substituições de tema). Eles estão no mesmo nível que os 15 tipos de campos personalizados e um artigo sobre um campo personalizado especial: subformulário. Você consegue propor uma estrutura melhor em vez de colocar todos esses artigos no mesmo nível? se precisar de uma camada mais profunda, não esqueça a página de visão geral.
- um guia prático sobre como repetir campos personalizados (usando um subformulário).
- exemplo de uso de subformulários aninhados em campos personalizados (novo desde a versão 5.2).
- uma referência (visão geral) de todos os campos personalizados + breve descrição.
- tutorial sobre substituições de tema. veja https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides
Veja a série sobre campos personalizados de Marc Dechèvre na Magazine:
- JCM março de 2018, episódio 1: Até onde podemos ir com o Joomla! e os Campos Personalizados?
- JCM maio de 2018 episódio 2: como gerenciar seus Campos Personalizados
- JCM outubro de 2018 episódio 3: todos os parâmetros que se pode desejar
- JCM abril de 2020 episódio 4: um tutorial passo a passo
- JCM julho de 2021 episódio 5: Lista de Recursos (não é necessário listá-los novamente aqui, mas esta é uma referência muito útil)
- JCM agosto de 2021 episódio 6: Faça mais com extensões
- JCM outubro de 2021 episódio 7.1: um Campo Personalizado para governar todos
- JCM novembro de 2021 episódio 7.2: sem limites
Há algo nesses artigos que deveria estar na documentação?
Guias práticos com mod_articles
- Substituição em Acordeão para o Módulo de Artigos
- Como criar um Calendário do Advento usando o novo Módulo de Artigos no Joomla 5.2
Também: atualizar https://docs-core.sandbox.joomla.org/user-manual/modules/modules-site-modules para mod_articles.
Tutorial: Adicionar um módulo ao Painel de Controle
Substituições de tema e modelos de visualização alternativos
- Gerenciamento Aprimorado de Substituições do Joomla
- Substituições de Tema - Reciclar e reutilizar
- Managing Template Overrides in Joomla (2024-12)
- Aqui está um bom post no blog da Viviana (em alemão) sobre substituições de tema para edição no site: https://www.dr-menzel-it.de/blog/override-challenge-beitrag-einreichen-im-frontend. Isso definitivamente deveria estar na documentação!
Artigos úteis do Magazine
Alguns destes podem ser usados como base para um artigo de documentação.
Mover para a lista de tarefas do Manual de Desenvolvedores
- How to Use Event Classes for Plugin Development
- Selecting data using JDatabase
- Inserting Updating and Removing data using JDatabase