SKOS – ShuttleThe section shows all those SKOS Shuttle projects, which are associated with the...

SKOS Shuttle SKOS Shuttle’s SearchBox Tutorial

SemwebLLCCopyright2016–2019Allrightsreserved 1

SKOS–Shuttle

(Welcome)

Tutorial„SearchBox“

Mai2018RevisedJune2018

Inthistutorialyouwilllearnhowto

useSKOSShuttle’sSearchBoxasasupportforthesaurusbased

searchresultoptimizationsandexternalnavigation,

Usingseveralthesauriinparallel.

TableofContentsEMBEDDINGSEARCHOPTIMIZATIONINYOURWEBSITE....................................................................................2NAVIGATIONSPEEDUPS.....................................................................................................................................9EXTERNALNAVIGATION....................................................................................................................................10

TROUBLESHOOTING..............................................................................................................................................11TARIFFING.........................................................................................................................................................15



EMBEDDINGSEARCHOPTIMIZATIONINYOURWEBSITEWhatisSKOSShuttle’sSearchBox?A(secure1)applicationwhichallowsyoutonavigateoneormoreofyourSKOSThesauri–Picture1–andtoperformexternalnavigationactions.ThelinktotheSearchBoxis:https://ch.semweb.ch:10000/S2M/T?channel=myexample2Form-authenticatedhttps://ch.semweb.ch:10000/SKSBox/T?channel=myexampleBasic-authenticated

Picture1–SearchBoxshowingtheconcept“GISdigitalsystem”insidetheGEMETthesaurus

SearchBoxknowsbasicallytworoles(userrights):

- adminorroot–toconfigureexternalnavigationparameters- skosnavigator–tonavigateamongtheconceptsofathesaurus

AccordingwiththeuserrolesSearchBoxshowsyouaspecialadministrationsectionwhichallowyoutodefinewhatshouldhappenwhenyounavigateyourthesaurus.Wewillcomebacklateronthis.TheSearchBoxhasaparticularlyresponsivedesign,youcanviewitfromwheneverclientyoulike.Itmightbeembeddedinanotherapplicationorbethetopapplication.

1SSL+BasicauthenticationallowtocallaSearchBoxanywhere.Securingalsothisapplicationguaranteesfreedomfrominternetrobots.Semwebprovidedademo/demoaccessforyoutodemonstratenavigation.2ThisURLrequiresport10000open.Ifyourinsitutionblocksport10000,omitsimply„:10000“fromit.



Picture2showsthemainsectionsofSearchBox.

Picture2–SearchBoxsections

1. HeaderorTitlesection2. ProjectorThesaurisection3. Administrationsection4. Searchsection

1

2

3

4

5

6

7 8 9



5. Languagesection6. Glossarylettersection7. Glossarysection8. Imagessection9. SKOS++relationshipssection

Nearlyeveryofthesesectioncanbeminimizedbyclickingonthe symbolontheupperrightsideoftherelativesection.Forinstance,pictures3and4showSearchBoxwithdifferentlyminimizedsections.Oncethecorrespondingsectionisminimized,thatsymbolruns(turnedwiththearrowagainstthebottom)tothelefttopsideofSearchBoxinitssequencefrompositions1to8correspondingeachtoitsdivisionandstaysthereuntilsomeonedecidestore-openthatsection.

Picture3–SearchBoxwith3minimizedsections–pls.noteontoptheiconsforminimizedsections



Picture4–SearchBoxwith5minimizedsections–pls.noteonwindowtoptheiconsforminimizedsections

Minimizedsectionsareusefulforthosecaseswhereyouneedtosearchinafixedthesaurusinafixedlanguage,andsoon.Minimizedsectionscanbere-openedatanytimebyclickingonthecorrespondingicononthelefttopsideofSearchBox.Pls.note:

1. Aminimizedsectionisnotserved.Thismeansthatyouwillhavetoreloaditscontentonceyouhavere-openedit.ThisisanefficiencymeasureinordertogetSearchBoxmoreresponsiveincaseyoudonotneedthatsection.

2. AsectioncanbeminimizedfromtheverybeginningbyprovidingaparameterwiththeSearchBox’sURL.E.G.https://ch.semweb.ch:10000/SKSBox/T?title=false&admin=falsewillsuppressthosesectionsfromtheverybeginningatURLcalltime.CallingSearchBoxwithsuchaparameterwillpreventSearchBoxfromshowinganopenersymbolasdiscussedabove.Thesectionwillnotappearanditwillbenotpossibletore-openitunlessyoure-callthesameURLwithoutthatparameter.



SearchBoxURIAPI–allyouneedtoknowSearchBoxcanbestartedwithabunchofparametersinordertoshowwhatyouneedataglance. Type Value Commenttitle

Boolean

falseàsuppresses“Title”section projects falseàsuppresses“Projects”section

admin falseàsuppresses“Administration”section

starts falseàsuppresses“Glossaryletter”section

langs falseàsuppresses“Language”section search falseàsuppresses“Search”section Oneofthesesectionmustbeopened.You

cannotcloseallthese4sectionatatime.Itisnotreasonable,sinceyouhavenosearchcapability.

glossary falseàsuppresses“Glossary”sectionimages falseàsuppresses“Images”sectionrelations falseàsuppresses“Relations”sectiontorthesauri

String

Commaseparatedlistofthesaurinames-Ifgivenforcestoloadthethesauriwiththatname3.Thesauriareshownonlyifloggedinwithanassociateduser.

Ifnoothersparametersarespecified,SearchBoxwillloadthethesaurus,allitslanguages,choosesarandomglossaryletteranddisplaytheglossaryforthatletterinthethesaurusdefaultlanguage.

uandp Strings,userandpasswordasin/S2M/TSearchBox.jsp?u=demo&p=demo

TheseparametersforcesaloginwhenusingTSearchBox.jspdirectly.

corstartchar Forcesthestartingglossaryletterforathesaurus.

lorlang Forcesthelanguageinwhichlabelsaredisplayedatstart.

uoruri ForcestoloadtheURI(ifpresent)fromathesaurusatstarts.IfthatURIisnotpresentinthethesaurus,aglossaryletterwillberandomlychosenandaglossaryviewberendered.

channel Anystring Neededtodefine(andautomaticallysave)externalnavigationinformationforthecurrentuser.ThisvaluewillbeneededtoretrieveexternalnavigationinformationforanyfutureuseofSearchBox(withexternalnavigation).

glossary_cache_sec Integer Secondscacheforanyretrieval Defaultstoonedayinseconds.Youcanchangethistoyourneed.

threshold_inthe Integer 15000oranypositivesmallinteger TellsSearchBoxtowarnwhenmorethan<n>labelsareabouttobeloadedfromaninternalthesaurus.

threshold_exthe Integer 3000oranypositivesmallinteger TellsSearchBoxtowarnwhenmorethan<n>labelsareabouttobeloadedfromanexternalthesaurus.IncaseyouareusinganexternallyhostedthesaurusinSKOSShuttleandtheconnectiontothatserverortheserveritselfaretooslow,justlowerthisvaluetobewarnedearlier.

3Theherereferencedthesaurus(name)mustexistinSKOSShuttleandbeingvisibleSearchBoxuser.



Thesectionsindetail:

1. TitleThissectionshowsanorangetitlebarwithcompanynameandalinktothistutorial.

2. ProjectsThesectionshowsallthoseSKOSShuttleprojects,whichareassociatedwiththeSearchBoxuser.Checkoneormoreofthesethesauriandpressthebutton“Navigatenthesauri”tostartnavigation.Notes:

a. BoldthesaurusnamesareSemweblocallyhosted(fasteraccess)whileitalicthesaurusnamesindicatethatthatthosethesauriareexternallyhosted(itwilltakemoretimeforSearchBoxtoretrievedata).

b. Ifyouarenavigatingmorethanonethesaurus,oncetheglossaryviewcorrespondingtoagivenorcalculatedstartletterisrendered,thesauriconceptswillbedistinguishedbydefaultviaasmalldotonthelabelleftside.Pls.seeintheSearchsectionbelowwhichpossibilitiesyouhavetofilteroutspecificconceptlabels.

3. AdministrationThissectionisonlydisplayedifyoucallSearchBoxwithauserhavingtheadminorrootright.Thesectionallowsyoutoconstructanexpressiontofirewhenyouclickonathesauruslink.Thisbehaviorisdescribedinthistutorialas“externalnavigation”.Pleaseseesectionon“ExternalNavigation”inordertocapturethedetailsandpowerofit.

1. SearchThiscontainsbasicallyasearchfield“alaGoogle”whereSearchBoxretrievesandshowyoutheFIRST50suggestionscomingfromtheloadedthesaurus(or50/nsuggestions,incaseyouselectednthesauri).Assoonasyoutypesometext,after2secondsSearchBoxwillretrieveanddisplayaselectionareawithupto50suggestedterms.Hoveronatermtoseetowhichthesaurusitcomesfrom.ClickonatermtoloaditandtoseeitsrelationsintheSearchBox.Thisisanautocompletetoallowyoutoidentifythesaurustermsquickly.Itisnotexaustive,soyoumightneedtotypeinmoretexttofindyourconcept.Nofreetextinputhere(yet).Note:SearchBoxallowsyoutosearch/navigateinparallelonseveralthesauri.4Ontherightsideofthesearchfieldaftereachloadoperationyoufindsomeelementstofilterthedeliveredconcepts:

a. fornnavigatedthesaurincirclesinthesamecolortotoggleviewoneachthesaurusb. afurthersearchfieldforthedeliveredconcepts:justtypeinsometextthereandafter1.5

sectheglossaryviewwillbefilteredusingyourtext.

4Limitedtocurrentlymaxthreethesauriatthetime.Thislimitationcanbemodifiedonrequest.



4. LanguagesThesectionshowthelanguagesdetectedbylabelsinthethesaurus.ThedetectionoccursatRDFlevelandonceitiscalculateditiscachedforyouforawhiletospeedupthings.Ifnostartlanguageisspecified,SearchBoxwillselectthedefaultlanguageoftheloadedthesaurus.Note:LanguagesarecalculatingbyreadingthelanguagetagsfromtheRDFdataoftheloadedthesauri.Incaseyouhavemorethanonethesaurusloaded,SearchBoxwillcalculateandshowonlytheintersectionofthelanguagesamongallloadedthesauri.

5. GlossarylettersThesectioncomputesthelanguagetagsfromtheRDFlabelsinthethesaurusrepositoryandcachesthemhereforfuturefastuse.Incaseofmorethanoneloadedthesaurus,theunionofallglossaryletterswillbedisplayed.

6. GlossaryTheglossarysectionshowspreferredlabelsstartingwithanapriorifixedstartingletter(e.g.“a”)togetherwithalternativeandhiddenlabelsreferringtotheirresp.preferredlabelinsideoneconcept.Ifaconceptwasspecified,itshowsthespecifiedconceptwithbigfont.Navigationisdonebyclickingonaconcept.OneclickontheconceptcausesSearchBoxto1)calculatethenextglossaryletterfromitslabeland2)load/renderthatconcept,togetherwithcommonglossary,imagesandrelations.Ifanexternalnavigationwasspecified(pls.seesection“ExternalNavigation”below)thehoveringobjectwillbestructuredintwopartsshowingaleftandarightpartwheretoclickon.Incaseyounavigateinmorethanonethesauruscontemporarily,theconceptswillbeshownwithadifferentiatingcolorontheleftoftheirlabel.Thecoloriscalculatedautomaticallyusingthenameoftherelativethesaurus.Toggleviewonalltheconceptsofonethesaurusintheglossarybyusingthecirclesinthesection“Search”(seeabove).

7. ImagesIncasefortheloadedconcepttherearepictures(ordocuments)theseareshownhereasthumbnails.Openthepictureorthedocumentbyclickingonthepictureordocumentthumbnail.Whenyouhoveronathumbnail,seewhetherthatpictureordocumentissharedwith(an)otherconceptsandclickontheshownlinktonavigatetothatconcept(s).

8. RelationsTherelationsectionstheSKOS++relationshipsboundtoaloadedconcept.Fromhereyoucannavigatetheloadedthesaurus(thesauriinthenextversion)inthesamewayasintheGlossarysection.Notes:

a. Customrelationareshownandyoucannavigatetothelinkedconcepts.b. Customattributesarenotshown.



InordertoviewathesaurusintheSearchBoxyouneedtoassociatethatthesauruswithauserinSKOSShuttle.UsingthecredentialsforthatusertheSearchBoxwilldisplaythesaurusdata.SearchBoxrendersaglossaryandaSKOSviewtogetherforeachthesaurus.Theapplicationissubdividedintileswhichcanbeseparatelyhidden.Inordertospeedupglossarybuildingateachnavigation,SKOSShuttlecachescontentsforoneday.Thisresultsinamorefluidnavigationinevenlargedataamounts.The(server)cacheisbuiltupontheuserandthesaurusname,thusthisallowsreuseofdataamongseveralclients.AnexampleofaSearchBoxcalledwithauseddemo/demoandfivethesauriisshowninfigure1.NAVIGATIONSPEEDUPSAseveryThesaurusserver,evenSearchBoxmustselectdatafromanRDFrepositoryandprovidethatdata.OneofthestrengthsofSKOSShuttleisitscapabilitytoworkwithexternallyhostedRDFrepositoriescontainingthesauri.Iftheconnectiontotheserversofthoseexternalrepositoriesortheserverthemselvesareslow,SearchBoxwillhavetowaituntilallthedataisdeliveredandrenderittoitsuser.Inordertodeliverthebestpossibleexperiencewhilepreservingtimeandofferingthemostcompleteamountofdatatoitsuser,SearchBoxusestwothresholdsbesideswhichitaskstheusertoproceed.Forinstance,supposeyouareusinganexternalhostedthesaurusandneedtheretoextractsallthe5’000Englishlabelsstartingwith“a”,SearchBoxwillaskyoutocontinueortostopthere.OrsupposeyouarebrowsingabigSemwebinternallyhostedthesaurusandwantstonavigatetoagivenconcept,whoselabelstartswith“s”.BeforeSearchBoxlaunchestheretrievalrequestitasksyouwhetheritisoktoproceedtoretrieveallthe21’000Englishlabels.Asyouhavenoted,therearetwodefaultthresholdsforthesecases Internalthesaurus:Askbeforeretrieving15’000labels Externalthesaurus:Askbeforeretrieving3’000labelsHowever,thegoodpieceofnewsisthatonceyouagreedretrievingallthoselabels,theyarecachedfor24hoursthusspeedingupanyothercalltotheminsidethecacheperiod.Youcanalterthesevaluesbyusing/changingthefollowingparametersglossary_cache_sec=604800(3600*24*7,oneweek)threshold_exthe=1000(askalreadyatmorethan1000labelsfromanexternalthesaurus)threshold_inthe=30000(askbeforeretrieving30000labelsfromaninternalthesaurus)



EXTERNALNAVIGATIONTheonlyspecialconceptoftheSearchBoxistheexternalnavigation.WhenyouinSearchBoxnavigateandfindaconceptandsomeadministrationparameters(seebelow)areappropriatelyconfigured,navigatinginthethesauruscanbeassociatedwithanexternalaction(viaURL).Picture5showsyoutheAdministrationsection,whichisonlydisplayedwhenopeningSearchBoxwithanadminuser.

Picture5–Administrationsectionopeningforachannel“example”

Ifthisisthefirsttimeyouconfigureheresomeparameters,thesectionappearstoyouasdepictedinpicture5.Hereyouhavethreeareasyoushouldconsiderinsequence.TheseareasdefinewhatportionofdataistobetakeninordertodefineanactiontobeautomaticallyfiredbySearchBoxwheneveryouclickonaconcept.Clickingonaconceptwillfirethataction.UsuallyanactioniscallinganotherURLwithsomeappropriatecontente.g.inordertopositioninsideacatalogueorinsideanencyclopedia.Inordertodefineanexternalnavigationactionpleaseconsiderandfillinthethreeareasinthesequence.1.DefinewhetherthelabelortheURIoftheclickedcontextshouldbetakenasabasisfortheaction.Incaseyouplantoopen/controlanexternalcatalogue,choosethelabel,ifyouneedtoaccessanexternalcataloguesystemwithaprecisesystematic,considertakingtheURIpartofaconcept.TheURIpartofaconceptcanbeshort(e.g.GETTY_AAT:20394045)orfull(http://vocab.getty.edu/aat/20394045).Inordertohavetheexamplefortheconstructionoftheexpressioninsection2.Pleasenavigateinthethesaurustoaconcept,thenpressthebutton“LoadselectedlabelorURI”totransferthevalueintotheinputfieldinthissection.Thisvaluewillbeusedinarea3.2.ComposehereeitheraregularexpressionoraJavascript/JQueryexpressiontobefired.Pleasetakefromthetooltiphoveringthehelpsections(smallbuttonswithaquestionmark,eachoneontheleftofthefirstinputfield)somehelponhowtodefinetheseexpressions.Thissectionrequiresprogrammingskills.



3.Onceyouhavefilledappropriatelyareas1.and2.Presshereinsequencefirstonthebutton“Loadexample”andseeintheorangetextareacontainedinthisarea3.(ontherightofthebutton)whatistheexpressionloaded.Inordertofirethatexpression(whichisusingtheexamplevaluetakeninarea1)simplypressthebutton“Executeexample”andseewhathappens.Normally,afurtherbrowsertaborbrowserfenstershouldpopupwiththecontentcomingviatheURLgivenbyyourexpression.TROUBLESHOOTINGIfnothinghappensonfiringthatexpression,checkpleaseoneofthefollowingcases:i)Openthebrowserconsoleandsearchfor(Javascript)errors,repairthoseerrorsandredoyouractionii)Examineyourbrowserforoccurringwarningsconcerningblockedpopups,allowthemforSearchBoxandredoyouractioniii)Searchinyourbrowserforanalreadyopenedtaborwindowyoucannot(didnot)see.Sinceyoucandefineawindowname,thatnameforceseveryactiontocallanURLonlyinthatwindow.Ifthatwindowforsomereasonsisnotvisible,nothingseemstohappen.Exampleofexpressionstogiveinareas1and2oftheadministrationWewantheretosupposethatasexternalnavigationyouwishtoopena“bing”pageonthelabeloftheclicked/navigatedterm.Picture6showstheexamplewewilldiscussherefield-by-field.

Picture6–Administrationexample1withregularexpressionandURLcall

StepstolearnhowtodefineanexternalnavigationactionusingRegexpandwindowspopups:



i. SelectGEMETthesaurusand“en”aslanguagefromyourprojectsection5.ii. Navigatetoaconcept–heretotheconcept“GISdigitalsystem”.

iii. Clickon“Label”insidearea1tosignalyouwanttoworkwithlabels.

iv. Pressbutton“LoadselectedconceptlabelorURI”inadministrationsection(area1)

v. Inthefirstfieldinarea2typetheregularexpressiontoextractportionsof(orsimplyall)thelabel:

Typehere:“(.*)”(withoutquotesasshowninpicture6).Thismeansthatyourregularexpressionextractallthelabel.

vi. Inthesecondfieldinarea2typetheURLtobeusedtofireonconceptclic.Typehere:https://bing.com?q=$1Thismeans,thatonfiring,theURLusedwillbehttps://bing.comwithonequeryparameterq=andonevalue$1takenasthefirstregularexpressionextractedgroup6.

vii. Inthethirdinputfieldinarea2typethenameoftheonebrowserwindowheretheURIinthelaststepshouldbeused.Thiscanalsobethenameofaniframeinsidethesamebrowser.Typehere“mybingexample”.Hint:Hereyoucanalsotype“_blank”tosaythatyoudonotbother7.

viii. Inthefourthandlastinputfieldinarea2type(ifyouneed)someparametersneededtopopupawindow,likee.g.“width=500,height=200”takenfromhttps://www.w3schools.com/jsref/met_win_open.asp-“specs”

ix. Inarea3,trytoseewhatitlookslikeputtingitalltogetherpressing“Loadexample”.Inthetextareayoushouldseethecodefiredoneachcallbutbasedontheloadedexample.

x. Inarea3press“Executeexample”toseetheeffectoffiringthatloadedexpression.ApopuporanewtabshouldbeopenedwithBing’ssearchontheconcept.

AsimilarconfigurationcanbedoneusingtheURIoftheconcept(seestepiii).Note:ThecontentextractedbySearchBoxiswrittentothegroupvariables$1,$2,…withaURLencodingforblanks.Soe.g.thelabel“GISdigitalsystem”willbecome“GIS%20digital%20system”,since“%20”istheURLcodingforblanks.Seehttps://www.w3schools.com/tags/ref_urlencode.aspformoredetails.

5IfyoudonothaveGEMET,selectonethesaurusappearingintheprojectssectionandchooseanyotherconcept/language.6Thisisthepositionoftheparenthesis„(...)“intheregularexpression.Pleaserefertoatutorialonregularexpressiontostudyabouttheassociationbetweenextractionvariables$nandparenthesesgroups.7Thenateachfiringanewwindowwillbeopened.



StepstolearnhowtodefineanexternalnavigationactionusingJavascript/jQuerypopups:ThepreviousstepsshowedhowtodefineasimpleexternalnavigationactionusingjustaregularexpressiontoextractaportionofalllabelandanURLtobeopenedinsideawindow.open()browsercommand.ThiswilljustpopupawindoworfillaniframewiththecontentcalledbythegivenURL.InSearchBoxyoucanalsochooseinarea2avariantofthis,inwhichaJavaScriptincludedajQueryexpressionarefiredonthebasisoftheclickedterm(labelorURI).Allyouhavetodoisdefiningthatexpression,whichnowhereforthesakeofsimplicity,canbeagainthesameexpressionimplicitlyusedbySearchBoxintheformercase:Select“jQuery/Javascript”andtype“window.open(’https://bing.com?q=$source’,’mybingexample’,’width=500,height=200’)”togiveSearchBoxtheactiontobefiredwhenclickingonaconcept.Note:Thesubexpression$sourcedenotesthevaluetobetakenfromtheconceptaccordingtoyourdecisiontakeninarea1(labelorURI).Again,thefinalvaluegeneratedbySearchBoxwillbesotreatedasperURLcoding(e.g.blankswillbecome“%20”,…).



USINGEXTERNALNAVIGATIONOnceyoucheckedintheadministrationarea(inarea2)either(*)“RegularExpression”or“jQuery/Javascript”SearchBoxwhenyouhoveroneachlinkwillunderstandthatyoumightwanttofiretheactionbyclickingthatlink(ornot).Incaseoneof(*)ischecked,theconceptlinkwillbemousehovered8differently–seepictures6a,6b.

Picture6a–Doublehoverwithfocus/tooltipontherightpart

Picture6b–Doublehoverwithfocus/tooltipontheleftpart

Picture6c–Singlehover(internalnavigationonly)

Doublehoveringallowsyoutochoosewhethertofirethedefinedaction(clickingonitsgrayrightpart)orjustcontinuenavigatinginternallyinthethesaurus(clickingonitsleftorangepart).Incasenoneof(*)ischecked,SearchBoxwilldisplayanormalhoverarealikedepictedinpicture6c.

8Navigatetoaconcept,hoveritbybringingyourmouseonthatconcept.



TARIFFINGSearchBoxisconnectedwithSKOSShuttletariffingsystem,whichkeepstracksofyourtariffconsumption.ShouldyourSKOSShuttleaccountrunoutoftariff,thiswillaffecttheSearchBoximmediately,nothesauriwillbedisplayed,nointeractionswillbepossible.Inthiscasepleasecf.thetutorialontariffingunderhttps://skosshuttle.ch/tutorials/skosshuttle-tariffing.pdf.Youaredone–inthistutorialyoulearnedhowtomanageSKOSShuttle’sSearchBoxforoptimizingsearch,resp.firingexternalnavigationactionsuponyourthesaurusnavigationusingseveralthesauriinparallel.Questions?Improvements?Justcontactus–https://ch.semweb.ch/en-contactoronhttps://skosshuttle.ch

Date post:	14-Mar-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times

SKOS – ShuttleThe section shows all those SKOS Shuttle projects, which are associated with the...

Documents