Sjablonen in MediaWiki en hoe ze werken

in #mediawiki2 years ago (edited)

Deze Wiki-tutorial is geschreven door Bart Mulckhuijse van WikiWerkers

Wat is een sjabloon?

Een MediaWiki-sjabloon is technisch gezien een pagina in de naamruimte (onderdeel) "Sjabloon" (of "Template" wanneer je een engelstalige wiki hebt), waarvan je de inhoud kunt gebruiken op andere pagina's. De tekst die op de sjabloon-pagina staat wordt automatisch ingevoegd, op het moment dat de pagina wordt weergegeven voor een bezoeker van de wiki. De tekst wordt dus niet tijdens het bewerken gekopieerd, maar pas op het moment van weergave!

Waarvoor dient een sjabloon?

Sjablonen kun je op veel verschillende manieren gebruiken. De belangrijkste functies zijn:

  1. Efficiënter schrijven, door tekstonderdelen die vaak herhaald worden met een sjabloon te kunnen plaatsen. Denk bijvoorbeeld aan banners of infoboxen.
  2. Efficiënter beheren/redigeren van de wiki. Door de tekst van een enkele sjabloon aan te passen, wordt de weergave op alle pagina’s waarop dat sjabloon staat in 1 keer aangepast
  3. Beveiliging van onderdelen. Door een sjabloon te beveiligen, kunnen onderdelen van een wikipagina beveiligd worden tegen ongewenste of onbedoelde aanpassingen.
  4. Werken met formulieren en semantiek; de uitbreidingen van MediaWiki met Formulieren (Extensie:Page Forms) en Semantic MediaWiki (Extensie:Semantic MediaWiki) zijn sterk geïntegreerd met het gebruik van sjablonen, met name de sjablonen voor infoboxen.

Hoe werkt een sjabloon?

Je kunt de inhoud van een sjabloon op een andere pagina laten “opnemen” (ook wel “transclusie” genoemd) door de titel tussen dubbele accolades te plaatsen, bijvoorbeeld:

Lorem ipsum ... {{sjabloontitel}} 

De weergave wordt dan:

Lorem ipsum ... <en hier wordt de inhoud van de pagina Sjabloon:Sjabloontitel ingevoegd>

Een extra mogelijkheid van sjablonen is het dynamisch aanpassen van de opgenomen tekst. Je kunt namelijk de weergave van de inhoud van het opgenomen sjabloon aanpassen doordat je “parameters” met variabele waarden kunt meegeven tijdens de transclusie. Bij de weergave van het sjabloon wordt de parameter op de sjabloon-pagina vervangen door de meegegeven waarde.

Dat ziet er als volgt uit, bijvoorbeeld:

{{sjabloontitel | parameter1 = waarde1 | parameter2 =  waarde2 }}

De weergave wordt dan:

<De inhoud van de pagina Sjabloon:Sjabloontitel met de parameters vervangen door "waarde1 "en "waarde2">

Deze laatste eigenschap is uniek voor sjablonen en maakt dat het een waardevol hulpmiddel is voor het efficiënter aanmaken en beheren van content.

Hoe maak je een sjabloon?

Je maakt een sjabloon door het aanmaken van een sjabloon-pagina, met de volgende onderdelen:

  1. Tussen de tags <noinclude> en </noinclude> plaats je de uitleg over de werking van het sjabloon en de categorie-verwijzing
  2. Tussen de tags <includeonly> en </inlcudeonly> plaats je de wikitekst, die moet worden geplaatst wanneer het sjabloon op een pagina wordt opgenomen

Eenvoudig voorbeeld:

<noinclude>Dit sjabloon plaatst de tekst “Hello World!” op een pagina.</noinclude><includeonly>Hello World!<includeonly>

Kun je sjablonen kopiëren van Wikipedia?

Kort antwoord: "Ja dat kan!" (plaats wel een bronvermelding!)

Het kopiëren werkt overigens niet altijd even eenvoudig. De belangrijkste oorzaken die problemen veroorzaken zijn:

  • Het gebruik van sub-sjablonen; sjablonen die gebruikt worden binnen het sjabloon dat je wilt kopiëren (die moet je dan dus ook kopiëren!)
  • Gebruik van afbeeldingen binnen het sjabloon; ook die moet je dan dus kopiëren!)
  • Verschillen in de MediaWiki-configuratie van Wikipedia en je eigen wiki (bijv. de gebruikte Skin, geïnstalleerde extensies, Widgets en Gadgets)
  • Verschillen in de styling (CSS) tussen Wikipedia en je eigen wiki
  • Sjablonen op Wikipedia zijn vaak (veel) ingewikkelder dan je zelf op je eigen wiki nodig hebt

Het is vaak praktischer (efficiënter, sneller etc.) om wel inspiratie op te doen bij Wikipedia, maar verder je eigen sjablonen te ontwikkelen.

Welke categorieën of soorten sjablonen zijn er?

De toepassing van sjablonen is zeer veelzijdig, maar veel voorkomende soorten zijn:

  • Sjablonen voor infoboxen (zie ook de Tutorial Infoboxen )
  • Sjablonen voor meldingen (banners, promotie, redactionele opmerkingen)
  • Sjablonen voor pagina-headers (vormgeving, navigatie)
  • Sjablonen voor semantische queries

Hoe beveilig je sjablonen

Het kan van belang zijn om veel gebruikte sjablonen te beveiligen tegen onbedoeld of ongewenste aanpassingen. Daarvoor zijn standaard twee methoden beschikbaar:

  1. Een specifiek Sjabloon beveiligen, door de pagina te beveiligen. Gebruikers met ‘sysop’ rechten kunnen dit doen. Zie de documentatie van MediaWiki.
  2. De gehele naamruimte voor sjablonen beveiligen, door de bewerkingsrechten toe te kennen aan een selecte gebruikersgroep. Zie de documentatie MediaWiki.

Het beveiligen van sjablonen is een onderdeel van goed beveiligen van je wiki, zie ook de Tutorial Beveiliging MediaWiki.

Enkele voorbeelden

Verder lezen en leren

Engelstalige video-tutorials

  1. MediaWiki - Introduction to templates (zie video hierboven)
  2. MediaWiki - Basic formatting of templates
  3. MediaWiki - Introduction to template variables
  4. Infoboxes and an introduction to forms

Hulp bij het ontwikkelen van Sjablonen

WikiWerkers zijn bedreven in het ontwikkelen en vormgeven van <... INVULLEN ..> voor standaard en semantische wiki’s. Zij helpen graag en zijn flexibel in te zetten op uw wiki-project. Stuur ons een bericht en maak vrijblijven kennis in een audio- of videoconferentie. WikiWerkers zijn ook bereikbaar via Discord-chat.


Of neem contact op met de auteur via LinkTree


~+~ WikiWerkers -~- Personal Website -~- Twitter ~+~