Handleiding Update Trefwoordenlijst v3.0 (Geavanceerde trefwoordenlijst)
1.1 Document distributie Naam Functie Bedrijf Tel E-mail Kenny De Boe Developer e2e 09-267-64-70 kenny.deboe@e2e.be Michaël Geens Afg. Best. e2e 09-267-64-71 Michael.geens@e2e.be 1.2 Document controle Versie Nummer Auteur Omschrijving wijziging Datum wijziging 3.0 Kenny De Boe Versie aangeboden ter 2012-01-31 goedkeuring Versie :1.0 : werk Datum 2012-01-31 2/19
Inhoudsopgave 1.1 Document distributie... 2 1.2 Document controle... 2 2 WAT IS EEN TREFWOORDENLIJST / LOKET... 4 2.1 Voorbeeld trefwoordenlijst met categorielijst... 4 2.2 Voorbeeld Toplijst... 5 2.3 Voorbeeld filter op categorie... 5 2.4 Voorbeeld zoeken... 5 3 LINKS IN TREFWOORDENLIJST... 7 3.1 Zoekopdracht... 7 3.2 Content... 7 3.3 Menuitem... 7 3.4 URL... 7 4 BACKOFFICE... 8 4.1 Configuratie trefwoordenlijst... 9 4.1.1 Algemeen... 9 4.1.2 Koppelingen... 10 4.1.3 Type zoek... 11 4.1.4 Type Content... 11 4.1.5 Type Menuitem... 12 4.1.6 Type URL... 13 4.2 Configuratie lijsten... 13 4.3 Configuratie Categorieën... 14 4.3.1 Hoofdcategorieën... 14 4.3.2 Categorieën... 15 4.4 Configuratie modules... 16 4.4.1 Trefwoordenlijst Geavanceerd... 17 4.4.2 Trefwoordenlijst Toplijst... 19 Versie :1.0 : werk Datum 2012-01-31 3/19
2 Wat is een trefwoordenlijst / Loket Een trefwoordenlijst is een alfabetische lijst met relevante woorden. Deze kunnen gelinkt worden aan een zoekopdracht, een contentitem zoals een pagina, nieuwsbericht, document, formulier en een menuitem of gewoonweg een externe URL. Extra hierbij is nu dat trefwoorden tot één of meerdere lijsten kunnen behoren, bijvoorbeeld om een burgerloket en bedrijvenloket uit te werken. Binnen een lijst (loket) kunnen verschillende categorieën worden aangemaakt, zodat er gericht naar gezocht worden. Per module kan er aangegeven worden welke lijsten er precies moeten getoond worden. De trefwoorden worden initieel in één lange lijst getoond, alfabetisch opgedeeld. Deze lijst kan gefilterd worden door de A-Z index te gebruiken, te zoeken op een deel van een zoekwoord met de zoekfunctie of door een categorie te selecteren. 2.1 Voorbeeld trefwoordenlijst met categorielijst Figuur 1: Trefwoordenlijst op website. Versie :1.0 : werk Datum 2012-01-31 4/19
2.2 Voorbeeld Toplijst Er is tevens een module beschikbaar waarmee de populairste trefwoorden kunnen worden getoond. Dit komt doordat een teller iedere klik op een trefwoord bijhoudt. Deze module kan op iedere pagina gezet worden. Figuur 2: Toplijst op een website 2.3 Voorbeeld filter op categorie Wanneer een thema wordt geselecteerd, zullen enkel deze trefwoorden worden getoond. De zoekfunctie zal tevens ook ENKEL zoeken binnen de geselecteerde categorie. Om terug te gaan naar de volledige lijst klikt men op verwijder filter. Figuur 3:Geselecteerde categorie op website 2.4 Voorbeeld zoeken Er kan gezocht worden op een deel van een zoekwoord. Om terug te gaan naar de volledige lijst klikt men op verwijder filter. Versie :1.0 : werk Datum 2012-01-31 5/19
Figuur 4: Trefwoord zoeken op website Versie :1.0 : werk Datum 2012-01-31 6/19
3 Links in trefwoordenlijst Een trefwoord heeft algemeen een Titel, plaats en taal. De titel is wat zal getoond worden in de trefwoordenlijst en afhankelijk van het gekozen type zal deze een zoekopdracht zijn, een link naar een contentitem, een menu item of een externe url. Een trefwoord moet gekoppeld worden aan minstens één website en één lijst om getoond te kunnen worden op de website. Een koppeling met categorieën is optioneel. 3.1 Zoekopdracht Dit is de standaard functionaliteit van de trefwoordenlijst. De module wordt zo geconfigureerd dat deze het opgegeven woord zal zoeken in de algemene zoekresultaten. Zo kan er gericht gezocht worden in de contentitems (pagina s, nieuwsberichten, ) waar het zoekwoord ook in voorkomt. 3.2 Content Voortaan kan een trefwoord ook gekoppeld worden aan een contentitem, waarbij hoofdzakelijk pagina s zullen gekoppeld worden, maar er kunnen ook documenten, formulieren gelinkt worden aan het trefwoord. Deze zullen dan op het menuitem van de module getoond worden. 3.3 Menuitem Het is ook mogelijk om een trefwoord de koppelen aan een menuitem. Dit kan een menuitem zijn van op dezelfde website waar de module staat, maar eventueel ook van een andere website binnen het CMS. De module zal ervoor zorgen dat de link dan naar het juiste menuitem gaat op de website waar het menuitem onder valt. 3.4 URL Het kan ook nuttig zijn om bepaalde trefwoorden te koppelen aan een externe website. Wanneer er dan op het trefwoord geklikt wordt zal de website in een nieuw venster geopend worden. Versie :1.0 : werk Datum 2012-01-31 7/19
4 Backoffice Enkel administrator en webmasters kunnen trefwoorden toevoegen en beheren. Dit kan via de applicatie Websitebeheer -> Instellingen -> Trefwoordenlijst Naast de eigenlijke trefwoorden kunnen er tevens de lijsten en categorieën worden beheerd. Figuur 5: navigatiestuctuur Versie :1.0 : werk Datum 2012-01-31 8/19
4.1 Configuratie trefwoordenlijst De navigatielink Trefwoordenlijst toont initieel het zoekscherm, waar een trefwoord kan opgezocht worden en aangepast. Na de zoekopdracht (trefwoord mag blanco zijn) wordt een lijst getoond met de reeds ingegeven trefwoorden. Helemaal rechts kan er afgelezen worden hoeveel keer een trefwoord is aangeklikt. Via de knop Nieuw kan een nieuw trefwoord toegevoegd worden. 4.1.1 Algemeen Standaard zal het type Zoek geselecteerd worden. Figuur 6: Algemeen Titel: de naam van het trefwoord; deze wordt getoond in de trefwoordenlijst Type: kies het type link Taal: taal waarin het trefwoord is geschreven. De module zal geen trefwoorden tonen in een andere taal als deze waarop de gebruiker is. Versie :1.0 : werk Datum 2012-01-31 9/19
4.1.2 Koppelingen Om een trefwoord te kunnen tonen op de website moet deze minstens gekoppeld worden aan minstens één website én één lijst. Selecteer de website(s) waar het zoekwoord op mag getoond worden. Handig als er subsites geconfigureerd zijn als OCMW, Cultuur, dan kunnen die hun eigen trefwoordenlijst hebben. Hou de <ctrl> toets ingedrukt op meerdere websites te selecteren. Figuur 7: Websites koppelen Om een trefwoord toe te voegen aan een lijst en één of meerdere categorieën kan dat door de keuzelijst open te klappen. Hierin staan alle lijsten, en onder iedere lijst de gekoppelde categorieën. Door deze aan te vinken worden die aan het trefwoord gekoppeld. Figuur 8: Lijsten en categorieën koppelen. Versie :1.0 : werk Datum 2012-01-31 10/19
4.1.3 Type zoek Woord: het zoekwoord die zal opgezocht worden in de algemene zoek. Dit hoeft niet noodzakelijk hetzelfde te zijn als de titel. 4.1.4 Type Content Figuur 9: Type content Content: Via het verrekijkertje kan een contentitem opgezocht worden Figuur 10: Contentpicker Aan de hand van de contentpicker kan een pagina, nieuwbericht, acitiveit, document of formulier gekoppeld worden aan het trefwoord. Versie :1.0 : werk Datum 2012-01-31 11/19
4.1.5 Type Menuitem Figuur 11: Type menuitem Menuitem: Via het verrekijkertje kan een menuitem gekoppeld worden aan het trefwoord. Figuur 12: Menuitem kiezen Versie :1.0 : werk Datum 2012-01-31 12/19
4.1.6 Type URL Figuur 13: Type url URL: de url waarnaar het trefwoord moet gaan. De url wordt geopend in een nieuw venster. 4.2 Configuratie lijsten Een lijst is een specifiek groep van trefwoorden, dit is in principe de eerste filter voor de gebruiker. Standaard zal steeds de eerste lijst volledig worden opgebouwd. Een lijstitem kan gebruikt worden om verschillende digitale loketten te maken, zoals een burgerloket, bedrijvenloket, etc.. Via de knop Nieuw kan een nieuwe lijst toegevoegd worden. Figuur 14: Lijsten Referentie: de referentie van de lijst. Titel: de naam van de lijst; deze wordt getoond boven de trefwoordenlijst en is aanklikbaar. Omschrijving: een interne omschrijving van de lijst. Taal: In de dropdownlijst kan een andere taal worden geselecteerd, om zo de naam van de lijst in een andere taal in te geven. Versie :1.0 : werk Datum 2012-01-31 13/19
4.3 Configuratie Categorieën Categorieën worden gebruikt om trefwoorden te kunnen onderverdelen. Categorieën worden gegroepeerd met een hoofdcategorie. 4.3.1 Hoofdcategorieën Voorbeelden van hoofdcategorieën zijn: Thema s, Doelgroepen, Levensweg, etc. Figuur 15: Hoofdcategorieën overzicht. Via de knop Nieuw kan een nieuwe hoofdcategorie toegevoegd worden. De lijst van categorieën wordt opgevraagd door rechts van de hoofcategorie een op het icoontje te klikken. Daar kunnen dan ook nieuwe categorieën worden toegevoegd. Figuur 16: Hoofdcategorie details Referentie: de referentie van de hoofdcategorie. Titel: de naam van de hoofdcategorie; deze wordt getoond in de categoriemodule die bij de trefwoordenlijst hoort. Lijst: de lijst waartoe de hoofdcategorie behoort. Omschrijving: een interne omschrijving van de hoofdcategorie. Taal: In de dropdownlijst kan een andere taal worden geselecteerd, om zo de naam in een andere taal in te geven. Versie :1.0 : werk Datum 2012-01-31 14/19
4.3.2 Categorieën Een trefwoord kan gekoppeld worden aan een categorie. Voorbeeld: de hoofdcategorie Levensweg kan bestaan uit de categorieën Geboorte, Studeren, Werken, Samenwonen, etc. Figuur 17: Categorieën overzicht. Via de knop Nieuw kan een nieuwe categorie toegevoegd worden. Figuur 18: Categoriedetails Referentie: de referentie van de hoofdcategorie. Titel: de naam van de hoofdcategorie; deze wordt getoond in de categoriemodule die bij de trefwoordenlijst hoort. Hoofdcategorie: de hoofdcategorie waartoe de categorie behoort. Omschrijving: een interne omschrijving van de hoofdcategorie. Taal: In de dropdownlijst kan een andere taal worden geselecteerd, om zo de naam in een andere taal in te geven. Versie :1.0 : werk Datum 2012-01-31 15/19
4.4 Configuratie modules Website administrators of webmaster kunnen op het gewenste menuitems de front modules plaatsen in het contentgedeelte van de website. Er zijn 3 modules beschikbaar: Trefwoordenlijst Geavanceerd Trefwoordenlijst Categorieën Trefwoordenlijst - Toplijst Figuur 19:Verschillende Modules Versie :1.0 : werk Datum 2012-01-31 16/19
4.4.1 Trefwoordenlijst Geavanceerd De module is te vinden onder de naam Trefwoordenlijst - Geavanceerd. Dit is de hoofdmodule, waarin zowel de A-Z filter als de zoek op trefwoord zit. Eens op het menuitem geplaatst moeten er enkele parameters ingegeven worden. Deze kunnen aangeroepen worden door eerst de module aan te klikken en daarna op het eigenschappen icoontje te klikken (handje). Dit opent een pop-up met de instellingen. Het is mogelijk om een selectie te maken van een of meerdere lijsten die de module moet tonen. Tabblad: Algemeen Figuur 20: Instellingen module Titel: De algemene titel voor de module. Omschrijving: Omschrijving van de module. Zoekreferentie: is een koppeling naar het menuitem algemene zoek. Dit is nodig om de module te laten werken met het type zoek. Lijsten: Hier kunnen een of meerdere lijsten worden aangevinkt die moeten getoond worden in deze module. Indien geen enkele lijst wordt aangevinkt, worden ALLE lijsten getoond. Versie :1.0 : werk Datum 2012-01-31 17/19
4.4.1 Trefwoordenlijst Categorieën Deze module zal de hoofdcategorie en categorieën van de geselecteerde lijst tonen. De categorieën zijn aanklikbaar, waardoor er kan gefilterd worden in de trefwoordenlijst. Afhankelijk van de gebruikte layout en configuratie kan deze in de linker of rechterkolom worden geplaatst. De module heeft geen instellingen en kan ENKEL gebruikt worden op de pagina waar de trefwoordenlijst op staat. Figuur 21: Module Trefwoordenlijst Categorieën OPGELET: Om performantieredenen wordt deze lijst gecached per 5 minuten. Dit wil zeggen dat net aangemaakte categorieën niet onmiddellijk zichtbaar zijn, tenzij je via de preview van het menuitem het tweede wereldbolletje gekozen wordt. Hiermee wordt de cache verwijderd, en worden alle nieuwe gegevens opgehaald. Hetzelfde resultaat kan bekomen worden om achteraan de url &ClearCache=page toe te voegen indien er geen URL rewriting is toegepast. Versie :1.0 : werk Datum 2012-01-31 18/19
4.4.2 Trefwoordenlijst Toplijst Bij ieder trefwoord wordt een teller bijgehouden met hoeveel keer het trefwoord is aangeklikt. Hierdoor is het mogelijk een toplijst te genereren. De toplijst bevat dus de populairste trefwoorden. Deze module kan op iedere pagina gezet worden. Het aantal items kan niet worden ingesteld, en staat standaard op 10. Indien meer of minder items gewenst, kan dit wel aangepast worden door onze administrators. Figuur 22: Module Trefwoordenlijst Toplijst OPGELET: Om performantieredenen wordt deze lijst gecached per 5 minuten. Dit wil zeggen dat een verandering in de toplijst niet onmiddellijk zichtbaar is, tenzij je via de preview van het menuitem het tweede wereldbolletje gekozen wordt. Hiermee wordt de cache verwijderd, en worden alle nieuwe gegevens opgehaald. Hetzelfde resultaat kan bekomen worden om achteraan de url &ClearCache=page toe te voegen indien er geen URL rewriting is toegepast. Versie :1.0 : werk Datum 2012-01-31 19/19