Handleiding-koppelvlak
Uit Boektrust
Bestanden:
Koppelvlak bestanden (Zip bestand) met alle bestanden voor de koppelvlak REST interface
Handleiding koppelvlak (pdf)
Server vereisten
▪ Linux/Windows server met PHP versie 4.3 of groter
▪ SimpleXml module geïnstalleerd en actief, zie http://www.php.net/manual/en/simplexml.installation.php
Personalisatie
Het bestand config.php zorgt ervoor dat de software te personaliseren is en regelt bijvoorbeeld waar de email met de bestelling naar toe gaat, hoeveel resultaten er per pagina worden weergegeven etc.
Open het bestand config.php met notepad en pas de variabelen aan naar uw wensen. Sla het bestand daarna op onder dezelfde naam. In het config.php bestand staat wat elke variabele betekent voor de interface.
Uiterlijk van de interface
Het is mogelijk de interface vormgeving aan te passen naar de stijl van uw website.
Open hiervoor het bestand boek.css in notepad en pas de stijlen aan. Hiervoor is wel enige kennis van html/css nodig.
Elke pagina heeft zijn eigen stijlelementen, zodat alles apart kan worden vormgegeven. De stijlen hebben de naam van het element waar ze op van toepassing zijn.
Sla na wijziging het bestand onder dezelfde naam op.
Installatie op de server
Er zijn twee mogelijkheden om de software te gebruiken, een simpele en ingewikkeldere, te beginnen met de simpelste manier:
1) integratie van de code in een website middels een Iframe
- Plaats alle bestanden met FTP in een map op de server waar uw website/ webwinkel draait, bijvoorbeeld “zoekinterface”
- Plaats de volgende code op de plek van uw website waar u de zoekfunctionaliteit wilt laten zien (meestal een midden deel van een pagina)
<iframe src="http://{uw website adres}/{locatie waar de map met bestanden voor het zoeken staat}/zoek.php" width="100%" height="600" frameborder=”0” scrolling=”auto”>
Your browser does not support iframes.
</iframe>
De variabelen width en height kunt u naar eigen smaak aanpassen. Het is aan te bevelen een minimale breedte van 500 pixels en minimale hoogte van 500 pixels aan te houden. De variabele scrolling staat standaard op “auto”; een scrollbalk wordt zichtbaar zodra de content van het Iframe hoger is dan de opgegeven hoogte (height variabele). Scrolling kunt u ook op “no” zetten als u nooit een scrollbalk in het Iframe wilt zien. Zorg er dan voor dat de lijst met zoekresultaten altijd korter is dan het Iframe hoog is, anders zijn niet alle zoekresultaten zichtbaar.
- Sla de aangepaste pagina op en verplaats deze met FTP weer naar uw websiteadres.
- Test de interface door de pagina met de Iframe te openen en een boek te zoeken.
2) integratie van de code in eigen website code (alleen mogelijk bij php websites/pagina’s). Kennis van programmeren in HTML/PHP code is noodzakelijk! Gebruik de bestanden in de map “integratiecode”
- Plaats de bestanden missing_cover.jpg, config.php, functions.php en boek.css met FTP in een map op de server waar uw website/ webwinkel draait, bijvoorbeeld “zoekinterface”
- Open de php pagina waar u de zoekfunctie wilt gaan gebruiken, we noemen deze even zoekpagina.php in dit voorbeeld en maak hiervan nog 2 kopieën, genaamd bestel.php en boekdetails.php
- Open het bestand zoek.php en kopieer de codefragmenten (zie annotaties in de code) op de plaatsen waar u het zoekformulier CQ de boekenlijst wilt tonen. Zorg ervoor dat de referentie naar de map waar de config, functions en CSS bestanden staan kloppen!
- Open de kopie van uw website template “bestel.php” en open het bestand bestel.php uit de boek/integratiecode map. kopieer de codefragmenten (zie annotaties in de code) op de plaats waar u het bestelformulier wilt tonen. Zorg ervoor dat de referentie naar de map waar de config, functions en CSS bestanden staan kloppen!
- Open de kopie van uw website template “boekdetails.php” en open het bestand boekdetails.php uit de boek/integratiecode map. kopieer de codefragmenten (zie annotaties in de code) op de plaatsen waar u het boek en bestelknop wilt tonen. Zorg ervoor dat de referentie naar de map waar de config, functions en CSS bestanden staan kloppen!
- Sla alle bestanden op en zet alles met FTP op uw server en test de interface.
