JDOC

Hoe een bijdrage leveren aan Joomla! documentatie

From Joomla! Documentation

Revision as of 15:21, 18 August 2023 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎eesti • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎Ελληνικά • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎中文(台灣)‎ • ‎日本語

Joomla! documentatie wordt ondersteund door dezelfde software die Wikipedia gebruikt. De groei en het succes hangt af van personen als jij. Bedankt voor het nemen van de eerste stap in de richting van het bijdragen aan het Joomla!-project. Deze pagina laat zien hoe te beginnen en diverse manieren om te helpen bij de documentatie-inspanning.

Aan de slag!

Er zijn een paar zaken die je eerst moet doen.

Lees het Wiki beleid

U moet het Joomla! documentatie Wiki beleid bekijken voordat u begint met bewerken.

Maak een gebruikersaccount aan

Om de Joomla! documentatie Wiki te bewerken, heeft u een gebruikersaccount nodig. U kunt zich hier registreren. Bevestig na afloop uw e-mailadres. Bevestiging van uw e-mailadres geeft u toestemming iedere pagina te bewerken, op een paar na die beschermd zijn.

Let op: Als u binnen 5 dagen na het aanmaken van uw account geen bewerking uitvoert wordt uw account, in verband met de veiligheid, automatisch verwijderd.

Maak een gebruikerspagina aan

Nadat u een account heeft aangemaakt, uw e-mailadres heeft bevestigd en ingelogd bent, zou u een gebruikerspagina moeten aanmaken. Een snelle aanwijzing om uw gebruikerspagina te beginnen:

Het aanmaken van een gebruikerspagina heeft de volgende doelen:

  • Het geeft gebruikers de mogelijkheid meer van je te weten
  • Het laat je een paar beginnende bewerkingen maken zodat het Wiki spammer en abuse filter ziet dat je geen nep-gebruiker bent. Let erop dat je eerste bewerkingen geen externe links bevatten aangezien dat waarschijnlijk de filters activeert.

Even snel om je pagina te beginnen:

  • Ga, in het gebruikersmenu, naar uw Gebruikersnaam pagina (of gebruik het eerste menu-item in het rechter drop-down vak)
  • Klik op de actie drop-down knop
    JDOCS-actions-create-page-en.png
  • Klik op Aanmaken
  • Voeg de code toe in de editor {{subst:Newuser}}
  • Vul de samenvatting in (bijvoorbeeld Dit is mijn nieuwe gebruikerspagina)
    JDOCS-summary-form-input-nl.png
  • Druk op de opslaan knop

Doe mee in de communicatiekanalen

Joomla's officiële communicatie hulpmiddel is RingCentral (Glip). Kijk op deze pagina voor informatie om deel te nemen aan de gesprekken en als je daar eenmaal bent zoek dan naar het "JDocs Working Group" kanaal om deel te nemen aan de discussie over Joomla! Documentatie.

Wat moet ik eerst doen?

Er zijn verschillende documentatie-gebieden die altijd aandacht vragen. U kunt beginnen met het kiezen van degene die u het prettigst vindt om aan te werken of u wordt meer betrokken door aan meerderen op hetzelfde moment te werken. Als u eenmaal een wiki account heeft kunt u vrij aan ieder aspect van de documentatie werken waar u zin in heeft. Zelfs de eenvoudigste bijdrage zoals een spelling- en grammaticacorrectie zijn een enorme hulp!

  1. Help met documentatie inhoud.
  2. Onderhoudstaken.
  3. Neem deel aan of begin een documentatie-project.
  4. Help met helpschermen.
  5. Pagina's vertalen uitgelegd

Help met beheren van onze inhoud

  1. Bewerken, herschrijven en reorganiseren van pagina's. Bekijk onze Hulp behoevende pagina's voor gebieden die onmidde;ijke hulp nodig hebben. Ze worden 'Hulpbehoevende pagina's' genoemd omdat ze hulp nodig hebben om kleine taken uit te voeren of ze voltooien. Sommige zijn eenvoudig zoals het als nakijken van de inhoud of het toevoegen van een afbeelding. Anderen vragen meer inhoud of verbeteringen. Kies er een paar, geef ze een beetje liefde. Dit is een enorme hulp voor Joomla!-gebruikers die op onze documentatie vertrouwen.
  1. Geniet ervan en zoek naar artikelen die dubbel zijn, verouderd (bijvoorbeeld verzie 1.0 en 1.5), of opgesplitst moeten worden in verband met versie-specifieke informatie. Voel je vrij om gebruik te maken van de {{delete}}, {{merge}} of {{JSplit}} templates in de artikelen. Klik op voorgaande template links om te zien hoe ze te gebruiken en toe te passen in artikelen waarvan je denkt dat ze deze markeer-templates nodig hebben. Voeg ze bovenaan een pagina toe en de pagina is gemarkeerd.
  1. Maak een nieuwe pagina of handleiding aan . Doe, als u een nieuwe pagina wilt beginnen, eerst wat uitgebreid onderzoek. Probeer geen nieuw artikel aan te maken als het al bestaat. Gebruik de zoekfunctie van de Docs Wiki om te zien of uw onderwerp al in een artikel staat. Dubbele tekst zal worden samengevoegd en/of verwijderd. Wees niet bang het werk van iemand anders te wijzigen, opnieuw in te delen of verbeteren in de Joomla! Docs Wiki! Dit is een samenwerkingsverband documentatie wiki, wees er alleen van overtuigd dat u ons beleid en richtlijnen volgt.
    1. Gebruiken van wikilinks. Het is makkelijk om pagina's te linken met behulp van een standaard syntaxus. Als u een link maakt naar een artikel dat niet bestaat, dan wordt de link rood gekleurd. Klikken op een rode link leidt u naar het bewerkpagina van het nieuwe artikel. Type eenvoudig uw tekst, sla op en de nieuwe pagina is aangemaakt. Op het moment dat de pagina aangemaakt is verandert de link van rood in blauw wat aangeeft dat het artikel nu bestaat.
    1. Gebruiken van de URL. Te gebruiken wanneer u een pagina vanaf het begin wilt aanmaken. U kunt de URL van de wiki gebruiken om een nieuwe pagina aan te maken. De URL naar een artikel op de wiki is normaliter iets als dit: https://docs.joomla.org/UWTITEL. Indien u UWTITEL vervangt door de naam van de pagina die u wilt aanmaken, dan wordt u naar een lege pagina geleid wat aangeeft dat er nog geen artikel met die naam bestaat. Klikken op de Aanmaken link leidt u naar de bewerk-pagina van dat artikel, waar u de nieuwe nieuwe pagina kunt aanmaken door uw tekst in te typen en op Pagina opslaan te klikken.
  1. Help bij het update van afbeeldingen in artikelen. Controleer de categorie Heeft behoefte aan het bijwerken van afbeelding voor een lijst met pagina's waarop afbeeldingen die bijgewerkt moeten worden. Onze aanbevolen richtlijnen om u te helpen vindt u in het artikel Afbeeldingen naamgevingsrichtlijnen.

Wiki onderhoud

Het onderhoud van een wiki en het organiseren vraagt doorlopend werk van beheerders, redacteuren en gebruikers. Er zijn altijd taken die aandacht vragen zoals: Categoriseren, bijdragen aan pagina's die aandacht vragen, die in onderhoud zijn, of pagina's markeren om te verwijderen, samenvoegen of opsplitsen. Bezoek, voor alle onderhoudstaken en ideeën hoe u kunt helpen, onze Documentatie onderhoudpagina.

Documentatieprojecten

  • Het docs team werkt aan Beginners-handleiding. Ons doel is om ze begrijpelijk en toegankelijk te maken, iets dat een beginner makkelijk kan volgen en waarmee die de basis concepten kan leren. Denk terug aan de tijd dat u nieuw in Joomla! was voeg een onderwerp aan de pagina toe over iets waarmee u als beginner worstelde. Nog beter, meld je aan bij het Beginners handleiding project.

Helpschermen

Onbekend voor velen is dat alle Helpscherm-pagina's aangemaakt en aangeboden worden aan iedere Joomla! installatie wereldwijd vanuit deze wiki! Ze zijn noodzakelijk voor beginners en degenen met gemiddelde kennis van Joomla!

  • De Joomla! 4.x helpschermen moeten worden beoordeeld en bijgewerkt'. Elke bijdrage die je kan leveren wordt gewaardeerd door gebruikers over de gehele wereld en we zijn op zoek naar vrijwilligers die willen helpen met deze belangrijke taak. Een matrix moet gemaakt worden als wel een plan van aanpak.

Dingen om te onthouden

Hier zijn een paar zaken om te onthouden als iemand die bijdraagt aan Joomla! Docs.

  • Wees niet bang dat u een pagina verknalt, draai, als u iets doet en er iets helemaal verkeert gaat, je bewerking terug. Klik op het Bekijk historie tabblad van de pagina en u ziet links om ongedaan te maken en terug te draaien.
  • Schrijf artikelen met een gevoel dat ze vertaald zullen worden naar andere talen. Het gebruik van streektaal of een lokaal dialect geeft moeilijkheden bij het vertalen naar andere talen of dat het niet begrepen wordt Meer over Vertalen van Joomla documentatie.
  • Woorden om op te letten tijdens het schrijven, lees de volledige handleiding … of gebruik voor directe feedback Google Chrome of Mozilla Firefox browsers. Ze hebben beide een ingebouwde spellingchecker die een fout gepeld woord onderstrepen.
  • Vergeet niet het {{inuse}} template toe te voegen aan een artikel waar u langere tijd aan gaat werken (meer dan een minuut). Het helpt tegen bewerkconflicten.

Help, ik ken geen Wiki opmaak!

U kunt, als u nieuw bent in het gebruik van Wiki's en de eenvoudige opmaak om pagina's aan te maken, dan kunt u de volgende hulp gebruiken.

  • Nieuwe WikiEditor bevat knoppen en snelkoppelingen te maken van pagina ' s gemakkelijker. Klik op het woord "de"Advanced" - " voor een drop-down van meer knoppen en snelle opmaak links.
  • Gebruik het JDOC's Wiki spiekbriefje om te leren over de basis-syntaxis opdrachten. Er is ook een drop-down met de gemeenschappelijke opmaak in de editor. Klik gewoon één keer op het woord 'Helpen' en het zal verschijnen.
  • Nog bang? Probeer deze hulpmiddelen om u te helpen geweldige wiki pagina's aan te maken.
  • Microsoft Word Add-on voor Wiki opmaak, opslaan van Word-documenten in Wiki Markup.
  • OpenOffice.org versie 2.4 en later heeft een ingebouwd MediaWiki export filter. Open een Writer document en klik op Bestand - Export. Verander dan het bestandsformaat in MediaWiki.
  • Hier is een lijst met hulpmiddelen beschikbaar om andere formaten naar wiki markup te converteren, bijvoorbeeld HTML, Excel, CSV. Sommige zijn online conversies, knip en plak HTML voor uitvoer in wiki markup.
  • Krijg hulp via Glip (we hebben daar 2 groepen: een voor de Jdocs Translation Group en een voor de JDocs Working group).
  • Stel een vraag op administrator's of tekstverwerkers overleg pagina.