History: Overview,nl
Source of version: 7 (current)
Copy to clipboard
!Documentatie standaard overzicht Als je een bijdrage wilt leveren aan de TikiWiki documentatie, Houd dan AUB rekening met de onderstaande standaards. !!Basis Concepten: * __Pagina__ In de TikiWiki documentatie, de term ''pagina''(page) is synoniem aan ''Wiki pagina.'' * __Onderdeel__ Een ''onderdeel''(feature) is een TikiWiki component met een specifieke functie, zoals de beeld-gallerijen, bestands-gallerijen, FAQs, banners, forums, of blogs (bekijk ((Features,nl|Onderdelen)) voor een overzicht). !!Alle pagina's worden geïntergreerd door middel van een Wiki struktuur * __Standaarden__ + ''Voor voorbeelden bekijk __((Examples,nl|Voorbeelden))__'' + Elke pagina moet een standaard opmaak gebruiken((Formatting Standards,nl|Opmaak Standaarden)) Ga naar ((Requirements and Setup,nl|Benodigdheden en instelling)) voor een voorbeeld. * __Status__ + De ((Documentation Status,nl|Documentatie Status)) is de "harcoded" en beschreven versie van de struktuur. Als je nieuwe pagina's toevoegt, plaats er dan AUB een duidelijke indicatie bij __TOEVOEGEN__ zodat het toegevoegt kan worden aan een struktuur. Opruimingen en pagina's verplaatsen gebeuren regelmatig. !!Elk Onderdeel heeft op zijn MINST vier pagina's Documentatie. * __Hoofd pagina__ + ''voor een voorbeeld __((Blogs,nl|Blogs))__'' + Dit is de top-level pagina van dit onderdeel. Het defineert de strekking van het onderdeel, en geeft een overzicht van de mogelijkheden van het onderdeel(Wat er vele kunnen zijn, dus worden ze hier beknopt beschreven), Tevens wijst hij de weg naar gerelateerde interne of externe bronnen. * __Gebruikers Hulp__ + ''voor een voorbeeld __((Using Blogs,nl|Blogs gebruiken))__'' + Deze hulp is ontworpen voor eind-gebruikers(inclusief admins die hun site gebruiken). Elk van de Gebruikers pagina's zou georganiseert moeten worden door ''Taken,'' dat is, wat een gebruiker wil bereiken(als voorbeeld, "Maak een nieuwe Blog aan," "Voorkomen dat andere gebruikers dingen aanleveren," etc.). Gebruik Screenshots vrijelijk! * __Admin Uitleg__ + ''voor een voorbeeld __((Blogs Administration,nl|Blogs beheren))__'' + Deze Uitleg voorziet alles wat een Admin nodig heeft om dingen te starten, configureren, onderhouden, en probleem aan het onderdeel te kunnen doen. Waar nodig, zou het ook systeem informatie benodigdheden moeten bevatten, Of andere bruikbare vanuit het Admin oogpunt. * __Referencies__ + ''voor een voorbeeld __((Blogs Reference,nl|Blogs referencies))__'' + Dit is de referencie documentatie. Het zou lijsten met korte omschrijving van de volgende dingen moeten bevatten. ** rechten relevant aan het onderdeel, ** contstante database tabellen, ** administratieve configuratie mogelijkheden, ** gebruikers mogelijkheden. !!Hoe te starten * __Editor wezen__ + Elke tikiwiki community member die is verklaart als zodanig op tikiwiki.org krijgt een Editors vlag op zijn documentatie website. * __kies een onderwerp of onderdeel__ + Van de ((Documentation Status,nl|Documentatie Status)) pagina, kies je een onderdeel waarvan je wilt helpen de documentatie te maken. * __Inhoud vinden__ + Plunder [http://tikiwiki.org] als daar al documentatie is te vinden. Zo ja, copieër het en plaats de documentatie hier. Opmerking: Hou er rekening mee dat het niet in de juiste formaat is! Je kan ook uit oude 1.6 TikiWiki de documentatie zuigen klik [http://alt.thetinfoilhat.com/tiki-index.php?page=Tiki%20Documentation] om mischien wat meer info te vinden(het meeste zal al overgezet zijn naar tikiwiki.org). * __Schrijf wat er ontbreekt__ + Schrijf of bewerk de pagina zo dat hij volgens het relevante voorbeeld en zo nauwkeuris als mogelijk (bekijk ((Examples,nl|Voorbeelden)) ). Controleer ((Formatting Standards,nl|Opmaak Standaarden)) om zeker te zijn dat de afhandeling van "mechanical matters" zoals headings, links, etc., correct worden afgehandeld. * __Werk groepsgericht__ + Update ((Documentation Status,nl|Documentatie Status)) zo dat andere deelnemers weten waaraan je werkt (en wat er nog gedaan moet worden).