Sjabloon:Begrip

Uit NORA Online
Ga naar: navigatie, zoeken
Tekening van boek met a en z er op
Onderdeel van Begrippenkader NORANederlandse Overheid Referentie Architectuur
Dit sjabloon is bedoeld om begrippen te definiëren binnen de wiki, zodat ze worden opgenomen in het Begrippenkader en een stippellijn met tooltip (ballon) krijgen op elke plek waar de term voorkomt. Het voegt bovendien de categorie Begrippen toe aan de pagina en het kadertje rechts met de afbeelding en de tekst "Onderdeel van het Begrippenkader van NORANederlandse Overheid Referentie Architectuur."

Conventie naamgeving begrippen

Gebruik het sjabloon op een aparte begripspagina, niet binnen een pagina met andere tekst. Een begripspagina draagt in principe de naam van het begrip (bijv. Afnemer) als titel. Het kan echter voorkomen dat die titel al voorkomt, of liever gebruikt wordt voor een themapagina, zoals bij Gegevensmanagement. Voeg in dat geval "(Begrip)" toe aan de titel, bijvoorbeeld Gegevensmanagement (Begrip) en Standaard (Begrip).

Van sommige begrippen is het nuttig een werkdefinitie te geven binnen een bepaalde context, maar kan het begrip in een andere context iets heel anders betekenen. Het woord "integraal" maakt bijvoorbeeld deel uit van de werkdefinitie van Gegevensmanagement en is in die context gedefinieerd, maar betekent in andere contexten wellicht iets heel anders. Om dit duidelijk te maken is niet alleen een toelichting toegevoegd, maar is Integraal ook aan de naam van de pagina te herkennen als (Begrip Gegevensmanagement):Integraal (Begrip Gegevensmanagement).

Aanmaken van een nieuw begrip

  1. Vergewis je er van dat het begrip niet in Begrippenkader staat
  2. Ga naar de pagina Begrip
  3. Ga naar 'Elementen van dit type', vul de naam in van het element en kies 'Maak begrip'.
  4. Zie je in geel 'Waarschuwing: deze pagina bestaat al, maar die gebruikt dit formulier niet.'? Breek dan af, en kies een alternatieve naam voor de begripspagina. Bij voorbeeld: Voorbeeld (begrip)

Invullen van de eigenschappen

Haal voor elke regel met een is-teken alles achter de "=" weg (inclusief < >) en vervang het door de juiste gegevens. Is een bepaalde eigenschap onbekend of niet relevant, laat het dan leeg.

  • Term= Vul hier het begrip in zoals die onderstreept moet worden. Denk goed na: wordt deze term vrijwel altijd in het meervoud gebruikt, kies ook hier dan voor de meervoudsvorm zodat je de uitleg ook daadwerkelijk te lezen krijgt. Als je de term leeg houdt, wordt de naam van de pagina als term gebruikt. Als je aan de naam van de pagina (Begrip) of (Begrip Context) toe hebt moeten voegen moet je dus altijd een term opgeven zonder die toevoeging om het goed te laten werken. Je zult zien dat de term, nadat je de pagina hebt opgeslagen, ook automatisch weergegeven wordt als titel van de pagina.
  • Gebruik hoofdletters= Als je geen term opgeeft gebruikt de wiki de paginanaam, waarbij het alle hoofdletters omzet naar kleine letters (zodat niet "Architectuur" onderstreept wordt, maar "architectuurEen beschrijving van een complex geheel, en van de principes die van toepassing zijn op de ontwikkeling van het geheel en zijn onderdelen."). Wil je dat niet, omdat de hoofdletters een betekenis hebben (bijvoorbeeld in PDCA-cyclus), vul dan hier Ja in. Maakt het je niet uit, typ dan Nee of laat het veld leeg.
  • Beschrijving= Vul hierachter de beschrijving in die getoond moet worden in de tooltip als iemand de muiscursor boven het begrip laat zweven. Deze tekst kan opmaak bevatten.
  • Toelichting= Voeg hier extra informatie of uitleg toe die relevant is, maar NIET weergegeven hoeft te worden in de tooltip. Denk bijvoorbeeld aan links naar verwante begrippen, uitleg in welke context of voor welk doel het begrip is gedefinieerd, of voorbeelden. Ook verwijzingen naar andere definities kunnen nuttig zijn, zolang maar helder is waarom binnen NORANederlandse Overheid Referentie Architectuur gekozen is een eigen definitie te hanteren. De bezoeker kan vanuit de tooltip doorklikken naar de begripspagina of vanuit het Begrippenkader en ziet dan ook de toelichting staan.
  • Bron= Vul bij bron een (interne of externe) bron toe wanneer je het begrip hebt overgenomen of het begrip is gepubliceerd.
  • Vastgesteld in= Vul hier een gremium of publicatie in waarin het begrip formeel is vastgesteld. Dat kan op operationeel niveau zijn (expertgroep van NORANederlandse Overheid Referentie Architectuur), formeel binnen NORANederlandse Overheid Referentie Architectuur (in de NORANederlandse Overheid Referentie Architectuur Gebruikersraad) of helemaal buiten NORANederlandse Overheid Referentie Architectuur om (internationaal verdrag, gezaghebbende organisatie, conferentie et cetera). Het is ook prima om aan te geven dat het begrip (nog) niet is vastgesteld. Het doel is om bezoekers een idee te geven hoe formeel en/of gezaghebbend de definitie is, zodat ze geïnformeerd kunnen besluiten of ze het overnemen.
  • Wordt op andere pagina's toegelicht met een 'tooltip' om tooltips aan of uit te zetten.