Skip links en inhoudsopgave

Laatst aangepast: .

Menu uit een ander bestand invoegen met Server Side Includes (SSI)

Korte omschrijving

Een menu uit een extern bestand invoegen met behulp van SSI (Server Side Includes). Handig als eenzelfde menu op meerdere pagina's voorkomt, want je hoeft het dan maar op één plaats te veranderen.

(Omschrijving menu zie pdf die in de download is bijgesloten in 087-files-zonder-ssi-dl.)

BELANGRIJK

Alles op deze site kan vrij worden gebruikt, met twee beperkingen:

* Je gebruikt het materiaal op deze site volledig op eigen risico. Het kan prima zijn dat er fouten in de hier verstrekte info zitten. Voor eventuele schade die door gebruik van materiaal van deze site ontstaat, in welke vorm dan ook, zijn www.css-voorbeelden.nl en medewerkers daarvan op geen enkele manier verantwoordelijk.

* Deze uitleg wordt regelmatig bijgewerkt. Het is daarom niet toegestaan deze uitleg op welke manier dan ook te verspreiden, zonder daarbij duidelijk te vermelden dat de uitleg afkomstig is van www.css-voorbeelden.nl en dat daar altijd de nieuwste versie is te vinden. Dit is om te voorkomen dat er verouderde versies worden verspreid.

Een link naar www.css-voorbeelden.nl wordt trouwens altijd op prijs gesteld.

Opmerkingen

Links in deze uitleg, vooral links naar andere sites, kunnen verouderd zijn. Op de pagina met links vind je steeds de meest recente links.

Alles op deze site is gemaakt op een systeem met Linux. Daarbij is vooral gebruik gemaakt van Quanta Plus, GIMP en Firefox met extensies. De pdf-bestanden zijn gemaakt met LibreOffice.

Vragen of opmerkingen? Fout gevonden? Ga naar het forum.

Iets gevonden waar je wat aan hebt? Mooi. Als je je waardering wilt uiten, maak dan een donatie over aan War Child Nederland, een organisatie die kinderen uit oorlogsgebieden helpt hun trauma's te verwerken. Of - nog beter - wordt donateur:
War Child Nederland

Achterliggend idee

(Achterliggend idee menu zie pdf die in de download is bijgesloten in 087-files-zonder-ssi-dl.)

Als een menu regelmatig terugkomt, kan het vervelend worden als er een wijziging in moet komen. Je moet dan op tig plaatsen het menu aanpassen. Als je 2343 pagina's hebt, kun je misschien ook wel iets leukers bedenken dan hetzelfde menu 2343 keer erin stoppen. (Om dan aan het eind te ontdekken dat er 'n typefout in zit, valse grinnik.)

Vaak wordt gekozen voor frames om dit op te lossen. Het te herhalen deel, bijvoorbeeld een menu, wordt dan vanuit een apart bestand in een frame gestopt, zodat het bij een verandering maar op één plaats hoeft te worden veranderd.

Frames hebben echter heel erg veel nadelen. iframes hebben voor een deel dezelfde nadelen. In html5 mogen frames helemaal niet meer worden gebruikt, iframes nog wel.

Een goede oplossing is het gebruik van Server Side Includes (SSI) of PHP. (Met PHP houd ik me op deze site verder niet bezig, op de pagina met links vind je tig sites daarover. Alles wat ik hier zeg over SSI, geldt echter ook voor PHP, maar de code daarvoor is anders.)

Op de plaats waar het menu moet worden ingevoegd, zet je 'n speciale opdracht voor de server: <!--#include file="tekst-087-invoeg-dl.txt" -->

Dit wordt dan door de server vervangen door het bestand wat achter file= staat. Van de hele regel tussen <!-- en --> vind je helemaal niets meer terug, die wordt vervangen door de letterlijke inhoud van het in te voegen bestand.

Het bovenstaande werkt alleen maar als het in te voegen bestand in dezelfde directory of een subdirectory van het hoofdbestand staat. Als het in te voegen bestand op 'n andere plaats staat, moet je het vervangen door:

<!--#include virtual="../../andere-dir/nog-andere-dir/dat-was-ver-weg.txt" -->

Tussen de aanhalingstekens zet je het pad naar het in te voegen bestand en de naam van dat bestand.

Omdat de server alles doet, komt er uiteindelijk dus een doodnormale pagina in de browser terecht. De css voor het in te voegen bestand is precies hetzelfde als die van het hoofdbestand.

In het voorbeeld kun je zien dat in tekst-087-invoeg-dl.txt een compleet uitklapmenu staat. De bijbehorende css staat gewoon bovenin het hoofdbestand. Een link naar 'n extern css-bestand in het hoofdbestand is ook geldig voor het ingevoegde bestand: het gedraagt zich volledig als één bestand.

Als een afbeelding (of wat dan ook) wordt gedownload door een browser, wordt deze - tenzij de gebruiker dit heeft uitgezet of de site dit expliciet verbiedt - opgeslagen in de cache van de browser. Als bijvoorbeeld de afbeelding dan nog 'ns nodig is, hoeft deze niet opnieuw te worden gedownload, maar kan uit de cache worden gehaald. Sneller en spaart bandbreedte uit. Ook dit soort dingen werkt precies hetzelfde als zonder SSI. Kortom: op alle punten is een pagina waar SSI wordt gebruikt voor de browser, zoekmachines, enz. volledig hetzelfde als een pagina zonder SSI.

In plaats van de extensie .html moet een pagina waar SSI in wordt gebruikt de extensie .shtml krijgen, zodat de server weet dat hij hierop moet letten.

Het in te voegen bestand moet 'n gewoon tekst-bestand zijn, dus eindigen op .txt. In dat bestand mogen gewoon tags zoals <p> worden gebruikt of 'n inline-style of wat dan ook. (Inline-styles kun je overigens beter helemaal niet gebruiken.) Het in te voegen bestand wordt als het ware gekopieerd en letterlijk in het hoofdbestand gezet.

(Sterker nog: in dit geval héb ik het in te voegen bestand letterlijk gekopieerd uit een al bestaand menu.)

Je moet het in te voegen bestand maken in 'n simpele tekstverwerker en opslaan als platte tekst, of hoe 't ook heet in jouw tekstverwerker. Als je het als word-document of zoiets opslaat, zit het vol verborgen opmaakcodes en barst de server in tranen uit en jij ook.

Beschrijving van code en css

(De code voor het menu wordt uitgelegd in de pdf die in de download is bijgesloten in 087-files-zonder-ssi-dl. Hier beperk ik me tot de code voor het invoegen en wat algemene dingen als doctype.)

De code die te maken heeft met de basis van dit voorbeeld is rood gekleurd. Alle voor dit voorbeeld niet-essentiële code is bruin.

Deze uitleg hoort bij het voorbeeld dat in de download zit. Het voorbeeld uit de download verschilt iets van het voorbeeld hier op de site. In de download ontbreken bijvoorbeeld de witte vlakken met de links. Ook in de kopregels zit vaak wat verschil. Daarnaast kunnen er nog andere (meestal kleine) verschillen zijn.

Als je deze uitleg leest naast de broncode van het voorbeeld op de site, kan het dus bijvoorbeeld zijn dat 'n h1 uit de css bij 'n <h2> uit de html hoort. Maar het gaat niet om hele grote, fundamentele afwijkingen.

Als je dit lastig vindt, downloadt dan de hele handel (ga terug naar het voorbeeld en kies daar voor downloaden). In de download zit 'n voorbeeld dat wel naadloos aansluit op de uitleg in de download.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="nl" lang="nl">

Een document moet met een doctype beginnen om weergaveverschillen tussen browsers te voorkomen. Zonder doctype is de kans op verschillende (en soms volkomen verkeerde) weergave tussen verschillende browsers heel erg groot.

Geldige doctypes vind je op www.w3.org/QA/2002/04/valid-dtd-list.html.

Gebruik het volledige doctype, inclusief de url, anders werkt het niet goed.

De toevoeging achter <html hierboven hoort bij het gekozen doctype.

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

Zorgt dat de browser letters met accenten en dergelijke goed kan weergeven. Als je als doctype html hebt gekozen, moet je niet eindigen op />, maar op > (dit geldt voor alles in de head wat eindigt op />).

utf-8 is de beste charset (tekenset), omdat deze alle talen van de wereld (en nog heel veel andere extra tekens) bestrijkt, maar toch niet meer ruimte inneemt voor de code dan nodig is. Als je utf-8 gebruikt, hoef je veel minder entiteiten (&auml; en dergelijke) te gebruiken, maar kun je bijvoorbeeld gewoon ä gebruiken.

Deze regel moet zo hoog mogelijk komen te staan, als eerste regel binnen de head, omdat hij anders door sommige browsers niet wordt gelezen.

<link rel="stylesheet" type="text/css" href="../../css/naam-van-stylesheet.css" /> <!--Instellingen voor Internet Explorer --> <!--[if IE]> <link rel="stylesheet" type="text/css" href="../../css/naam-van-ie-stylesheet.css"> <![endif]-->

Dit stukje code heeft in dit voorbeeldbestand geen enkel nut. Normaal genomen is het een verwijzing naar een extern stylesheet, waarin de style staat. In dit voorbeeld verwijst de href naar een niet bestaand bestand.

De bedoeling is dat je bovenstaande regels aanpast voor je eigen bestand. De hele style, die onder deze regels in de <head> staat, wordt dan in het externe bestand geplaatst waar de href naar verwijst. In dat bestand komt de style precies zo te staan zoals die nu in de <head> staat. Het bestand moet eindigen op .css.

Voordeel van een externe stylesheet is onder andere, dat deze geldig is voor alle pagina's waaraan deze is gelinkt. 'n Verandering in de lay-out hoef je dan maar op één enkele centrale plek te aan te brengen.

In die externe stylesheet zet je alles wat in dit voorbeeld tussen <style type="text/css"> en </style> staat (zonder deze begin- en eindregel).

De bovenste regel is voor de algemene stylesheet, geldig voor alle browsers. Dit is gewoon 'n link die naar 'n bestand elders verwijst, waar de css in staat. Op de plaats van "../../css/naam-van-stylesheet.css" moet je pad naar en naam van jouw stylesheet invullen.

Het eigenaardige stukje code daaronder heet een 'conditional comment' en wordt door alle browsers gezien als commentaar, omdat het tussen <!-- en --> staat. Maar Internet Explorer herkent het, door de extra toevoegingen, als speciaal voor Internet Explorer bedoeld en zal het dus uitvoeren. Het is veiliger dan een zogenaamde 'hack', waarbij vaak gebruik wordt gemaakt van 'n fout (bug) in de browser. Dit is opzettelijk aangebracht door Microsoft en zal dus blijven bestaan, terwijl 'n bug gerepareerd kan worden. Op deze manier kun je 'n stylesheet alleen voor Internet Explorer opnemen.

Dit stukje geldt voor alle versies van Internet Explorer, maar je kunt het ook per versie aangeven.

De link verwijst naar een aparte stylesheet voor Internet Explorer, waarin je css speciaal voor die browser zet. Op de plaats van "../../css-naam-van-ie-stylesheet.css" moet je pad naar en naam van je stylesheet voor Internet Explorer invullen.

De link naar het aparte stylesheet voor Internet Explorer moet ná de link naar het algemene stylesheet komen, omdat de opdrachten voor Internet Explorer dan over die uit het algemene stylesheet heen gaan.

<style type="text/css">

Voor de duidelijkheid staat de style hier in het bestand zelf, maar het is beter deze in een apart stylesheet te zetten, zoals hierboven beschreven. In die stylesheet komt alles wat tussen bovenstaande regel en </style> staat.

Technisch gezien is er geen enkel bezwaar om het in die stylesheet te zetten met dezelfde vreselijke lay-out als die ik in dit voorbeeld gebruik. Maar als je dat doet, garandeer ik je hele grote problemen omdat het volstrekt onoverzichtelijk is. Ik gebruik alleen deze lay-out omdat het anders veel te veel regels worden.

Voorbeeld van 'n goede lay-out in je css:


	div#header-buiten
	{
	    position: absolute;
	    right: 16px;
	    width: 100%;
	    height: 120px;
	    background: yellow;
	}

	div#header-binnen
	{
	    margin-left: 16px;
	    height: 120px;
	    text-align: center;
	}
<!--#include file="tekst-087-invoeg-dl.txt" -->

Dit is het commando dat voor het invoegen van het bestand zorgt. De browser krijgt dit helemaal niet te zien, omdat het wordt vervangen door het in te voegen bestand.

Het eigenlijke commando is include: voeg in. Daarachter volgt file=, en daarachter de bestandsnaam van het in te voegen bestand.

Het is belangrijk dat er geen spaties staan in het eerste deel: <!--#include.

Het in te voegen bestand moet in dezelfde directory staan als het hoofdbestand, of in een subdirectory daarvan. Als het ergens anders staat moet je file vervangen door virtual:

<!--#include virtual="../../../hiero/daaro.txt" -->

Tussen de aanhalingstekens moeten dan pad en bestandsnaam komen te staan.

Het bestand dat wordt ingevoegd (tekst-087-invoeg-dl.txt)

<div id="menu"> <ul> <li><a id="linkerknop" class="niveau-1" href="#" title="Dit is alleen een menu-ingang, geen link">Knop 1

Dit is maar 'n klein stukje uit het in te voegen bestand, omdat dat 'n aantal pagina's lang is.

Zoals je ziet, is dit een volkomen normaal stuk html. Maar dingen als body en head worden niet gebruikt, omdat deze html wordt ingevoegd in een bestaande pagina, die dat al heeft. Er wordt exact wat hier staat ingevoegd, niets meer en niets minder. Dus je zou deze html ook gewoon kunnen kopiëren en in het hoofdbestand kunnen plakken, in plaats van het include-commando. Dan zou het precies hetzelfde werken.

In de div staat id="menu", in de <a> id="linkerknop". Omdat het geheel als één normale pagina werkt, worden deze id's gewoon aangestuurd door de css in de head van het hoofdbestand.

Het invoegbestand moet een gewoon tekst-bestand zijn, ook wel 'platte tekst' genoemd. Zonder enige opmaakcode van 'n tekstverwerker of zo. Als je iets groot of klein of wat dan ook wilt hebben, gebruik je gewoon de normale html-codes, id's, classes, enz. De extensie moet .txt zijn.

De code aanpassen aan je eigen ontwerp

Toegankelijkheid en zoekmachines

Het eerste deel van deze tekst is voor alle voorbeelden hetzelfde. Eventueel specifiek voor dit voorbeeld geldende dingen staan verderop onder het kopje Specifiek voor dit voorbeeld.

Toegankelijkheid (accessibility in het Engels) is belangrijk voor bijvoorbeeld blinden die een spraakbrowser gebruiken, of voor motorisch gehandicapte mensen die moeite hebben met het bedienen van een muis. Een spider van een zoekmachine (dat is het programmaatje wat de site indexeert voor de zoekmachine) is te vergelijken met een blinde. Als je je site goed toegankelijk maakt voor gehandicapten, is dat dus gelijk goed voor een hogere plaats in een zoekmachine. Dus als je 't niet uit sociale motieven wilt doen, kun je 't uit egoïstische motieven doen.

(Op die plaats in de zoekmachine heb je maar beperkt invloed. De toegankelijkheid van je site is maar één van de factoren, maar zeker niet onbelangrijk.)

Als je bij het maken van je site al rekening houdt met toegankelijkheid, is dat nauwelijks extra werk. 't Is ongeveer te vergelijken met inbraakbescherming: doe dat bij 'n nieuw huis en 't is nauwelijks extra werk, doe 't bij 'n bestaand huis en 't is al snel 'n enorme klus.

Enkele tips die helpen bij toegankelijkheid:

Specifiek voor dit voorbeeld

Het op deze manier invoegen van 'n menu heeft geen enkele invloed op resultaten in zoekmachines of op toegankelijkheid. Omdat het invoegen al op de server gebeurt, wordt er een volledig normale pagina gedownload. Als je in de broncode van het voorbeeld kijkt (online, in het gedownloade voorbeeld werkt het niet), zul je niets bijzonders zien. Het is 'n doodnormale pagina.

Getest in

Laatst gecontroleerd op 2 mei 2011.

(Internet Explorer 6 is voor het laatst gecontroleerd op 21 april 2010. Op deze browser test ik niet meer. Maar omdat de code niet is veranderd, neem ik aan dat dit voorbeeld ook nog werkt in Internet Explorer 6.)

Dit voorbeeld is getest in Firefox, Opera, Safari, Google Chrome, Internet Explorer 6, 7, 8 en 9 in de resoluties 800x600, 1024x768, 1280x1024 en 1440x900. Steeds met de laatste versie van die browsers, omdat ik geen zin heb om rekening te houden met mensen die met zwaar verouderde browsers surfen. Dat is trouwens vragen om ellende, want updates van browsers hebben heel vaak met beveiligingsproblemen te maken. In de resoluties 1024x768, 1280x1024 en 1440x900 is ook in- en uitzoomen en een kleinere en grotere letter getest. Er is ingezoomd en vergroot tot zover de browser kan, maar niet verder dan tot 200%.

Eventuele problemen met betrekking tot zoomen en lettergrootte staan bij Bekende problemen.

Er is getest met behulp van muis en toetsenbord.

Naast deze 'gewone' browsers is ook getest in Lynx, WebbIE, NVDA en Fangs Screen Reader Emulator. Lynx is een browser die alleen tekst laat zien en geen css gebruikt. WebbIE is een browser die gericht is op mensen met een handicap. NVDA is een screenreader, zoals die door blinden wordt gebruikt. Fangs Screen Reader Emulator is een extensie bij Firefox, die de pagina laat zien zoals een screenreader hem ziet.

Als het voorbeeld in deze vier programma's toegankelijk is, zou het in principe toegankelijk moeten zijn in alle aangepaste browsers en dergelijke. En dus ook voor zoekmachines, want een zoekmachine is redelijk vergelijkbaar met een blinde. Eventuele opmerkingen over de toegankelijkheid van dit voorbeeld staan onderaan Toegankelijkheid en zoekmachines onder het kopje Specifiek voor dit voorbeeld.

Alleen op de hierboven genoemde systemen en browsers is getest. Er is dus niet getest op bijvoorbeeld mobiele systemen als iOS of Android, en ook niet op apparaten als smartphones, iPad, enz. De kans is heel erg groot dat dit voorbeeld niet (volledig) werkt op dat soort systemen en apparaten. Om het wel (volledig) werkend te krijgen, zul je vaak wijzigingen en/of aanvullingen moeten aanbrengen.

De html is gevalideerd met de validator van w3c, de css ook. Als om een of andere reden niet volledig gevalideerd kon worden, wordt dat bij Bekende problemen vermeld.

Nieuwe browsers test ik pas als ze uit het bèta-stadium zijn, omdat er anders 'n redelijke kans is dat ik 'n bug zit te omzeilen, die voor de uiteindelijke versie nog gerepareerd wordt. Dit voorbeeld is alleen getest in de hierboven met name genoemde browsers. Vragen over niet-geteste browsers kan ik niet beantwoorden, en het melden van fouten in niet-geteste browsers heeft ook geen enkel nut. (Melden van fouten, problemen, enz. in wel geteste browsers: graag!)

Wijzigingen

(Wijzigingen menu zie pdf die in de download is bijgesloten in 087-files-zonder-ssi-dl.)

:

Nieuw opgenomen.

Bekende problemen

(Bekende problemen menu zie pdf die in de download is bijgesloten in 087-files-zonder-ssi-dl.)

Alle browsers

Eigenlijk kunnen er geen echte problemen zijn, want dit werkt helemaal niet of helemaal wel.

Je kunt dit alleen maar testen op een server, niet op je thuiscomputer. Tenzij je zelf 'n server installeert.