Instructie. WordPress. [Datum]

Transcriptie

1 Instructie WordPress [Datum]

2 Inhoud 1 Inleiding Doelgroep Gerelateerde documenten Carta Online WordPress Plugin Inleiding Installatie Configuratie Widget Filter Gebruik Filter Shortcode Sortering HTML Contact... 9 Carta - Instructie WordPress.docx Pagina 2

3 1 Inleiding Carta is een uitgebreid pakket voor cursusadministratie en evenementbeheer. Dit document maakt onderdeel uit van een set van instructiedocumenten, die elk een specifiek onderdeel van Carta beschrijven en toelichten. In dit document wordt besproken hoe Carta te koppelen is aan WordPress zodat een actueel aanbod op uw website getoond kan worden. 1.1 Doelgroep Profiel doelgroep: Website bouwers van Carta Klanten die gebruik maken van WordPress Kennis na afloop van deze instructie: Installatie van de plugin in WordPress Algemene kennis over het gebruik van de plugin Bekend met de structuur van Carta Online widgets Bekend met Carta Online ShortCode in WordPress 1.2 Gerelateerde documenten Dit document maakt een onderdeel uit van de Carta Instructie documenten. Meer informatie over deze documenten vindt u in het document: Overzicht Carta Instructie. 2 Carta Online WordPress Plugin 2.1 Inleiding De Carta Online WordPress plugin stelt de klant in staat om haar publieke aanbod in hun eigen WordPress omgeving te integreren. Het aanbod wordt beschikbaar gesteld in Carta Backoffice, waarna deze online te zien is. Het aanbod kan gefilterd getoond worden en bevat hyperlinks naar de Carta Online omgeving, zodat een website bezoeker zich eenvoudig in kan schrijven. 2.2 Installatie Voordat u met de installatie begint, dient u te beschikken over de Carta Online WordPress plugin. De plugin is te downloaden vanaf de website van Carta Online via de URL: Carta - Instructie WordPress.docx Pagina 3

4 Via het admin dashboard van de website kiest u de optie Plugins -> Add New of Plugins -> Nieuwe Plugin komt u in het plugin-installatie scherm van WordPress terecht. Bovenin het scherm heeft u de mogelijkheid om de Carta Online plugin te installeren. Druk hiervoor op de knop [Plugin uploaden]. Het scherm dat volgt hang af van uw browser, maar in het scherm kunt u bladeren naar het gedownloade bestand, en kunt u op de knop installeren drukken. Als alles goed gegaan is staat Carta Online in de lijst met plugins. Druk op de knop Activeren om de plugin te activeren. Na activatie, staat er in het admin menu een nieuwe menuoptie: Carta Online. 2.3 Configuratie Nadat de plugin correct is geïnstalleerd, dient de plugin geconfigureerd te worden. Kies in het admin menu de optie: Carta Online. Wanneer er op dit item geklikt wordt kunnen de volgende instellingen geconfigureerd worden: Carta - Instructie WordPress.docx Pagina 4

5 - Portal Address (URL) Dit is het adres van de portal van de gebruiker. Https is noodzakelijk, en de url mag NIET eindigen op een /, anders werkt de plugin niet, zie voorbeeld: - API-Key Dit is de API-sleutel die gebruikt wordt om te authentiseren en autoriseren bij Carta Online, de sleutel is aan te maken en terug te vinden in het portaal van Carta Online. - Cache Duration De tijd waarin de informatie gecached wordt door de plugin: Hoe hoger de cache duration, hoe beter de performance van de plugin, hoe lager, hoe meer up-to-date de gegevens zijn. Er is nog geen validatie toegevoegd aan het Settings scherm, indien de plugin niet werkt is de kans groot dat een van deze instellingen niet klopt. 3 Widget De plugin bevat 1 widget, deze is toe te voegen aan een placeholder van een widget (welke afhankelijk zijn van het huidige thema). De widget bevat een aantal instellingen, op basis van deze instellingen kan een selectie (filter) gemaakt worden op het totale aanbod. Er kunnen meerdere widgets toegevoegd worden, elk met een verschillende selectie van het aanbod. - Title. De titel van het widget, deze wordt op basis van het thema getoond (ja/nee). - Number of items to show Aantal aanboditems dat in de widget getoond wordt. Carta - Instructie WordPress.docx Pagina 5

6 3.1 Filter Om een selectie te maken van het totale aanbod, wordt er gebruik gemaakt van een generiek filter. Status De status van het aanbod item, de volgende statussen worden gehanteerd: - Canceled: De cursus/leergang is geannuleerd. - Finished: De cursus/leergang is afgelopen, d.w.z. de huidige datum > laatste datum-eind van de planning van de cursus/leergang. - Started: De cursus/leergang is begonnen, d.w.z. de cursus is niet afgelopen (zie boven) maar de datum-start van het plannings item is overschreden. - Closed: De huidige datum valt niet in de publicatie-datum/start-eind van de cursus/leergang - AlmostFull: Er zijn nog maximaal 3 plekken over. - Full: Er zijn geen plekken meer over. - Open: Er kan ingeschreven worden op de cursus. LET OP! Men kan zich alleen inschrijven voor een aanbod item met de volgende status: Open; AlmostFull. Type Het type geeft aan van wat voor type het aanbod item is. De moeder-dochter relatie wordt gebruikt om binnen het aanbod opleidingen te groepen. Een moedercursus bevat de algemene beschrijving, terwijl de dochters de uitvoeringen zijn waarin onder meer de startdatum en locatie vastgelegd worden. In de regel wordt eerst de moedercursus geselecteerd, waarna de deelnemer de gewenste uitvoering of dochter kan selecteren. De volgende types zijn beschikbaar: - SingleClass: een op zichzelf staande cursus. - MotherClass: een moeder cursus. - DaughterClass: een dochter cursus, heeft dus een moeder. - SingleCourse: een leergang. Dit is een verzameling cursussen. Location De locatie van de cursus, op basis van de planning van een cursus. De locatie is dynamisch vanuit Carta. Category De beschrijving van de cursussoort van het aanboditem. De categorie is dynamisch vanuit carta. 3.2 Gebruik Filter Om het volledige aanbod te voorzien van een filter kunnen de velden gevuld worden in het filter. Er kunnen meerdere filter eigenschappen aangegeven worden, gescheiden door een ; (punt-komma). Een eigenschap kan ook uitgesloten worden door middel van een! (uitroepteken) voor de eigenschap. Als alle eigenschappen leeg zijn wordt het totale aanbod weergegeven. Het filter is case-insensitive. Voorbeeld: Klant wil alle items weergeven in een lijst die gegeven worden in rotterdam noord waarvoor een gebruiker zich kan inschrijven. Status: almostfull;open; Type: [empty] Carta - Instructie WordPress.docx Pagina 6

7 Location: rotterdam noord; Category: [empty] Omdat een filter ook geïnverteerd kan worden levert het volgende filter hetzelfde aanbod op: Status:!canceled;!finished;!started;!full;!closed; Type: singleclass;motherclass;daughterclass;singelcourse; Location: rotterdam noord; Category: [empty] De widget ziet er dan alsvolgt uit: HTML: 4 Shortcode Shortcodes kunnen worden gebruikt om content in bijv een post of page te voorzien van een voorgedefinieerd stuk HTML. Voor deze plugin is één shortcode toegevoegd: Deze werkt op basis van het eerder genoemde filter, maar dan inline in de content editor: [co-offerlist status="open;almostfull;" location="rotterdam noord" category="" type=""] Carta - Instructie WordPress.docx Pagina 7

8 Indien een filter leeg is (bijv type= ) kan deze ook weggelaten worden. De pagina ziet er dan bijvoorbeeld als volgt uit: 4.1 Sortering De sortering van het aanbod wordt door het systeem bepaald. De sortering is op basis van de relevantie die de gebruiker aan de opleiding heeft gegeven. De belangrijkste factor in de sortering is een promotie vinkje Carta. Alle opleidingen die dat vinkje hebben, komen boven in het aanbod terecht. Het aanbod wordt op de volgende manier gesorteerd: 1. Aanbod item is promotie 2. Aanbod item heeft startdatum 3. Startdatum van het aanboditem. Carta - Instructie WordPress.docx Pagina 8

9 5 HTML Hieronder een overzicht van de classes die in de gegenereerde HTML gebruikt worden: <ul id="" class="co-offer-list"> <li id="co-offer-cl57" class="co-offer-item co-offer-item-cat-zelfplan cursus co-offer-typeclassdaughter co-offer-status-open"> <a class="co-offer-info-link" href=" <span class="co-offer-subject">zelf Rapportages maken in Carta</span> </a> <span class="co-offer-next-start-date">10 januari 2010</span> <span class="co-offer-location">zeist</span>... </ul> De styling kan op basis van de classes in het hierboven getoonde voorbeeld uitgevoerd worden. Onderstaande classes zijn speciale items, die op basis de status van het aanboditem toegevoegd worden. co-offer-item-cat-nnnn nnnn is de categorie waartoe het aanboditem hoort. Er kunnen meerdere categoriën per aanboditem gedefinieerd zijn. co-offer-type-nnnn nnnn is classdaughter, classsingle, classmother, coursesingle co-offer-status-nnnn nnnn is open, canceled, finished, started, closed, almostfull, full 6 Contact Carta Online Bergweg AC Zeist info@cartaonline.nl Carta - Instructie WordPress.docx Pagina 9