A lista de tarefas para a documentação

Aqui apresentamos tópicos para trabalhar na documentação do utilizador.

Durante o PBF iremos fornecer uma folha de cálculo com todos os tópicos em que pode trabalhar. Pode colocar o seu nome nessa folha por trás de um tópico em que está a trabalhar, para evitar trabalho duplicado.

Pode encontrar uma lista detalhada em https://github.com/joomla/documentation/issues. Aí pode também encontrar discussões sobre um assunto e informações de contexto. Pode também marcar aí que está a trabalhar num artigo específico, para evitar que outra pessoa trabalhe no mesmo tópico.

Em destaque: páginas de visão geral

Quando olha para as explicações no guia do utilizador, verá que estão agrupadas por assunto. Cada assunto tem um artigo de visão geral, informando-o sobre que tipo de informação pode ser encontrada nas páginas subjacentes. Por exemplo, em Artigos encontrará 25 páginas que explicam todo o tipo de coisas relacionadas com 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 falta criar. Quanto mais artigos estiverem sob essa página de visão geral, maior a necessidade de uma boa página de visão geral.

Em destaque: tutoriais sobre construção de sítios

Neste momento vamos focar-nos em tutoriais sobre construção de sítios. Guias passo a passo que mostram todos os conceitos utilizados para construir um sítio com o Joomla.

Como esses tutoriais de construção de sítios são elaborados e que artigos existentes do manual do utilizador pode utilizar para isso pode ser encontrado nesta folha de cálculo (trabalho em curso).

Pode encontrar mais em todos os subitens deste issue: ... a fazer...

Veja o menu do lado esquerdo na página de Tutoriais. Lá pode ver como um tutorial pode ser.

Sobre tutoriais

Um tutorial quase nunca está completo. Apenas mostra uma forma de fazer algo, não todas as possibilidades alternativas de o fazer.
O principal objetivo é mostrar alguns conceitos que 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. No entanto, o caminho é mais importante do que o resultado.
ordem fixa:
- Comece com uma visão geral dos pré-requisitos: que tutoriais devem ser feitos antes de fazer este.
- 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 pode trabalhar:

Campos personalizados.
Guias práticos com mod_articles.
Tutorial: Adicionar um módulo ao Painel de controlo.
Sobreposições de temas.
Artigos úteis da revista.

Campos personalizados

Necessário:

um tutorial explicando como utilizar campos personalizados; atualmente: 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 campos, sítios multilingues e sobreposições de temas). Estão ao mesmo nível que os 15 tipos de campos personalizados e um artigo sobre um campo personalizado especial: subform. Consegue imaginar uma estrutura melhor em vez de colocar todos esses artigos ao mesmo nível? Se precisar de uma camada mais profunda, não se esqueça da página de visão geral.
um guia prático sobre como repetir campos personalizados (usando um subform).
exemplo de utilização de subforms aninhados em campos personalizados (novo desde o 5.2).
uma referência (visão geral) de todos os campos personalizados + breve descrição.
tutorial sobre sobreposições de temas. ver https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

Ver a série sobre campos personalizados de Marc Dechèvre na Revista: