Automatische meertalige referenties in de documentatie

Dit artikel legt uit waarom systematisch gebruik moet worden gemaakt van de snelkoppeling [{}->artN], of [{}->N], om te verwijzen naar het artikel N van de documentatie en daarvan de vertaling in de taal van het artikel zelf te selecteren.

Vanaf SPIP 2.0 bestaat de mogelijkheid om de hreflang in een link te gebruiken. In deze documentatiesite maken we van deze mogelijkheid gebruik om eenvoudig naar het juiste artikel (in de juiste taal) te verwijzen.

In de snelkoppeling om een link aan te maken ([->N]) kan tussen accolades een taalcode worden meegegeven. Deze code wordt in het HTML-attribuut hreflang geplaatst. Een paar accolades zonder inhoud ([{}->N]) heeft voor SPIP een speciale betekenis: het geeft aan dat het attribuut moet worden gevuld met de taalcode van het artikel zelf. SPIP gaat nu zoeken bij artikel N of er een vertaling bestaat in die taalcode en vervangt dan het artikelnummer in de link. Vindt het die vertaling niet, dan blijft het artikelnummer onveranderd.

Wanneer een artikel vertaald wordt, wordt eerst een kopie gemaakt van de bron. In dat bronartikel kunnen verwijzingen zitten naar andere artikelen. Deze links worden ook gekopieerd en blijven dus ook verwijzen naar artikelen in de taal van de bron.

In deze documentatie maken we gebruik van een specifieke eigenschap van SPIP, de notatie [{}->artN]. Hiermee wordt verwezen naar de vertaling van het artikel N in de taal van het artikel dat de link bevat. Het betekent dus dat het artikelnummer in de snelkoppeling niet hoeft te worden vervangen door het artikelnummer van de vertaling van artikel N. Een bijkomend voordeel is dat niet allerlei artikels hoeven worden aangepast wanneer een artikel werd vertaald. SPIP zoekt zelf iedere keer of het artikel in de juiste taal beschikbaar is.

Auteur Hanjo Gepubliceerd op:

Vertalingen: català, corsu, English, Español, français, Nederlands