Historisk Tidsskrift teknisk dokumentation

Historisk Tidsskrift teknisk dokumentation Side 11. Indledning....................................................................................................................................21.1 Referencer ....................................................................................................................................21.2 Versionshistorie ...........................................................................................................................21.3 Definitioner..................................................................................................................................21.4 Dokumentationens opbygning ....................................................................................................22. Generel beskrivelse.....................................................................................................................32.1 Oversigt ........................................................................................................................................32.2 Funktionseksempler.....................................................................................................................43. Grænseflader ...............................................................................................................................53.1 Webserver ....................................................................................................................................53.2 Database server............................................................................................................................54. Fælles datastukturer ....................................................................................................................64.1 Databaser......................................................................................................................................64.2 Filer...............................................................................................................................................65. Moduler........................................................................................................................................65.1 Fritekst søgefunktion ...................................................................................................................65.2 Opdatering af søgefunktionen.....................................................................................................76. Drift..............................................................................................................................................76.1 Serverdrift ....................................................................................................................................76.2 Vedligehold..................................................................................................................................77. Fonte, farver og grafiske elementer ...........................................................................................88. HTML........................................................................................................................................12Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 21. IndledningDenne dokumentation beskriver design og implementation af Historisk Tidskrift hjemmesiden,som er udarbejdet under projekt Digital formidling under Det Elektroniske Forskningsbibliotek.Dokumentationen er udarbejdet til projektets styregruppe att. Per Henning Hansen, HistoriskInstitut, Syddansk Universitet – Odense Universitet af Kristian Gren kgren@it.hum.sdu.dk ogKjeld Jensen kjeld@bifrostnet.dk1.1 ReferencerHistorisk Tidsskrift er udarbejdet efter specifikation af direktør Stefan B. Andersen OdenseUniversitets Forlag, sba@forlag.sdu.dkWebdesign er foretaget af fuldmægtig Allan Bengtsson bengtsson@hist.sdu.dk ogstudentermedhjælp Kristian Gren kgren@it.hum.sdu.dkHistorisk Tidsskrift er placeret på en webserver administreret af IT-Funktionen, det HumanistiskeFakultet, Syddansk Universitet - Odense Universitet. Kontaktperson hos IT-Funktionen erafdelingsleder Jørn Erik Wennerstrøm email wenn@ithum.sdu.dk1.2 VersionshistorieDokumentationen er udarbejdet for Historisk Tidsskrift som det så ud under overdragelsen tilprojektet den 26. august 1999.1.3 DefinitionerI dokumentationen er følgende navne og definitioner anvendt:“WebSTAR” er et MacOS Internet webserver produkt fra StarNINEhttp://www.starnine.com“FileMaker Pro” er en relationsdatabase fra FileMaker Inc.http://www.filemaker.com1.4 Dokumentationens opbygningFørst beskrives Historisk Tidsskrift hjemmesiden generelt. Så dokumenteres Historisk Tidsskriftgrænseflader samt data strukturer, hvorefter relevante moduler er beskrevet nærmere. Til slut erbeskrevet specielle forhold vedrørende driften af hjemmesiden.Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 32. Generel beskrivelse2.1 OversigtSidernes overordnede strukturHistorisk Tidsskrifts hjemmeside er opbygget vha. frames hvilket illustreres i nedenstående.Gennem brugen af frames er det tilsigtet at forenkle vedligeholdes og opdatering af HistoriskTidsskrift.De frames der er markeret med en cirkel går igen i alle de 8 overordnede sider, mens de øvrige 3skifter i henhold tilden pågældne side – eks. hedder ”main-siden” for seneste årgang – mainseneste.htm, mensmenusiden for denne hedder menuseneste.htm og bunden med fanebladet heddermainbottomseneste.htm og så fremdeles.Størrelser på frames:top.htm: 155x50 pixels, topright.htm: 1 relative x 50, menu_top.htm: 150x50 pixels,topmain: 1 realtive x 50 pixels, menuleft.htm: 5 pixels x 91%, menuleft.htm: 150 pixelsx91%,mainforside.htm: 1 relative x 87%, mainbottomforside.htm: 1 relative x 25 pixels,bottom.htm: 100% x 15 pixelsUdarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 4Om strukturen på serverenNedenstående er illustreret grupperingen af mapperne på serveren:Disse mapper stemmer overens med de mapper Chr.Thorup tidligereanvendte på Historisk Tidsskrifts gamle server.Søgefunktionen på hjemmesiden Historisk Tidsskrift er baseret på en FileMaker Pro WebCompanion løsning. Valget af denne type løsning giver forskellige tekniske begrænsninger pga.databasens faste struktur men letter udviklingen af søgefunktionen.Websiderne til søgefunktionen er skrevet i en kombination af statisk HTML kode og FileMakerPro’s CMDL integration. Arbejdet med CMDL integrationen er sket med design værktøjet ClarisHomepage, som understøtter CMDL. Information om CMDL integrationen findes i FileMakerPro dokumentationen.2.2 FunktionseksemplerDe to hovedanvendelser af Historisk Tidsskrift er systematisk søgning gennem oversigterne samttekstbaseret søgning via fritekst søgefunktionen.Ved systematisk søgning kan brugeren ud fra hovedsiden klikke sig frem til den ønskedeinformation.Via fritekst søgning på felterne i databasen er det muligt at få listet samtlige referencer, sommatcher de aktuelle søgekriterier.Herudover ligger der på Historisk Tidsskrift hjemmesiden en del statiske HTML siderindeholdende relevant information.Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 53. Grænseflader3.1 WebserverIT-Funktionens webserver er en Macintosh G3 server tilsluttet en 10 Mbit forbindelse på OU-Net, der gennem Forskernettet er forbundet til Internet. På serveren er installeret styresystemetMacOS 8.51.Den primære webserver (port 80) er baseret på WebSTAR 3.01. Denne håndterer URL’en:http://www.hum.sdu.dk/projekter/histtidNår Historisk Tidsskrifts web adresse kaldes, hentes altså html filen:http://www.hum.sdu.dk/projekter/histtid/index.htmlsom er hjemmesidens hovedside indeholdende en frame struktur.3.2 Database serverFritekst søgefunktionens websider genereres af den sekundære webserver (port 8000) som erbaseret på FileMaker Pro 4.02’s indbyggede Web Companion.Siderne sammensættes af både statisk HTML kode og dynamiske database referencer samtforskellige andre dynamiske HTML tags, som Web Companion modulet konverer til en enkeltstatisk HTML side, der sendes til brugerens browser.Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 64. Fælles datastukturer4.1 DatabaserSøgefunktionen på Historisk Tidsskrift hjemmesiden er baseret på en enkelt FileMaker Prodatabase med navnet “Histtid”.Strukturen for databasen ser således ud:Navn Type BeskrivelseInfo1 Tekst FortatterInfo2 Tekst Titel/afdødeInfo3 Tekst Bibl. dataSummary Tekst Link til det tilhørende summaryArtikel Tekst Link til den tilhørende artikelSummary link Beregning Viser teksten “Vis summary” hvis Summary ikke er tomtArtikel link Beregning Viser teksten “Vis artikel” hvis Artikel ikke er tomtType Tekst Artikler og oversigter/Litteraturfortegnelser/Nekrologer4.2 FilerHTML filerne under Historisk Tidsskrift hjemmesiden er opdelt i en struktur som vist nedenfor:Navn/bibliotekInfoBeskrivelseHTML filerne tilhørende fritekst søgning er placeret under Filemaker Pro webserveren.Ændringer i samtlige filer under Filemaker Pro webserveren bør kun foretages med en simpeltekst editor, som ikke automatisk indsætter eller retter html tags.5. Moduler5.1 Fritekst søgefunktionFritekst søgning på Artikler og oversigter/Litteraturfortegnelser og nekrologer er baseret påfelterne Info1, Info2 og Info3.Under søgning er det muligt at benytte FileMaker Pro’s søgekriterier. En oversigt over dissefremgår af FileMaker Pro’s hjælp. Bemærk, at det er muligt at benytte de logiske operatorer “og”/ “eller” under søgningen.FileMaker Pro er ikke i stand til at håndtere søgning på ord indeholdende de danske bogstaverkorrekt. Denne fejl er rapporteret til FileMaker Inc.Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 75.2 Opdatering af søgefunktionenDer er ikke implementeret brugerflade til opdatering af søgefunktionen med nye data. Dataimporteres via Filemaker Pro’s import funktion fra tre kommaseparerede filer (Artikler ogoversigter/Litteraturfortegnelser/Nekrologer), som opdateres af Historisk Tidsskrift redaktionen.6. Drift6.1 ServerdriftDrift af webserveren påhviler IT-Funktionen, såfremt der opstår fejl på serveren, vil IT-Funktionen iværksætte foranstaltninger til at afhjælpe disse, men IT-Funktionen kan ikke givegarantier for serverens drift.Af såvel webserver som database server foretager IT-Funktionen regelmæssigsikkerhedskopiering, men projektet bærer selv ansvaret for evt. tab af data i tilfælde af servernedbrud eller lignende.I tilfælde af opgradering af server software vil projektet blive informeret herom, såfremt detmedfører ændringer vedrørende driften eller administrationen af Historisk Tidsskrifthjemmesiden.6.2 VedligeholdHistorisk Tidsskrift databasen kræver ingen særlige periodiske vedligehold.Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 87. Fonte, farver og grafiske elementerFonteBrødtekst: Times New Roman str. 2 (webstr.) = 12 punktOverskrift type 1 (artikel overskrift): Times New Roman str. 3 (webstr.) = 14 punktOverskrift type 2 (afsnitsoverskrift): Times New Roman str. 2 fed (webstr.) = 12 punkt fed.Alle ovennævnte er sorte (RGB 0,0,0)HyperLinks er som standart formatteret som nedenstående:FarverGul: RGB 255,255,230Rød: RGB 152,3,5Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 9GrafikDe grafiske elementer der er inkluderet i websitet er alle oprettet i Corel Photopaint 8.0 ogvejledningen hertil knytter sig derfor til nævnte software. Der er dog umiddelbart intet til hinderfor at Photoshop mv. sagtens kan anvendes til oprettelse af nye/andre grafiske elementer efterdenne vejledning:Oversigt over grafik med tilhørende beskrivelse:Element fra top menuen 1Element fra den venstre menu 2Afsnits opdeler 3Top logo 4Faneblad fra bundmenuen 5Bullepoint til fodnoter 6Menu baggrund 7Knap til mouseover i top menuen 8Baggrund til venstremenu (formindsket) 9Baggrund fra top menu (formindsket) 10Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 10Beskrivelse af de elementer der kan være relevante at ændre (øvrige betegnes statisk):Ad. 1: Top menu punkterFontTW Cen Mt Condensed - FedFarve RGB: 0,0,0Størrelse: 16 punktTeksten er centreret vertikalt og placeret 4 pixels horisontalt. (jf. Corel Photopaint)knapbunden:Højde: 22 pixelsBredde: Variabel med tekstens størrelse)Bundfarven RGB: 255,255,230Ad. 2: Elementer fra venstre menuenFontTW Cen Mt Condensed – FedFarve RGB: 0,0,0Størrelse: 18 punktDenne grafik er oprettet som en 8 bit s/h gif Med transparent baggrund.Teksten er centreret vertikalt og placeret 0,706 horisontaltKnapbunden:Højde: 17 pixelsBredde: Variabel med tekstens størrelse, men med hensyn til menu framens bredde der er 150pixelsBundfarve RGB: 255,255,255 (Irrelevant idet grafikken er lavet som en transparent gif)Ad. 3: Afsnitsopdeler (statisk grafik)Denne grafik er lavet som en transparent gifRød streg (RGB: 152,3,5) på gul baggrund (RGB: 255,255,230)Ad.4: Logo (statisk grafik)Denne grafik er lavet som en transparent gifFont:Times New Roman – FedFarve RGB: 255,255,230Størrelse: 48 punktKnapbundenHøjde: 44 pixelsBredde 256 pixelsFarve RGB: 152,3,5Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 11Ad. 5: FanebladFontTW Cen Mt Condensed – FedFarve RGB: 255,255,230Størrelse: 20 punktPlacering vertikalt centreret og horisontalt 2,117Skygge på teksten som nedenstående:Knapbunden (statisk)Størrelse: bredde 150 pixels, højde 25 pixelsFarve: halvbue i RGB: 152,3,5 på baggrund i RGB:255,255,230Ad. 6: BullepointStatisk grafikAd. 7: Menu baggrund til venstre menuStatisk grafikBredde 150 pixels, højde 12 pixels – placeres som baggrundsfyld så grafikken gentages i heleframens længde.Farve RGB: 255,255,230 med 1 pixels streg i RGB: 0,0,0Ad. 8: Knap til mouseover i topmenuenFontTW Cen Mt Condensed – FedStørrelse: 16 punktFarve RGB: 152,3,5Placering vertikalt centreret og horisontalt 2,117Baggrund: statiskBredde: 300 pixels, højde: 20 pixelsFarve RGB: 255,255,230Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 12Ad. 8: Logo baggrund til venstre menu (Statisk)Ad. 9: Baggrundsfyld til topmenuen (statisk)8. HTMLSom udgangspunkt er anvendt MS. Frontpage 2000 ifm. Oprettelse af websiderne. Disse erderefter valideret i HomeSite 4.0. I det daglige kan dog sagtens anvendes anden editor f.eks.Claris Homepage.Den anvendte kode er på nær nedenstående standard HTMLI topmain.htm – den overordnede menu anvendes et javascript til at skabe den dynamiske menu.Scriptet ser ud som følgendeUdarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk

Historisk Tidsskrift teknisk dokumentation Side 13Ovenstående er eneste ”special” programmering der anvendes på sitet. Da strukturen er grundigtgennemtænkt forud for oprettelsen af denne site skulle det ikke umiddelbart være nødvendigt atændre på ovennævnte menu.Udarbejdet 20.08.1999 af Kjeld Jensen, Bifrost Data http://www.bifrostnet.dkI samarbejde med Kristian Gren http://www.gren.dk