Bij het vertalen van documentatie moet je bepaalde keuzes maken. Die keuzes zijn niet altijd gemakkelijk. Aan een kant wil je de tekst zo duidelijk mogelijk maken, maar aan de andere kant word je daarin belemmerd door de woordkeuze in de oorspronkelijke taal en de keuzes die in die taal zijn gemaakt voor bepaalde handelingen.
SPIP gebruikt bij de codering van de modellen waarmee de webpagina’s worden opgebouwd een markuptaal die kan worden omschreven als een uitgebreide HTML. Net als in HTML wordt gebruik gemaakt van tussen punthaken geplaatste codes <...>
die in HTML tags worden genoemd. In deze gebruiksaanwijzing gebruiken wij dat woord ook, maar uitsluitend voor HTML-tags. Voor de tussen punthaken geplaatste codes van SPIP hebben we gekozen voor de term baken
, wat een vertaling is van het Franse balise.
De markuptaal van SPIP combineert HTML, PHP, SQL en JavaScript. Zo bestaat er bijvoorbeeld de mogelijkheid om gegevens uit de (SQL-)database van SPIP te lezen en weer te geven. Dat doe je met behulp van een lus
, een vertaling van het Franse boucle. Je zult dit Franse woord ook in deze Nederlandstalige gebruiksaanwijzing terugvinden, maar dan als onderdeel van de bakens
. De meeste instructies in de markuptaal van SPIP zijn Franstalig en kunnen vanzelfsprekend niet vertaald worden.
Aan die lussen kun je bepaalde voorwaarden of criteria toevoegen, zoals "uitsluitend artikelen uit een bepaalde rubriek".
Om aan te geven welke gegevens je (al dan niet uit de database) wilt weergeven, maakt SPIP ook gebruik van codes die niet tussen punthaken staan, maar in hoofdletters geschreven worden en beginnen met een dubbelkruis (#
). Ook deze bakens hebben meestal een Franse naam, zoals #TITRE
voor een titel.
Je wilt niet altijd de exacte inhoud van de gegevens uit de database weergeven. Daarvoor gebruikt SPIP zogenaamde filters
, in het Frans filtres. Deze beginnen altijd met een pipe-symbool (|
) gevolgd door hun naam en eventuele parameters. Filters kunnen niet alleen gegevens wegfilteren, maar ook gegevens toevoegen of omzetten.
Aan het begin van deze inleidende tekst hadden we het al over de modellen die SPIP gebruikt om webpagina’s op te bouwen. Het zijn een soort sjablonen in een HTML jasje. We noemen ze skeletten
, analoog aan het Franse squelettes. Toch zul je ook het woord model
terugvinden. Het zijn fragmenten programmeercode (snippets) die op meerdere plaatsen kunnen worden toegepast, maar ook vereist zijn voor de ajax-functionaliteit in sommige webpagina’s.
Alles wat door SPIP als webpagina wordt weergeven, komt uit skeletten. De (PHP) programma’s van SPIP zorgen ervoor dat die skeletten precies weten wat ze moeten weergeven. Die gegevens worden deels doorgegeven via de URL waarmee zo’n skelet wordt aangeroepen, maar ook door een aantal omgevingsvariabelen die zijn vastgelegd, zoals de taal, maar ook de huidige datum of de naam van de website. Al deze gegevens duiden we in deze documentatie aan met de context
. Zo’n context kan ook binnen een skelet veranderen, zoals binnen een lus, waarin bijvoorbeeld het nummer van ieder artikel anders is en de datum ineens de datum van het artikel weergeeft.
In de editoriale interface van SPIP werk je aan de inhoud van je website. In deze documentatie gebruiken we, net als in de Nederlandstalige versie van SPIP, de term privé gedeelte
, terwijl de bezoekers van je site op de publieke site
terecht komen.
In het privé gedeelte kun je voor de opmaak van je tekst gebruik maken van HTML-tags, maar SPIP biedt ook een aantal opmaakcodes
die het voor jou omzet in HTML. Deze opmaakcodes zijn met de tekst opgenomen in de database, wat inhoudt dat je ze in één keer allemaal kunt aanpassen, bijvoorbeeld wanneer je de stijl van je website aanpast.
Een opsomming van de belangrijkste Franstalige termen in SPIP vind je in Termen in SPIP (Frans-Nederlands).