Rst2HTML: directives

ReST is net als HTML een markeertaal ("markup language") - een hulpmiddel om een tekst te schrijven met daarin tegelijkertijd aangegeven de functie en eventueel ook de vorm van diversen onderdelen van die tekst. Maar anders dan HTML wordt deze markering gedaan met leestekens in plaats van tekst tags. Dus waar je in HTML bijvoorbeeld een stuk tekst zou benadrukken met de symbolen <em> en </em>, omgeeft je in ReST de tekst met asterisks. Dit maakt dat tekst gemarkeerd met RST makkelijker te lezen is dan tekst gemarkeerd met HTML.

Maar soms zijn niet-leesbare symbolen niet voldoende. Er is bijvoorbeeld geen leesteken-symbool voor het opnemen van een plaatje in de tekst. In dit soort situaties komen directives in beeld. Een directive is stukje tekst dat er zo apart uitziet dat het wel iets speciaals moet betekenen. Om preciezer te zijn: als een alinea begint met twee punten gevolgd door een woord afgesloten met een dubbele punt, dan is het geen gewonde tekst maar een directive (letterlijk: aanwijzing).

ReST kent een aantal ingebouwde directives zoals image en comment (zie hier) maar biedt tevens de mogelijkheid om je eigen directives te maken. Daardoor was ik in staat om vrij eenvoudig markup toe te voegen voor het maken van een pagina layout door middel van een css grid, of een speciale functie te maken die gebruik maakt van keywords in de tekst die gewoonlijk genegeerd worden om daarmee een cross-reference document voor de gehele site te genereren.

Hopenlijk geeft dit een idee van waar de zaken op de rechterkant van de applicatiepagina voor dienen.