Help/sjablonen

Uit NORA Online
Ga naar: navigatie, zoeken
logo helpsectie, twee vraagtekens en de knoppen F1 en help in de kleuren van NORA (blauw, wit en paars)
Helpsectie NORANederlandse Overheid ReferentieArchitectuur wiki:

De pagina's in de NORA-wiki zijn opgebouwd uit tekst en code, die bijvoorbeeld de opmaak bepaalt, verwijzingen doorklikbaar maakt, afbeeldingen toevoegt en semantische eigenschappen van pagina's vastlegt of opvraagt (in lijsten en tabellen). Bepaalde code komt regelmatig terug, zoals het weergeven van een pdf-bestand, het plaatsen van een kader om een tekst heen, of het vastleggen van een actiepunt in vergaderingen. Voor dat soort toepassingen maken we daarom Sjablonen: een vast stukje code dat je door de naam van het sjabloon aan te roepen in de pagina plakt.

Waarom sjablonen?

Er zijn verschillende redenen om sjablonen te gebruiken, in plaats van een los stukje code:

  • De code is te complex voor de gewone gebruikerIedere persoon, organisatie of functionele eenheid die gebruik maakt van een informatiesysteem, maar kan nu wel breed worden toegepast
  • De weergave van bepaalde onderdelen moet hetzelfde zijn bij verschillende pagina's (consistentie)
  • De code komt vaak voor en je maakt gemakkelijk een typefout als je het opnieuw in moet typen
  • Je wilt iets op verschillende plekken gebruiken, maar wel zeker zijn dat wijzigingen op al die plekken gelijk verwerkt worden

In het algemeen zijn er drie soorten sjablonen:

  • Sjablonen die de opmaak van informatie regelen
  • Sjablonen die een specifieke tekst, eigenschap, categorie of combinatie daarvan toevoegen op meerdere pagina's of plekken
  • Sjablonen die complexere zaken mogelijk maken

Inhoudelijke bewerkers van de wiki zullen vrijwel alleen de eerste twee gebruiken. Wil je iets dat ingewikkelder is, neem dan contact op met NORANederlandse Overheid ReferentieArchitectuur Beheer.

Sjablonen vinden

Als je een pagina bewerkt zie je onder de pagina een lijstje met de sjablonen die in gebruik zijn. Als je hierop klikt kom je op de pagina van het sjabloon zelf, waar het als het goed is wordt uitgelegd.

De Aanbevolen Sjablonen zijn sjablonen die we vanuit NORANederlandse Overheid ReferentieArchitectuur Beheer aanbevelen voor gebruik in de NORANederlandse Overheid ReferentieArchitectuur wiki.

Een overzicht van alle beschikbare sjablonen staat op Speciaal:Sjablonen.

Sjablonen bekijken en leren gebruiken

Elk sjabloon heeft een eigen wiki-pagina met als naam Sjabloon:Naam van het sjabloon. Je kunt hier komen door de naam in te voegen in de zoekfunctie, of door op een sjabloon te klikken onder een pagina (in het tabblad bewerken). Op de pagina van het sjabloon zie je de uitleg die de maker van het sjabloon heeft meegegeven. Kom je er met die uitleg nog niet uit, of wil je het effect zien van het sjabloon, zweef dan met je muis in het menu rechtsboven in beeld boven Tools en kies in het uitrolmenu de optie Koppelingen naar deze pagina. Je krijgt dan een lijst te zien van alle plaatsen waar het sjabloon wordt toegepast. Klik door en bekijk de voorbeelden. Heb je meer ondersteuning nodig, neem dan even contact op met het NORANederlandse Overheid ReferentieArchitectuur Beheer team.

Bestaande Sjablonen gebruiken

Een sjabloon roep je in de code van je pagina aan door de volledige naam te plaatsen tussen
{{  }} 
. Daarmee ben je er nog niet: voor de meeste sjablonen moet je variabelen toevoegen, waardoor het sjabloon weet waarmee het iets moet doen. Bij het sjabloon Bestand met info moet je bijvoorbeeld aangeven welk bestand je wilt weergeven. Het sjabloon Uitgelicht dat een grijs kader om een tekst plaatst, moet weten welke tekst er in het kader moet staan. Elke variabele die je toe voegt scheid je van de naam met een | (rechtsboven op je toetsenbord, links naast de backspace):
{{Naam sjabloon|variabele 1|variabele 2}} 

Voor onze twee voorbeelden is dit dus:

{{Bestand met info|Bestandsnaam.pdf}} 
{{Uitgelicht|Tekst die in uitgelicht geplaatst moet worden. Eventueel meerdere regels (kan ook alinea's en opmaak bevatten).}} 

Dat laatste levert op:

Tekst die in uitgelicht geplaatst moet worden. Eventueel meerdere regels (kan ook alinea's en opmaak bevatten).

Meerdere variabelen en optionele variabelen

Voeg je geen tekst toe om in het kader te plaatsen, dan krijg je geen kader. Maar niet alle variabelen hoeven altijd toegevoegd te worden om een sjabloon te laten werken. Het sjabloon Bestand met info vereist een bestandsnaam, maar het heeft ook een optionele variabele: je kunt een alternatieve tekst geven om weer te geven. We nemen als voorbeeld het Jaarplan van de NORANederlandse Overheid ReferentieArchitectuur voor 2016. De bestandsnaam van het jaarplan is Jaarplan NORANederlandse Overheid ReferentieArchitectuur 2016 Definitief.pdf. De code wordt dus
{{Bestand met info|Jaarplan NORANederlandse Overheid ReferentieArchitectuur 2016 Definitief.pdf}}
met als effect: Jaarplan NORA 2016 Definitief.pdf (PDF, 685 kB) Dat is echter niet heel mooi: de extensie .pdf wordt zo dubbel weergegeven en het woord Definitief is in dit voorbeeld niet nodig (we hebben geen concepten geplaatst). We geven dus een alternatieve tekst op om weer te geven
{{Bestand met info|Jaarplan NORANederlandse Overheid ReferentieArchitectuur 2016 Definitief.pdf|Jaarplan 2016}}
met als effect:Jaarplan 2016 (PDF, 685 kB) Meerdere variabelen voeg je dus achter elkaar toe, telkens gescheiden door een |. De volgorde is hierbij van belang, je moet dezelfde volgorde aanhouden als de maker van het sjabloon. De code
 {{Bestand met info|Jaarplan 2016|Jaarplan NORANederlandse Overheid ReferentieArchitectuur 2016 Definitief.pdf}}
werkt dus niet.

Variabelen met een naam

Sjablonen waar je meer dan twee variabelen voor in kunt vullen zijn complexer in gebruik. Om het in ieder geval voor de volgorde wat makkelijker te maken geven we de variabelen daarom elk een naam. Een voorbeeld is het sjabloon Begrip dat je gebruikt om een term als Begrip op te nemen in de NORANederlandse Overheid ReferentieArchitectuur Begrippenlijst.

Je gebruikt het sjabloon altijd op de pagina van het begrip zelf: de paginatitel is de naam van het begrip. De belangrijkste eigenschappen van een begrip geef je via het sjabloon weer: De definitie van het begrip, de bron waar je het begrip van hebt overgenomen, het gremium of de publicatie waarin het begrip is vastgesteld en extra toelichting voor zover dat nodig is. Bovendien is het nodig om aan te geven of de definitie hoofdlettergevoelig is (bijvoorbeeld bij afkortingen). Dit zijn dus 5 variabelen, met een logische naam.

Je roept het sjabloon op de gebruikelijke manier aan, met de eigenschappen gescheiden door |, maar nu zet je de naam van de variabele er voor met een =teken. Om het overzicht niet kwijt te raken kan het handig zijn om elke | op een nieuwe regel te plaatsen: dat verandert niets aan de uitvoering van het sjabloon, maar maakt het gemakkelijker later een eigenschap terug te vinden of te wijzigen.

 {{Begrip
|Bron=NORANederlandse Overheid ReferentieArchitectuur 3.0 Principes voor samenwerking en dienstverlening
|Definitie=Een gemeenschappelijk normenstelsel binnen een organisatie, waaruit passende maatregelen kunnen worden afgeleid. Een type baselineEen gemeenschappelijk normenstelsel binnen een organisatie, waaruit passende maatregelen kunnen worden afgeleid. Een type baseline is de baseline kwaliteit, dat wil zeggen een organisatiebreed normenkader waarin de organisatie ook alle concrete maatregelen beschrijft die de kwaliteit van de diensten waarborgen. is de baselineEen gemeenschappelijk normenstelsel binnen een organisatie, waaruit passende maatregelen kunnen worden afgeleid. Een type baseline is de baseline kwaliteit, dat wil zeggen een organisatiebreed normenkader waarin de organisatie ook alle concrete maatregelen beschrijft die de kwaliteit van de diensten waarborgen. kwaliteit, dat wil zeggen een organisatiebreed normenkader waarin de organisatie ook alle concrete maatregelen beschrijft die de kwaliteit van de diensten waarborgen. 
|Toelichting=Denk bijvoorbeeld aan normen en maatregelen op het gebied van informatiebeveiligingHet proces van vaststellen van de vereiste betrouwbaarheid van informatiesystemen in termen van vertrouwelijkheid, beschikbaarheid en integriteit alsmede het treffen, onderhouden en controleren van een samenhangend pakket van bijbehorende maatregelen., de toegankelijkheidHoudt in dat informatie vindbaar, interpreteerbaar en uitwisselbaar is. van de dienst, het meten en verbeteren van klanttevredenheid en standaardisatie op het gebied van informatie-uitwisseling.
|Vastgesteld in=NORANederlandse Overheid ReferentieArchitectuur 3.0 Principes voor samenwerking en dienstverlening
|Gebruik hoofdletters=Nee
}}