Dokumentering af umbraco artikeleksport:

Transkript

1 Dokumentering af umbraco artikeleksport: Lav en artikel side 2-3. Installationsguide side 3-5. Opsættelse af databasen og web.config side 5-8. Umbraco: templates side 8. Umbraco: borger.dk tab side 8. Umbraco: html forklaring side 9. C# artikellink brugerkontrollen forklaret side Begrænsninger side 10. Af Asger Lisborg 1

2 Lav en artikel: For at lave en ny artikel skal man: 1. gå ind i umbraco content management og højreklikke på content og vælge create. 2. Skriver et navn for artikel siden og vælge body som templaten. 2

3 3. Indsætter urlen for borger.dk artiklen og checke de dele af artiklen man gerne vil havde vidst. 4. Klik på save and publish og følg linket for siden. Installationsguide: For at installere artikeleksports pakken skal man først havde: En umbraco CMS installeret hvori man ønsker at bruge artikel eksporten. En database til at gemme relevant data for artikeleksporten. For at installere pakken efter at havde hentet den ned skal man: 1. Åbne umbraco konfigurationsvinduet i sin browser. 2. Gå ind i developer sektionen og klik på install local package. 3. Klik ja til at man accepterer sikkerhedsrisikoen. 3

4 4. Klik på vælg fil og vælg pakken, det kan nævnes at pakken er en zip fil. Klik herefter load Package. 5. Klik ja til at man accepterer licensen og tryk på install package. 4

5 Dette installere alle templates, documenttypes, macros, config filer og c# scripts for artikel eksporten, det eneste der ikke bliver installeret er selve databasen. Opsættelse af databasen og web.config: Artikeleksporten er i øjeblikket lavet til at virke med en mysql database, ønsker man at bruge en anden database skal man gå ind i articlelink og showarticle c# brugerkontrollen og erstatte alle forekomster af mysql med sql. Efter at havde gjort dette vil artikeleksporten også kunne virke med andre databaser. For at sætte artikeleksporten til at virke med ens egen database skal man gå ind i web.config filen for ens umbraco cms, som kan findes i ens umbraco cms mappe efter at artikel eksports pakken er installeret. 5

6 Inde i webconfig filen er der fem keys hvis værdier skal defineres korrekt for at artikel eksporten kan virke under <appsettings>, disse keys er: 1. bdkdatabaseservername her skal indsættes navnet på den server din database skal kører på. 2. bdkdatabaseusername her skal indsættes brugernavnet for databasen. 3. bdkdatabasepassword her skal indsættes passwordet for databasen. 4. bdkdatabasename her skal indsættes navnet på databasen. 5. bdkkommunenr her kan der indsættes et andet kommune nummer, er default sat til at være ikast-brande kommune. 6. UmbracoCmsPath her skal der indsættes stien til din umbraco cms, f.eks. C:\Users\Asger\Documents\My Web Sites\Umbraco CMS2. 6

7 Som det fremstår så indeholder de første fire linjer den information som c# brugerkontrollerne skal bruge til at lave en forbindelse til databasen, sæt disse til de rette værdier svarende for din database. KommuneNr kan ændres hvis man ønsker at sit modul skal køre med en anden opsætning end ikastbrande kommune. Den sidste linje, UmbracoCmsPath skal havde værdien af den sti der er til ens umbraco CMS. Til sidst skal man i sin database lave en ny tabel kaldt artikelinfo. Dette gøres ved at kører sql kommandoen: CREATE TABLE articleinfo (Title varchar(255), url varchar(255), dayofyear int, Year int, id int, ArticleText text); 7

8 Det er vigtigt at man ikke ændre på nogen af disse variablers navne da ellers vil c# brugerkontrollerne ikke kunne finde de rette værdier i tabellen. Når dette skridt er fuldført skulle artikeleksporten fungere. Umbraco: Templates. Der eksisterer i alt tre templates for artikel eksporten. Master, body og artikellist siden. Master siden indeholder de macros der specificere hvilke c# brugerkontroller der skal køres når siden loades. Udover dette så består mastersiden af selve det visuelle design for siden samt den frame hvori indholdet af de to andre templates vises i. Body indeholder den artikel der sidst er blevet hentet fra databasen. Når en anden artikel vises omskrives body via. artikellink. På denne måde kan man lave adskillige content sider der bruger templaten body selvom hver content side indeholder en anden artikels url. Articlelist indeholder en liste der viser titlen på alle artikler som er blevet importeret via. artikeleksporten. Umbraco: borger.dk tab. Borger.dk tabben er den tab der bruges for de forskellige body content sider til at definere den artikel der skal vises på siden. Der er her to forskellige properties for denne tab, den første er et tekstfelt kaldt url hvori man specificerer urlen for den artikel der skal vises. Den anden property er et antal checkboxes med navne såsom Titel, header, mikroartikel, lovgivning, læs også, huskeliste og selvbetjening. Disse navne indikere forskellige dele af en artikel fra borger.dk og kan checkes eller uncheckes ud fra hvilke sektioner man ønsker at vise af artiklen. 8

9 Umbraco: html forklaring. Jeg vil her forklare de dele af html siderne som jeg mener ikke er helt intuitive at forstå hvis funktion er: <umbraco:macro ArticleParts="[#articleParts]" Alias="ArticleParts" runat="server"></umbraco:m acro> Dette html umbraco tag specificere at der skal aktiveres en macro ved navn articleparts. Macroer i umbraco bruges til at kører scripts i umbraco såsom scripts eller dynamisk indhold. I denne specifikke macro er der angivet at dens indhold er lig dokumenttype egenskaben articleparts string repræsentation. Hvis man kigger i developer under macros kan man se at denne specifikke macro starter en c# brugerkontrol kaldt articlelinks. <asp:contentplaceholder Id="Body" runat="server"></asp:contentplaceholder> Dette umbraco tag indikere hvor templates skal vises i master templaten, i dette tilfælde body templaten. Så der hvori dette tag indsættes i master templatens kode er der hvor den tilhørende artikel for body vil blive vist. C# articlelink brugerkontrollen forklaret: Dette er det script der håndtere alle de operationer der skal gennemføres for at eksportere en artikel fra borger.dk. Basalt så kan de funktioner det udføre i kronologisk rækkefølge beskrives som: 1. Får givet en String værdi der enten indeholder urlen til artiklen eller beskriver hvilke sektioner af artiklen skal vises. Disse to Strings hedder henholdsvis Defaultvalue1 og articleparts. Defaultvalue1 er her den borger.dk url som brugerkontrollen bruger til at finde artiklen med. 2. Hvis det forholder sig sådan at defaultvalue1 ikke indeholder nogen værdi så stopper artikeleksports funktionen allerede her og siden kører som den ville normalt uden artikeleksports funktionen. 3. Hvis det er articleparts brugerkontrollen modtager som sit input gemmes dens værdi som en static String så værdien kan bruges når scriptet modtager urlen. 4. Hvis defaultvalue1 har en værdi, så åbnes der en forbindelse til database tabellen articleinfo som indeholder informationen for den gamle artikel der allerede vises på siden, hvis der altså allerede er en artikel gemt for siden. 5. Herefter bliver det checket om hvorvidt der er nogen forskel på defaultvalue1 og den gamle artikels url, hvorvidt der er blevet ændret på hvilke dele af artiklen der skal vises eller om der er gået 7 dage siden sidste opdatering. 6. Hvis ingen af disse krav er opfyldt bliver teksten for umbraco templaten body sat lig den gamle artikels tekst i databasen. 7. Ellers hentes den artikel som kan findes på den specificerede borger.dk url fra defaultvalue1. Artiklen bliver omdannet til et xml document for at de forskellige artikel dele kan identificeres. 9

10 8. Stringen savedparts checkes herefter for hvilke dele af artiklen der skal fremvises på siden. 9. De forskellige dele af artiklerne bliver gemt i en xmlnodelist array, artikeldelene findes via. brug af div tags i artiklen. 10. Nu skrives de forskellige artikel dele til en string kaldt convert, denne string indeholder på dette punkt hele den ønskede artikels tekst. 11. Databasen åbnes igen og den gamle artikel for siden bliver slettet hvorefter den nye artikel bliver lagt ind bagefter. 12. Til sidst omskrives templaten i umbraco ud fra to tekst filer(kaldt upperbody og lowerbody som indeholder head sektionen for templaten samt de afsluttende tags) og convert Stringen. Så først indskrives upperbody, så convert stringen og tilsidst lowerbody. Den anden brugerkontrol showarticles er en del mere simpel, den henter blot alle artikel titler fra databasen og skriver dem ind i templaten showarticles. Begrænsninger: Den største begrænsning ved det færdige produkt er at det kun kan fungere i samarbejde med en database. Man skal derfor have en database installeret og følge den overstående guide for opsættelse før produktet kan kører. En anden begrænsning er at det kun kan acceptere et link fra borger.dk, alle andre links vil resultere i at umbraco kaster en fejlmeddelse når man prøver at gå ind på siden. En bekymring jeg kunne havde for modulet er den tid det tager for siden at skulle kører brugerkontrollen articlelink, hvis der ønskes at gøre modulet hurtigere kunne man sætte flere forbehold op for hvornår brugerkontrollen skal køres. Hvis jeg selv skulle komme med nogle ideer til hvad der kunne blive indkluderet i artikeleksports modulet ville det være: 1. Få opsat så det pakket modul indeholde en database opsat så modulet kan køres med det samme lige efter udpakning. 2. En opdateringsknap der tillader udviklere at fremtvinge en opdatering af en artikel før der er gået en uge. Dette kunne evt. opnås ved at bruge de umbraco specifikke objekter der kan bruges i c# som findes i hver umbraco CMS bin folder. 3. Få opsat så der som standard for en ny content side så er alle artikel dele i borger.dk tabben slået til i stedet for fra. En nemmere løsning kunne være at lave en hvis alle knap som når den aktiveres gør at hele artiklen bliver vist. Ville efter min mening gøre modulet mere brugervenligt. 10