Joomla! Documentation™

This Article Needs Your Help

Als documentatie schrijver heeft u de erbarmelijke taak om materiaal te schrijven voor een brede groep aan lezers - van beginnende gebruikers tot geavanceerde professionele ontwikkelaars. U dient kennis te hebben van de verschillende gebruikte tools (zoals deze wiki) en u dient de richtlijnen en overige meta documenten te lezen. Hoogstwaarschijnlijk zult u na verloop van tijd ook deze documenten aanpassen.

Algemeen

Let op dat de officiële taal van het project Brits Engels (en-GB) is. Er is een tendens dat Amerikaanse spelling in de documentatie kruipt, voel u vrij dit te corrigeren waar u dat ziet.

Het volgende materiaal is belangrijk bij het werk als documentatieschrijver op alle gebieden van het Joomla! project.

• Lees aub de Joomla! en-GB redactionele stijlgids.
• Woorden om te bekijken

Documentatie wiki

Het grootste deel van de documentatie inspanning draait om deze wiki.

• Raadpleeg aub de Docs Wiki roadmap voor een compleet overzicht met taken.
• Als u nieuw bent met de MediaWiki raadpleeg dan de Gebruikershandleiding voor informatie over het gebruik van de Wiki software.
• Er zijn een aantal afspraken om te zorgen dat de Wiki georganiseerd blijft.
  • Probeer de Afbeelding naamgeving afspraken te gebruiken.
  • Probeer te letten op de afspraken voor het labellen van pagina's met Joomla! versienummers.
• U wilt misschien kijken bij:
  • de opgeroepen maar nog lege pagina's
  • de Koekjesdoos: een lijst met pagina's die ingedeeld zijn als kleine, goed gedefinieerde taken die minimale inspanning vragen om te voltooien
  • Artikelen die een beoordeling vereisen
  • Artikelen waarvoor informatie nodig is: u kan degene zijn die de details kent
  • Landingpagina's: pagina's die overeenkomen met belangrijke zoekwoorden, gebruikt door mensen die zoekmachines gebruiken om documentatie te vinden.
• Pagina's die termen definiëren kunnen toegevoegd worden aan de Woordenlijst, maar niet door het toevoegen van [[Category:Glossary]] aan de pagina. Kijk aub bij Talk:Glossary voor meer informatie.

Interne verwijzingen

• Lijst met local wiki templates die kunnen worden gebruikt op uw wiki pagina's. Templates verminderen herhalingen en zijn de basis van modulaire documentatie.
• Lijst met local wiki extensions die op deze wiki geïnstalleerd zijn. Extensies bieden toegevoegde functionaliteit aan de wiki zoals syntax highlighting en link search.
• Lijst met local interwiki links die beschikbaar zijn op deze wiki. Deze bieden handige snelkoppelingen om URL's te maken naar andere websites inclusief het Joomla! forum, helpschermen en issue tracker; zowel als links naar de PHP documentatie of de Wikipedia.

Helpschermen

De Documentatie werkgroep is verantwoordelijk voor het schijven en onderhouden van de officiële helpschermen. Voor Joomla! versies tot en met 1.5.x moeten de helpschermen gehost worden op een Joomla! site. Vanaf Joomla! 1.6 worden de helpschermen gehost op deze wiki.

• Zie Categorie: Helpschermen.
• Een lokale help server opzetten