De to-do lijst voor de documentatie

Hier presenteren we onderwerpen om aan te werken voor de gebruikersdocumentatie.

Tijdens de PBF zullen we een spreadsheet beschikbaar stellen met alle onderwerpen waaraan gewerkt kan worden. U kunt uw naam op dat blad zetten achter een onderwerp waar u aan werkt, om dubbel werk te voorkomen.

Een gedetailleerde lijst is te vinden op https://github.com/joomla/documentation/issues. Daar is ook discussie over een onderwerp en achtergrondinformatie te vinden. Daar kunt u ook aangeven dat u aan een specifiek artikel werkt, om te voorkomen dat iemand anders aan hetzelfde onderwerp werkt.

In de schijnwerpers: overzichtspagina's

Als u kijkt naar de uitleg in de gebruikershandleiding, ziet u dat deze gegroepeerd zijn per onderwerp. Elk onderwerp heeft een overzichtsartikel, dat vertelt wat voor soort informatie te vinden is op de onderliggende pagina's. Bijvoorbeeld onder Artikelen vindt u 25 pagina's die allerlei zaken rond artikelen uitleggen. In de overzichtspagina worden die pagina's op een gestructureerde manier geïntroduceerd.

Hier is een lijst van overzichtspagina's die ontbreken. Hoe meer artikelen onder die overzichtspagina vallen, hoe groter de behoefte aan een goede overzichtspagina.

In de schijnwerpers: tutorials over het bouwen van een website

Op dit moment richten we ons op tutorials over het bouwen van een website. Stap-voor-stap handleidingen die alle concepten laten zien die gebruikt worden om een website met Joomla te bouwen.

Hoe die tutorials voor het bouwen van een website zijn opgebouwd en welke bestaande artikelen uit de gebruikershandleiding daarvoor gebruikt kunnen worden, is te vinden in dit spreadsheet (werk in uitvoering).

Meer is te vinden in alle subonderdelen van dit issue: ... todo...

Zie het menu aan de linkerkant op de Tutorials pagina. Daar kunt u zien hoe een tutorial eruit kan zien.

Over Tutorials

Een tutorial is bijna nooit compleet. Het laat alleen een manier zien om iets te doen, niet alle alternatieve mogelijkheden om dit te doen.
Hoofddoel is om bepaalde concepten te laten zien die aangeleerd moeten worden. Geen lange uitleg. Een tutorial is leren door te doen.
De tutorial biedt een reeks stappen die de lezer kan herhalen, wat leidt tot een reproduceerbaar resultaat. Het pad is echter belangrijker dan het resultaat.
vaste volgorde:
- Begin met een overzicht van vereisten: welke tutorials gedaan moeten zijn voordat deze gedaan wordt.
- Dan een samenvatting van waar deze tutorial over gaat (kort het voorbeeld beschrijven).
- Dan de te volgen stappen
- Eindig met een conclusie: samenvatting van de behandelde concepten.

Andere onderwerpen waaraan gewerkt kan worden:

Extra velden.
How-to handleidingen met mod_articles.
Tutorial: Een module toevoegen aan het Controlepaneel.
Template overrides.
Nuttige Magazine Artikelen.

Extra velden

Nodig:

een tutorial die uitlegt hoe extra velden te gebruiken; nu: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
Van alle artikelen die momenteel onder "velden" staan, zijn er 4 algemene artikelen (velden en veldgroepen, veldparameters, meertalige websites, en template overrides). Deze staan op hetzelfde niveau als de 15 soorten extra velden en één artikel over een speciaal extra veld: subform. Kun je een betere structuur bedenken in plaats van al deze artikelen op hetzelfde niveau te zetten? Als er een dieper niveau nodig is, vergeet dan de overzichtspagina niet.
een how-to gids over het herhalen van extra velden (met een subform).
voorbeeld van het gebruik van geneste subforms in extra velden (nieuw sinds 5.2).
een referentie (overzicht) van alle extra velden + korte beschrijving.
tutorial over template overrides. Zie https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

Zie de reeks over extra velden van Marc Dechèvre in het Magazine: