• Vastliggende pagina
  • Info
  • Bijlages

Werken met de wiki

Als u deze pagina leest, bent u waarschijnlijk nieuwsgierig hoe u mee kunt helpen aan de Nederlandstalige documentatie voor Ubuntu, of wijzigingen kunt maken op andere community wikipagina's. Mooi zo! Op deze pagina zult u lezen hoe u een start kunt maken op deze wiki met het schrijven van documentatie.

  • Info <!> Lees voordat u begint te schrijven ook even onze richtlijnen door.

Wat is een wiki?

De Nederlandstalige Ubuntu-documentatie wordt geschreven door verschillende mensen uit de Ubuntu-gemeenschap. Het systeem waarop we dit doen, wordt een wiki genoemd. Het principe van een wiki is gebaseerd op de open source gedachte: iedereen moet mee kunnen helpen. U dus ook!

  • Info <!> Wiki pagina's worden vanzelfsprekend door anderen gelezen! Plaats nooit gevoelige informatie op een wiki pagina. Ook niet op zogenaamd afgeschermde teampagina's, vertrouwelijkheid is nooit gegarandeerd. Informatie kan worden gewijzigd maar kan niet worden gewist!

Een account aanmaken

Om artikelen te kunnen bewerken op deze wiki, is een account nodig. Deze kunt u hier aanmaken. Door middel van het account kunnen lezers u tevens als schrijver of bewerker van artikelen identificeren. Het bevordert de samenwerking op de wiki, en maakt het ook makkelijker voor het documentatieteam om contact met u op te nemen, als dat nodig is.

Als u eenmaal een account geregistreerd hebt, zult u zien dat u alle pagina's in het /community gedeelte op de wiki aan kunt passen. U kunt dus al starten met het maken van verbeteringen en aanvullingen in bestaande artikelen, door gewoon op de Bewerken (Tekst)-link bovenin de pagina te klikken.

Een nieuwe wiki-pagina aanmaken

Wanneer u ingelogd bent kunt u een nieuwe pagina aanmaken door in de adresbalk de URL te kiezen van het artikel dat u aan wilt maken.

http://wiki.ubuntu-nl.org/community/mijnnieuwepagina

Het gebruik van hoofdletters is effectief. Op deze manier is de naam van de pagina beter te lezen.

http://wiki.ubuntu-nl.org/community/MijnNieuwePagina

Wanneer u een nieuwe titel hebt gekozen, verschijnt er op u scherm dat de pagina nog niet bestaat. Kies Bewerken (Tekst) of Een nieuwe pagina aanmaken en u kunt beginnen met schrijven!

  • Info <!> Wanneer u met een artikel begint, dient u er de label InAanbouw op te plakken. Op deze manier weten andere schrijvers dat u aan een artikel werkt, en kunnen ze eventueel meewerken. Zet de volgende code bovenaan uw artikel:

<<Include(Label/InAanbouw)>>

Uw artikel zal dan ook automatisch in de lijst op ArtikelenInAanbouw komen te staan.

Wiki-syntax: de basis

Nu u een wiki-pagina aan hebt gemaakt, wilt u waarschijnlijk weten hoe u opmaak en indeling toe kunt voegen aan uw pagina. Dit gebeurt met behulp van wiki-codes. Hieronder worden enkele veelgebruikte codes uitgelegd en gedemonstreerd.

  • Info (!) Voor een uitgebreide toelichting van alle mogelijkheden, kunt u ook de Engelstalige pagina SyntaxisNaslagwerk bekijken.

Koppen

Om een duidelijke structuur in uw handleiding te krijgen, is het essentieel om hoofdstukken of koppen aan te maken. Hieronder vindt u een voorbeeldje van de code.

= level 1 kop =
== level 2 kop ==
=== level 3 kop ===
==== level 4 kop ====
===== level 5 kop =====

De verschillende levels zorgen ervoor dat u ook sub-koppen aan kunt maken. Zo wilt u misschien in uw artikel "Werken met programma X" een kop "De eerste stappen" hebben, met daarin de sub-koppen "Download programma X" en "Installeer programma X". Dit kunt u op de volgende manier bereiken.

= Werken met programma X =
Inleiding hier.

== De eerste stappen ==
Wat tekst hier.

=== Download programma X ===
Instructies hier.

=== Installeer programma X ===
Nog meer instructies hier.

== En eventueel nog een kop ==
De mogelijkheden zijn eindeloos!
  • Info <!> Het is een goed idee om bovenaan elke pagina een level 1 kop met de titel van de pagina te plaatsen (zoals in bovenstaand voorbeeld).

Plaatjes

Om plaatjes in te voegen gebruikt u de volgende code (verander Afbeelding.png in een bestandsnaam die de afbeelding beschrijft).

{{attachment:Afbeelding.png}}

Hierdoor zal er in het artikel een paperclip verschijnen. Als u op de paperclip klikt, kunt u de afbeelding opsturen.

Plaatjes die op meerdere pagina's gebruikt worden, zoals bijvoorbeeld iconen, kunt u toevoegen als bijlage aan de pagina Afbeeldingen.

Voor het maken van links maakt u gebruik van de [ en ].

De belangrijkste manieren om externe links te maken staan hieronder op een rijtje.

http://www.ubuntu-nl.org/
[[http://www.ubuntu-nl.org/|Externe link]]
emailadres@website.org

Voor een verwijzing binnen de wiki hoeft u alleen de naam van de pagina op te schrijven (werkt alleen als de naam van het artikel meerdere hoofdletters bevat).

Mooier is om de link een linktekst te geven.

[[VoorbeeldArtikel|Lees meer over dit onderwerp...]]

Geef nooit het gehele adres op bij interne links! Wilt u bijvoorbeeld naar deze pagina verwijzen dan doet u:
 [[community/WerkenMetDeWiki | WerkenMetDeWiki]]

en NIET:
[[http://wiki.ubuntu-nl.org/community/WerkenMetDeWiki | WerkenMetDeWiki]]


Wilt u voorkomen dat er automatisch verwezen wordt naar een wiki pagina, bijvoorbeeld bij het woord "MediaPlayer", plaats dan een uitroepteken voor het woord.

!MediaPlayer

Inhoudsopgave

Het plaatsen van een inhoudsopgave is aan te raden, vooral voor langere artikelen. Voeg de code bij voorkeur bovenaan de pagina toe.

||<tablestyle="float:right; font-size: 0.9em;"><<TableOfContents>>||

Opmerkingen-velden

Op de wiki kunt u op een gemakkelijke manier opmerkingen-velden plaatsen. Er worden de volgende soorten opmerkingen onderscheiden:

  • tip - voor het plaatsen van een tip

  • note - voor het plaatsen van een gewone opmerking

  • important - voor het plaatsen van een belangrijke opmerking

  • caution - voor het plaatsen van een "let op!"-opmerking

  • warning - voor het plaatsen van een waarschuwing

Om een opmerkingen-veld in te voegen, gebruikt u de volgende code. U kunt zo nodig in de code tip vervangen door een andere soort opmerking (zie het lijstje hierboven).

{{{#!wiki tip
Dit is een leuke tip.
}}}

Resultaat

Dit is een leuke tip.

Tips & Tricks

  • Gebruik altijd de knop proeflezing voordat u op "Wijzigingen opslaan" klikt. Het is gebruikelijk om zo steeds de wijzigingen te controleren en pas op te slaan als u echt klaar bent. Zo blijft de geschiedenis van de pagina ook overzichtelijk.
  • Voeg altijd commentaar toe. Zo kan er in de geschiedenis makkelijker gezien worden wat wanneer is gewijzigd.
  • Plaatjes die op meerdere pagina's gebruikt worden, zoals bijvoorbeeld iconen, kunt u toevoegen als bijlage aan de pagina Afbeeldingen.

  • Verwijs nooit naar de volledige URL van een pagina binnen deze wiki. Dus in plaats van [[http://wiki.ubuntu-nl.org/community/MijnNieuwePagina]] doet u [[community/MijnNieuwePagina]]]. Meer info hierover op HelpOnMoinWikiSyntax.

  • Vermijd dubbele tekst. Als u een stuk tekst op twee of meer plaatsen wilt tonen, kunt u een aparte pagina maken. En deze aparte pagina dan invoegen. Dit wordt bijvoorbeeld gedaan met menu's zoals de documentatie topbar die boven elke documentatiepagina te zien is.

  • Gebruik de Firefox add-on It's All Text! om wiki pagina's met uw favoriete tekstverwerker te bewerken.

Voor meer informatie kunt u eens naar de volgende pagina's kijken.

  • HelpOnEditing - alles over werken met de wiki, inclusief het werken met macro's (Engelstalig)

  • SyntaxReference - alle mogelijkheden nog eens op een rijtje (Engelstalig)

Ook kunt u altijd vragen stellen aan het documentatieteam.

community/WerkenMetDeWiki (laatst bewerkt op 2013-04-27 17:25:10 door luckiboy)