Het Kuma-platform waar MDN op draait verstrekt een krachtig macrosysteem, KumaScript, dat het mogelijk maakt om een verscheidenheid aan taken te automatiseren. Dit artikel geeft informatie over hoe de macro's van MDN zijn te gebruiken in artikelen.

De KumaScript-gids geeft een grondige kijk in het gebruik van macro's op MDN. Deze sectie is een kort overzicht.

How macro's worden geïmplementeerd

Macro's op MDN worden geïmplementeerd met server-uitgevoerde Javascriptcode en worden geïnterpreteerd met Node.js. Daarbij hebben we een aantal bibliotheken dat we hebben geïmplementeerd en die wikigeoriënteerde diensten en functies leveren, waardoor macro's kunnen omgaan met het wikiplatform en zijn inhoud. Voor meer informatie kunt u de KumaScript-gids bekijken.

Een macro gebruiken in inhoud

Om een macro daadwerkelijk te gebruiken sluit u de call naar de macro in twee accolades en, als ze er zijn, zijn parameters in haakjes. Dat ziet er zo uit:

{{macronaam(parameterlijst)}}

Een paar opmerkingen over macro-calls:

  • Macronamen zijn hoofdlettergevoelig, maar er wordt geprobeerd om fouten in hoofdlettergebruik te corrigeren; u kunt alleen kleine letters gebruiken, zelfs wanneer de macronaam hoofdletters bevat, en u kunt een hoofdletter gebruiken bij een macro die oorspronkelijk met een kleine letter begint.
  • Parameters worden gescheiden met komma's.
  • Als er geen parameters zijn, mag u de haakjes weglaten; {{macronaam()}} en {{macronaam}} zijn identiek.
  • Numerieke parameters kunnen in aanhalingstekens staan, of niet. Dat mag u zelf bepalen (tenzij u een versienummer hebt met meerdere decimalen, dit moet binnen aanhalingstekens staan).
  • Als u fouten krijgt, bekijk dan uw code aandachtig opnieuw. Als u nog steeds niet kunt vinden wat er aan de hand is, bekijk dan Opsporen van KumaScript-fouten voor hulp.

Macro's worden zwaar gecacht; voor elke set van invoerwaarden (zowel parameters als omgevingswaarden, zoals de URL waarin de macro wordt uitgevoerd) worden de resultaten opgeslagen en opnieuw gebruikt. Dit betekent dat de macro alleen wordt uitgevoerd als de invoer verandert.

Opmerking: U kunt alle macro's dwingen om opnieuw geëvalueerd te worden door een de pagina in uw browser te forceren om te vernieuwen (shift-ververs).

Macros kunnen zo simpel zijn als het invoegen van een groter blok met tekst of het uitwisselen van inhoud naar een andere gedeelte van MDN, of zo ingewikkeld als het bouwen van een index van inhoud door het doorzoeken van gedeeltes van de website, opmaak toe te voegen aan de uitvoer en het toevoegen van links.

U kunt de meest gebruikte macro's vinden op de pagina Veelgebruikte macro's; er is ook een complete lijst van alle macro's. De meeste macro's hebben ingebouwde documentatie, door middel van commentaar bovenaan.

Documentlabels en -medewerkers

 Aan deze pagina hebben bijgedragen: evelijn
 Laatst bijgewerkt door: evelijn,