Yliopiston etusivulle In English
Helsingin yliopisto
Kielenkäsittelyn ATK-palvelut

Yhteystiedot

Yleisen kielitieteen laitos
PL 9 (Siltavuorenpenger 20 A)
00014 HELSINGIN YLIOPISTO

Puhelin +358 (09) 1911 (vaihde)
Faksi +358 (09) 191 29307

Ohje ATK-palveluiden dokumentoimiseksi verkkosivuilla

Tässä kuvataan menettely, jolla voidaan laatia ja ylläpitää yhtenäisesti muotoiltuja ja yhtenäiseen navigointiin perustuvia ohjesivuja yleisen kielitieteen laitoksen ATK-palveluille. Samaa menettelyä voitaneen soveltaa melkein sellaisenaan muihinkin verkkosivustoihin.

Sivut on kirjoitetaan World Wide Web Consortiumin määrittelemällä XHTML 1.0 -merkkauskielellä, jota voidaan pitää yleisesti tunnettuna ja tuettuna sitä tukevia editoriohjelmia on hyvin saatavilla. Yhtenäinen Helsingin yliopiston visuaalisen ilmeen mukainen muotoilu ja koristelu näille sivuille aikaansaadaan XSL-transformaatioilla, jotka lisäävät nettotekstiin laitoksen ja tiedekunnan teksteillä varustetun palkin yläosaan ja navigointipalkin vasemmalle sivulle.

Yläpalkin perusteella on helppo tunnistaa, että ollaan yleisen kielitieteen laitoksen sivuilla. Navigointipalkin tarkoitus on helpottaa suunnistusta käsillä olevan sivuston sisällä ja auttaa selaajaa pysymään selvillä siitä, missä päin sivustoa kulloinkin ollaan. Navigointipalkki on eräänlainen valikoiva sisällysluettelo, jossa käsillä oleva sivu on korostettuna ja käsillä olevan hakemiston osuus yksityiskohtaisemmin avattuna. Siirryttäessä sivuilta toisille ja toisiin alihakemistoihin navigointipalkki muuntuu vastaavasti.

1. Hakemistorakenne ja tiedostojen nimeäminen ja sijoittelu

Sivusto koostuu sivuista, jotka ryhmitellään hierarkkisesti sijoittelemalla sivutiedostot vastaaviin hakemistoihin.

1.1 Sivustot ja sivut

Sivustoksi kutsutaan tässä tiettyyn teemaan liittyviä verkkosivuja, jotka kuuluvat yhteen. ATK-palvelujen sivujen katsotaan tässä kuuluvan yhteen ja muodostavan sivuston. Teknisesti katsottuna tämä tarkoittaa sitä, että hakemistossa /web/ling/atk/ olevat verkkosivut muodostavat yhden sivuston. Vastaavasti esimerkiksi jokaisen kurssin sivustot muodostavat oman sivustonsa. Laitoksen verkkosivut pitää hahmottaa toisensa poissulkeviksi sivustoiksi. Teknisesti tällainen sivujen erottaminen omaksi sivustokseen näkyy kahdella tavalla: ensinnäkin navigointipalkisto on erityisesti sinipohjaisilta osiltaan eri sivustoilla erilainen ja toisekseen yläpalkin alapuolella oleva otsikko ja selainikkunan otsikko ovat kunkin sivuston sisällä samat mutta eri sivustoilla erilaiset.

Sivusto jakaantuu osiin samaan tapaan kuin kirja jakaantuu lukuihin ja hierarkkisesti pienempiin jaksoihin ja kappaleisiin. Paitsi tiedostorakenteen mukaisena osana hakemisto määrittelee sivuston loogisen osan eli siihen kuuluvan alasivuston, joka ohjaa navigointipalkin rakennetta. Kussakin hakemistossa voi olla sivuja tai hakemistoja. Kullakin hakemistolla ja sivulla on tunnus, joka on tiedoston nimi ilman pistettä ja loppuliitettä tai hakemiston nimi (ei kuitenkaan koko hakemistopolku, vaan ainoastaan polun viimeinen osa). On tärkeää, että tunnukset ja tiedostojen ja hakemistojen nimet ovat yhtäpitäviä (joskin poikkeamatkin voidaan hoitaa).

1.2 Alasivustojen hakemistojen sisältö

Jokaisessa alihakemistossa (ja sen puoleen koko sivuston juurihakemistossakin) kertautuu sama rakenne:

  • Sillä tasolla olevien .shtml -sivujen julkistetut versiot tiedostoina,
  • kyseisen tason alihakemistot, sekä
  • XML -niminen alihakemisto, jossa sijaitsevat mm. lähdekoodit:
    • Makefile -tiedosto,
    • navigation.xml -niminen tiedosto, joka kuvaa tämän tason sivut ja alisivustojen nimet,
    • tämän tason sivujen lähdekoodit (joiden nimet päättyvät loppuliitteeseen .xhtml) sekä
    • mahdollisia kopioita tehdyistä .shtml -tiedostoista, jotka on tarkoitus aikanaan kopioida yhtä tasoa ylemmäksi.

Esimerkki alasivuston hakemistosta:

venus:/web/ling/atk/ohjelmointi/web
$ ls -l
drwxrwsr-x   3 koskenni webist    4096 Dec 29 11:40 XML
-rw-rw-r--   1 koskenni webist   11505 Dec 29 11:20 atk-palv-dok-ohje.shtml
-rw-rw-r--   1 koskenni webist    6879 Dec 29 11:20 emacs-nxml.shtml
-rw-rw-r--   1 koskenni webist    4722 Dec 29 11:20 index.shtml
-rw-rw-r--   1 koskenni webist    6471 Dec 29 11:20 navigointi.shtml

$ ls -l XML/
-rw-rw-r--   1 koskenni webist     188 Dec 28 14:20 Makefile
drwxrws---   2 koskenni webist    4096 Dec 28 14:20 RCS
-rw-rw-r--   1 koskenni webist     901 Dec 29 11:20 agen-navigation.xml
-rw-rw-r--   1 koskenni webist   11505 Dec 29 11:20 atk-palv-dok-ohje.shtml
-rw-r-----   1 koskenni webist    8521 Dec 29 11:50 atk-palv-dok-ohje.xhtml
-rw-rw-r--   1 koskenni webist    6879 Dec 29 11:20 emacs-nxml.shtml
-rw-r-----   1 koskenni webist    3214 Dec 29 11:07 emacs-nxml.xhtml
-rw-rw-r--   1 koskenni webist    4722 Dec 29 11:20 index.shtml
-rw-rw-r--   1 koskenni webist    1034 Dec 29 11:05 index.xhtml
-rw-rw-r--   1 koskenni webist     719 Dec 29 11:20 navigation.xml
-rw-rw-r--   1 koskenni webist    6471 Dec 29 11:20 navigointi.shtml
-rw-r-----   1 koskenni webist    2535 Dec 29 11:12 navigointi.xhtml
-rw-rw-r--   1 koskenni webist     343 Dec 29 11:04 skeleton
    

1.3 Alasivustojen hakemistojen luonti

Alasivusojen hakemistot ovat keskenään kovin samanlaisia ja niiden luontian varten on komento, joka suoritetaan hakemistossa, jonka alle hakemisto pitäisi luoda, esim.:

/web/ling/atk/bin/tee-alasivusto kokeilu

Komennolle annetaan yksi parametri, joka on yhtä kuin alasivuston tunnus.

2. Sivuston sisäisen navigoinnin järjestäminen

Sivuston sisäinen navigointi hoituu sillä, että kunkin alasivuston hakemiston XML-alihakemistossa oleva navigation.xml -niminen tiedosto päivitetään alasivustoa vastaavaksi.

3. Verkkosivujen laatiminen ja päivittäminen

Verkkosivuja voi kirjoittaa monella keinolla, sillä XHTML on standardoitu ja monet editorit tukevat sitä, mm. Emacs ja sen PSGML-moodi, W3C:n Amaya sekä erilaiset XML-editorit. On huomattava, että verkkosivujen lähdekoodin tulee olla muodollisestikin korrektia XML:ää ja XHTML:ää.

XHTML-tiedoston HEAD-osaan kirjoitetaan TITLE-attribuutin arvoksi kyseisen sivuston otsikko. Itse sivun otsikko laitetaan BODY-osaan sen alkuun H1-tason otsikoksi.

4. Uusien sivujen laatiminen ja sivujen päivittäminen

Sivujen päivittämisessä noudatetaan versionhallintaa (RCS). Jos käytetään Emacsia, tämä merkitsee sitä, että tiedoston tekemisen tai korjailun päätteeksi suoritetaan komento C-x v v, joka suorittaa ns. checkin-operaation (joka tallettaa version ja vapauttaa lähdetiedoston yksinomaisesta käytöstä). Vastaavasti kunkin korjailukierroksen alussa suoritetaan sama komento, joka tällöin suorittaa ns. checkout-operaation (joka varaa yksinoikeuden kyseisen tiedoston muutteluun).

Uuden sivun lisäämisen yhteydessä pitää päivittää XML-hakemistossa oleva sivusto.xml -tiedosto.

Kun on mielestään saanut sivun päivitetyksi, suoritetaan kyseisessä XML-hakemistossa make tai make install -komento, joka koristelee sivun ja vie sen julkiselle paikalleen.

5. Sivujen koristelu julkaistaviksi XSLT:n avulla

Sivujen koristelu ja sivulinkkilistan muodostaminen tapahtuvat automaattisesti make -komennon toimesta.