Datalogi 0 GA 2003 Rapportopgaven G: læsbarhedsindeks

Transkript

1 Datalogisk Institut Københavns Universitet Bacheloreksamen i datalogi Datalogi 0 GA 2003 Rapportopgaven G: læsbarhedsindeks Dette er G-opgaven på Datalogi 0 GA i efteråret 2003 den opgave, hvis besvarelse man skal have godkendt for at kunne indstille sig til eksamen i rapportopgavedelen af kurset. Teksten udleveres torsdag den 25. september 2003 kl. 14, opgaven er beregnet til besvarelse i grupper på tre personer, og besvarelser skal senest afleveres fredag den 10. oktober kl (Se i øvrigt det administrative afsnit nedenfor.) Opgaveteksten har tre hovedafsnit: efter en præsentation af opgaven i korte træk gives der i afsnit 2 en mere præcis specifikation, og afsnit 3 anfører nogle krævede administrative rammer for opgavearbejdet. 1 Opgave I bind 12 af Den Store Danske Encyklopædi (Danmarks Nationalleksikon A/S, 1998) finder man dette opslag: lix, fork.f. læsbarhedsindeks, målestok for teksters sprogligt bestemte læsbarhed, introduceret af den svenske pædagog C.H. Björnsson ( ). Lixtallet for en tekst opgøres som det gennemsnitlige antal ord pr. periode, dvs. antal ord mellem to punktummer, plus procentdelen af lange ord, dvs. ord på over seks bogstaver. Lixtallet stemmer godt med den umiddelbart oplevede tilgængelighed af en tekst, men fortæller ikke, hvor let teksten i øvrigt er at forstå eller huske. En tekst med et lixtal på 40 er for voksne middelsvær; lix 20 anses for meget let, lix 30 let, lix 50 svær og lix 60 meget svær; eksempelvis har fadervor i den ny bibeloversættelse (1992) lix 33, når amen ikke regnes for en selvstændig periode. Lixtallet for denne artikel er 51. Se også læsning og sætning. Elbro Skriv i Standard ML en funktion, som for en tekst i HTML-format beregner dens læsbarhedsindeks. 2 Specifikation Skriv et ML-program, det vil sige en række definitioner, der fører frem til en funktion lixhtmlfil : string -> int. Hvis filnavn er stinavn på en fil, der indeholder en tekst i HTML-format (se nedenfor), skal kaldet lixhtmlfil "filnavn" beregne læsbarhedsindekset for denne tekst.

2 Datalogi 0 GA 2003, G: lix side En HTML-sides udseende Når man med et fremvisningsprogram (en såkaldt browser som for eksempel Microsoft Explorer, Ofir eller Netscape) kan få internetdokumenter fremvist i farver og med indrammet eller blinkende tekst og andre effekter, skyldes det styreangivelser, der er indeholdt i teksten. Til grund for det, som fremvises på skærmen, ligger en kildetekst (Page Source), der er skrevet i et særligt markeringssprog, HTML (HyperText Markup Language). HTML findes i flere versioner, og specifikationen af sproget er et voluminøst dokument, så beskrivelsen herunder er ikke sandheden om HTML, men i høj grad ufuldstændig og upræcis. Nogle generelle træk ved sproget skitseres, men sammen med afsnit i bind 4 af kursusbogen bør beskrivelsen her være tilstrækkelig til løsning af den stillede opgave Tekst I en HTML-kildetekst kan man nøjes med de grafiske tegn i ISOs 7-bit kode, det vil sige tegnene med valør Tabellen i afsnit af kursusbogens bind 4 viser, hvordan tegn fra ISOs 8-bit kode kan kodes ind i en HTML-kildetekst. De nye HTML-standarder accepterer dog også disse tegn direkte, så man for eksempel bare kan skrive ø og og ikke er tvunget til at kode det som henholdsvis ø og Opstillingsordrer En opstillingsordre (eng. tag) skrives i HTML som en kode mellem vinkelparenteser. De fleste ordrer hører parvis sammen, idet den ene ordre åbner den pågældende opstilling og den anden lukker den igen. Koden for lukkeordren er da åbningsordrens kode med en skråstreg foran. For at få fremhævet noget skriver man for eksempel for at få <em>fremhævet</em> noget (em er en forkortelse for emphasize). Her er nogle opstillingsordrepar: <p> tekst </p> afsnit (paragraph) <var> variabelnavn </var> matematisk skrift (variable) <em> fremhævet tekst </em> (som regel med kursiv) <strong> stærk fremhævning </strong> (som regel med fed skrift) _fodtekst sænket skrift (subscript) ^eksponent hævet skrift (superscript) <h1> overskrift </h1> overskrift (heading) på højeste niveau. På samme måde findes h2,..., h6 <ul> <li> linje 1 </li> <li> linje 2 </li>... </ul> opstilling af linjerne i en liste (unordered list) I opstillingsordrer skelnes ikke mellem små og store bogstaver. Der er således ingen forskel på <p> og <P>, eller på <ul>, <ul>, <Ul> og <UL>. Selv om parrenes åbnings- og lukkeordrer hører sammen, skal det ikke nødvendigvis være den senest åbnede opstilling, der lukkes først. Fremvisningsprogrammer vil acceptere, at ordrerne ikke anføres i en parentesstruktur, men at rækkefølgen for eksempel bliver <li><var>_{...</var></li>}.

3 Datalogi 0 GA 2003, G: lix side Attributter I mange tilfælde kan en opstillingsform styres af såkaldte attributter, der kan sættes inde i åbningsordren i en notation analog med den, man for eksempel bruger for at få tekst vist med farve: dette bliver skrevet <font color = "red">med rødt</font>. Den vigtigste ordre i en hypertekst, nemlig den, der i en tekst indlægger en henvisning (anchor), man kan klikke på, har denne form, idet destinationens internetadresse angives som attribut. For at klik på hjemmesiden skal føre til DIKUs hjemmeside, skriver man for eksempel tilbage til <a href = " Enkeltordrer I enkelte tilfælde indgår ordren ikke naturligt i et par, og man kan da sætte en skråstreg foran den afsluttende vinkelparentes: <br /> Skift (break) til ny linje <hr /> Indsæt en vandret streg (horizontal rule) Af hensyn til kompatibilitet med ældre versioner af HTML kan ordrerne dog også bare skrives <br> og <hr>, ligesom visse lukkeordrer (for eksempel </p> og </li>) godt kan udelades Kommentarer En HTML-kommentar indledes med <!--, og et fremvisningsprogram vil overspringe alt fra og med dette symbol frem til og med første forekomst af -->. Dette symbolpar danner ikke en parentesstruktur; i teksten <!-- tekst1 <!-- tekst2 --> tekst3 --> vil tekst1 og tekst2 blive sprunget over, men tekst3 vil blive fremvist Opbygning Der er op imod et halvt hundrede opstillingsordrer, som det imidlertid slet ikke er nødvendigt at kende for at løse den forelagte opgave. Man kan derimod tillade sig at gå ud fra, at i en HTML-kildetekst vil alt, der er sat i vinkelparenteser, være en opstillingsordre eller en kommentar eller noget andet, der ikke direkte er en del af selve teksten. (Hvis der i teksten er brug for tegnene mindre end eller større end, er de skrevet henholdsvis < og >.) Ved besvarelse af opgaven kan man gå ud fra, en HTML-kilde har denne overordnede struktur: Der kan være nogle indledende koder (som beskriver dokumentets type). <html... eventuelt attributter> <head... eventuelt attributter> Her følger hovedet, som blandt andet giver siden et navn. </head> <body... eventuelt attributter> Nu kommer den egentlige tekst. </body> </html> Det er naturligvis den egentlige tekst (mellem <body...> og </body>), hvis læsbarhedsindeks skal bestemmes.

4 Datalogi 0 GA 2003, G: lix side 4 Krav til den konstruerede funktion: Ved løsning af opgaven kan man gå ud fra, indgangsteksten er korrekt HTML; der skal ikke gøres forsøg på at tolerere fejlagtige strukturer. Det er derimod et krav, at både tegn fra ISOs 8-bit-kode og tegn, der er kodet som &...;-sekvenser (se side 48 i kursusbogens bind 4), behandles korrekt. (Det skal altså for eksempel være ligegyldigt, om alfabetets sidste bogstav skrives å eller å eller å.) 2.2 HTML-kodning Den, der skal konstruere en hjemmeside, behøver ikke at være bevidst om HTMLkildeteksters opbygning eller om de forskellige tegns koder: Mange redigeringsprogrammer er sådan indrettet, at man kan bede dem om at generere tekster, der overholder kravene. Alligevel kan man altid få den rå kildetekst afsløret: Alle fremvisningsprogrammer har en facilitet, der gør det muligt at få fat i den bagvedliggende HTML-kilde, når man har kaldt en internetside frem. Med DIKUs version af Netscape foregår det på følgende måde: Vælg Page Source fra View-menuen. Man kan også gemme HTML-kilden direkte (uden at se den først) med Save As fra File-menuen. 2.3 Verifikation og tolerance HTML vedligeholdes af W3C (the world wide web consortium), som også har en hjemmeside med et såkaldt valideringsprogram: Ved at gå ind på kan man få en internetside eller en tekstfil kontrolleret for, om den overholder HTMLstandarden. Advarsel: Mange fremvisningsprogrammer er overordentlig tolerante, idet de forsøger at forbigå HTML-fejl og gætte, hvad der har været ment. 2.4 Brug af den konstruerede funktion For at kunne anvende den konstruerede funktion må man i almindelighed forestille sig en proces i flere faser: 1. På nettet findes en tekst, hvis læsbarhedsindeks ønskes bestemt. Eventuelt kan man kontrollere den med W3C s validator. 2. Tekstens HTML-kilde gemmes (ved at vælge Save As fra File-menuen) i en fil i ens eget hjemmekatalog. 3. Derefter kaldes lixhtmlfil med filens navn som argument. For filer, der allerede ligger på DIKUs Unix-system, er punkt 2 unødvendigt (forudsat naturligvis, at man afvikler Mosml fra en af DIKUs terminaler). En liste sidst i denne opgavetekst angiver nogle af de tilgængelige HTML-filer.

5 Datalogi 0 GA 2003, G: lix side Programmeringsstil Programdelene skal skrives i versionen Moscow ML 2.00 af Standard ML og må kun benytte de sprogelementer og hjælpefunktioner, som er gennemgået ved forelæsningerne, svarende til kapitel 1 6, afsnit og afsnit 14.1, og 14.5 af lærebogen af Hansen & Rischel samt kapitel 2 12 af bind 4 af kursusbogen. Bortset fra modulerne Char, Int, List, Real, String, Substring og TextIO må der ikke benyttes funktioner fra Moscow ML s standardbibliotek. Der lægges vægt på, at der benyttes god funktionsprogrammeringsstil, hvilket blandt andet indebærer, at programteksten skal være bygget op af simple funktioner, der hver løser et veldefineret separat delproblem. Funktioner med bivirkning skal i videst muligt omfang holdes adskilt fra de øvrige (rent funktionelle) dele af programmet. Hvis samme delproblem dukker op flere gange, eller hvis en kompliceret beregning kan forenkles ved særskilt løsning af et delproblem, bør der skrives en funktion til løsning af delproblemet. (Brug samme stil som i kalendereksemplet (bind 4 kapitel 12), sumbevarende afrunding (bind 1 afsnit 3.6) og de øvrige eksempler i bøgerne.) Hver funktionsdefinition skal ledsages af en kommentar, der forklarer funktionens virkning. Hvis virkningen er simpel og fremgår klart af en ganske kort programtekst, kan kommentaren udelades; for mere sammensatte funktioner kan det være nødvendigt med længere forklaringer eller med henvisninger til rapportteksten. Hvis der er fejl eller mangler i det udviklede program, skal det klart fremgå af rapporten. 2.6 Spørgsmål og svar En særlig internetside (som kan nås fra hjemmesiden for datalogi 0 GA) vil i opgaveperioden være sat af til uddybning af opgaven. Spørgsmål i forbindelse med opgaven kan gives til Nils Andersen på en seddel, sendes elektronisk (til nils@diku.dk) eller kommunikeres via instruktorerne. Hvis spørgsmålet skønnes af almen interesse, vil både spørgsmål og svar blive offentliggjort på siden. I opgaveperioden kan det være en stor hjælp at følge med i dialogen på denne side. De studerende kan også kommunikere indbyrdes via datalogi 0 GA-nyhedsgruppen; instruktorerne følger debatten i dette forum. 2.7 Instruktorvagt Der afholdes ikke øvelser i ugerne 40 og 41, men de fleste dage i opgaveperioden er der en eller to timer, hvor en instruktor står til rådighed for besvarelse af spørgsmål. Instruktorvagten træffes i den vestligste ende (ved den runde væg) af maskinstuen Hel, S 111. Det planlagte instruktorvagtskema ser således ud: tid ma ti on to fr ma ti on to 29/9 30/9 1/10 2/10 3/10 6/10 7/10 8/10 9/10 kl Dina Kenneth Dina Frederik Søren Anders Søren Dina Frederik kl Anders

6 Datalogi 0 GA 2003, G: lix side Krav til besvarelsen Læg mærke til kursusbogens bind 1, kapitel 3. Opgaven skal dokumenteres i en rapport med de seks afsnit, der er redegjort for i kursusbogens bind 1, afsnit 3.3, og for at få besvarelsen godkendt er det en betingelse, at man har forsøgt at skrive dem alle seks. Med hensyn til afprøvning skal der kun foretages en intern afprøvning (jævnfør kursusbogens bind 1 afsnit og bind 4 afsnit 6.5). Det er dog tillige et krav, at programmet har været kørt på de fire tekstfiler i kataloget /vol/www/undervisning/2003e/dat0ga/html-eksempler/ (se afsnit 4.1 herunder), og udskrift med resultater af disse fire kørsler skal vedlægges besvarelsen. Rapporten skal skrives på korrekt og godt dansk. Alt skal formuleres kort, præcist, velovervejet og let læseligt. Begreber og forkortelser, der ikke er almindelig kendt, skal defineres, før de anvendes. DIKUs edb-system er først og fremmest beregnet til udarbejdelse af programmer, og eventuelle tekstbehandlingsopgaver skal vige pladsen for programudvikling. 2.9 Form Afsnit i bind 1 af kursusbogen anfører en række krav til rapporters form. Her står blandt andet, at rapporten skal afleveres maskinskrevet på papir, kun beskrevet på den ene side af hvert ark, og at besvarelsen ikke må hæftes sammen, men skal indlægges i et klart plasticchartek med to åbne sider (ikke en opskåret plasticlomme). Besvarelsens hovedtekst (fraregnet program og udskrifter) forventes ikke at fylde mere end omkring 12 sider. Navnene på alle gruppens medlemmer samt disses login -navne og navnet på den fil, hvori programteksten befinder sig, skal anføres på forsideblanketten. I opgaveperioden vil det være naturligt at beskytte denne fil, så uvedkommende ikke kan læse den eller skrive til den, men når opgaven afleveres, skal beskyttelsesbittene være sådan sat, at alle kan læse den, og i de første 30 dage efter afleveringen må der ikke rettes i filen Omfang Opgaven er beregnet på at kunne løses af en trepersoners gruppe med en indsats på cirka 30 timers effektivt arbejde pr. person. Pas på med at vælge for ambitiøs en løsning en behersket løsning, der er gennemført og veldokumenteret, må betragtes som bedre end en mere avanceret løsning, der ikke er blevet helt færdig eller er uklart dokumenteret. Læg en tidsplan, og forsøg at overholde den! 3 Administrative bestemmelser Dette er godkendelsesopgaven på Datalogi 0 GA, hvilket vil sige, at en af forudsætningerne for, at man kan melde sig til rapportopgaveeksamen på datalogi 0 GA, er, at man har fået besvarelsen af denne opgave godkendt. Opgaven præsenteres ved forelæsningen torsdag den 25. september 2003; opgaveteksten udleveres i auditoriet kl. 14 og vil fra kl. 15 være lagt frem i reolen foran bachelor-

7 Datalogi 0 GA 2003, G: lix side 7 studieadministrationskontoret. Fra kl. 17 vil den desuden kunne hentes elektronisk (i.pdf-format) fra hjemmesiden. Den endelige besvarelse af opgaven skal afleveres i førstedelsadministrationen i to eksemplarer vedlagt fire udfyldte forsideblanketter senest fredag den 10. oktober kl Den ene forside får gruppen med tilbage som kvittering for besvarelsens aflevering. (Ønskes ikke kvittering, er det nok med tre forsider.) Besvarelser, der uden gyldig udsættelse afleveres senere end dette tidspunkt, vil blive afvist. Afsnit 3.4 i bind 1 af Datalogi 0 GA-kursusbogen beskriver regler og procedure vedrørende udsættelse. Det tilrådes (som anført på forsideblanketten) at opbevare en sikkerhedskopi af besvarelsen (på et andet sted end DIKU). 3.1 Gruppedannelse G skal løses i grupper med tre (eller eventuelt to) personer. Som et tilbud organiseres bindende gruppetilmelding; hvis en gruppe ønsker at benytte sig heraf, skal et medlem af gruppen senest fredag den 3. oktober henvende sig på bachelorstudieadministrationskontoret med to udfyldte og underskrevne forsideblanketter til G. Den ene af disse får gruppen med tilbage som kvittering, og den skal anvendes (som den ene af de krævede forsideblanketter) ved afleveringen af G-besvarelsen. Kravet om, at besvarelsen skal være resultat af et gruppesamarbejde, håndhæves strengt. Besvarelser fra enkeltpersoner eller fra grupper med mere end tre deltagere afvises administrativt. Det vil være mest hensigtsmæssigt at danne grupperne inden for øvelsesholdene, men hvis dette er problematisk, kan man søge at finde en makker fra et andet hold. Kontakt kan eventuelt etableres gennem instruktorerne eller via datalogi 0 GA-nyhedsgruppen, eller man kan bede studieadministrationskontoret om hjælp. 3.2 Genaflevering Hvis der er gjort et helhjertet forsøg på at løse opgaven, men besvarelsen alligevel i første omgang forkastes, får gruppen en ekstra uge at forbedre rapporten i. Det er de studerendes egen sag at holde sig underrettede om, hvorvidt deres besvarelse er blevet godkendt, og i benægtende fald at få at vide, hvornår den ekstra uge løber. 3.3 Redelighed Med deres underskrifter på forsiden garanterer gruppedeltagerne, at de selv har gennemført opgavebesvarelsen. Hver gruppe skal udarbejde en selvstændig besvarelse; enhver form for afskrift betragtes som eksamenssnyderi (og fører blandt andet til annullering af alle eksamensresultater fra samme eksamenstermin). Overordnet kan eventuelle problemer, som dukker op i opgaveperioden, drøftes mellem de studerende indbyrdes, men ingen form for kopiering af program- eller rapportdele kan tillades. Se også i bind 1 af kursusbogen afsnittene Redelighed i besvarelser (under afsnit 3.3.7) og bestemmelserne Regler om disciplinære foranstaltninger over for studerende ved Københavns Universitet (findes på nettet) specielt 5 Stk. 2.

8 Datalogi 0 GA 2003, G: lix side 8 4 Udvalgte HTML-filer 4.1 De krævede eksempelfiler Fra tirsdag den 30. september 2003 vil dette katalog: /vol/www/undervisning/2003e/dat0ga/html-eksempler/ rumme de fire tekstfiler, som det er obligatorisk at prøve lixhtmlfil på. 4.2 Andre filer på DIKUs Unix-system Hjemmesiden for Datalogi 0 GA: /vol/www/undervisning/2003e/dat0ga/index.html Studievejledning for ph.d.-studiet i datalogi: /vol/www/undervisning/phd.html 4.3 På nettet Danske klassikere fra før ca kan findes gennem Det kongelige Biblioteks base: Universitetets love og regler: Andre interessante kilder kan findes via disse indgange: (Folketinget) (Dagbladet Information) (Dagbladet Politiken) (Berlingske Tidende) (Ekstrabladet) (Dagbladet BT)