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

Verkkotiedotuksen hakemistojen rakenne

Tämä sivu on tässä vaiheessa ehdotus yhtenäiseksi käytännöksi soveltaa laitoksen omin XML- ja XSLT-pohjaisin keinoin Helsingin yliopiston uutta ns. visuaalista ilmettä. Ehdotus sisältää periaatteita erityisesti verkkosivujen ja niiden tekemiseen liittyvien säännöstöjen ja aputiedostojen sijoittelemisesta hakemistorakenteeseen.

1. Tavoitteita

1.1 Ylläpidon ymmärrettävyys

Sivujen ylläpitoon osallistuu useita henkilöitä, joilla kaikilla kyllä on perustietoja, mutta useimmat ylläpitäjät korjailevat ja toimittavat sivuja vain pienenä osana töitään. Voidaan pyrkiä edelleen siihen, että tästä ylläpitäjien joukosta se, joka havaitsee verkkosivuja selatessaan siellä virheen, voi sen myös jokseenkin samantien korjata. Sen vuoksi verkkoselaimella selatusta sivusta ja sen osoitteesta pitää helposti voida päätellä, missä sivun lähdekoodi on.

Seurauksena tästä tai rinnakkaisena ymmärrettävyyden kanssa, ehdotetaan pyrittäväksi siihen, että navigointirakenne ja tiedostojen hakemistorakenne vastaisivat mahdollisimman tarkoin toisiaan.

Edelleen, ylläpidon ymmärrettävyyden edistämiseksi ehdotetaan pyrittäväksi siihen, että verkkosivujen julkaistut (HTML- tai SHTML-muotoiset) tiedostot ja niiden päivittämiseen tarvittavat lähdetiedostot sekä sisällön muokkaamiseen tarvittavat säännöstöt ovat hakemistorakenteessa lähellä toisiaan.

1.2 Yhtenäinen ulkoasu

Ulkoasua koskeva koristelusäännöstö sijoitetaan hakemistorakenteessa mahdollismman ylös, jotta sitä voidaan luontevasti käyttää kaikilla sivuilla tai sovellettuna kuitenkin kokonaiselle alisivustolle (kuten FILT, KIT-verkoston sivut, jne.).

1.3 Navigoinnin tukeminen

Olisi pyrittävä tukemaan sitä, että verkkosivujen selaajalla säilyy tuntu siitä, missä kulloinkin ollaan. Sekä käyttäjää että ylläpitäjää pitää tukea hahmottamaan yksittäisten sivujen ryhmittymistä laajemmiksi sivustoiksi. Sen vuoksi mm. on syytä erottaa linkit, jotka vievät saman osasivuston sisällä edelleen niistä linkeistä, jotka vievät kyseiseltä osasivustolta pois (esim. jonnekin laajempaan kokonaisuuteen kuten esim. oppiaineeseen tai aiheeseen liittyvään muualla oleviin paikkoihin kuten esim. yliopiston tietotekniikkaosaston yleisille sivustoille).

1.4 Yksinkertaisuus

Yksinkertaisuus on helposti sanottu tavoite, mutta vaikea toteuttaa käytännössä. Verkkosivujen aiemmat järjestelyt ja käytännöt ovat lievästikin arvioituna olleet mutkikkaita. Aiempien järjestelyiden ongelmiksi on voitu tunnistaa ainakin:

  • Monta erilaista käytäntöä: kieliteknologian kurssisivut, intra, KIT-verkoston tiedotussivut, laitoksen helkilöstölistat ja puhelinluettelot, ATK-palveluiden luettelot, FILT-sivujen luettelot jne. Vain harvat enää osaavat korjata näitä sivuja.
  • Tiettyjen sivujen lähdekoodin ja päivitysmenettelyn paikallistaminen on vaikeaa, esim. laitoksen hallintoa koskevia sivuja koskevia lähdetiedostoja on samassa hakemistossa kovin paljon ja ohjeetkin ovat pitkiä, kun käsittelevät useita asioita.
  • Uusien sivujen lisääminen esim. laitoksen hallintoa koskevaan sivustoon edellyttää Makefilen päivittämistä, mikä toisaalta olisi vaativaa ja toisaalta tietysti arveluttavaa, jos päivityksen seurauksena tulisi virheitä.

Syksyllä 2004 käyttöön otetun menettelyn voi toivoa yksinkertaistavan menettelyitä ainakin siten, että verkossa selattavan sivun perusteella on helpompaa löytää lähdekoodi. Lähdekoodi on usein valmiiksi XHTML-muotoinen tai sitten samassa hakemistossa lähdekoodin kanssa on XSL-säännöstö, joka muuttaa kotitekoisen XML:n XHTML-muotoon. Myös navigoinnin valikkomekanismi on uusittu ja sallii hierarkisten sivustojen kuvaamisen sivuvalikoiksi.

2. Verkkosivujen hakemisto- ja valikkorakenne

Verkkosivuilla on valikkona sivulinkit, jotka osoittavat samaan osasivustoon eli kyseisen sivun rinnalla oleviin toisiin samantasoisiin sivuihin tai tämän sivuston alasivuostojen aloitussivuihin. Tämä valikkorakenne otetaan ohjenuoraksi hakemistorakennetta muotoiltaessa: Yleensä valikon tiedostot ovat yhdessä hakemistossa ja yhdessä hakemistossa olevat tiedostot ovat ne, joihin sivulinkkivalikosta pääsee.

Yksittäisissä tapauksissa tietysti voidaan valikossa osoittaa linkillä muuallakin oleviin sivuihin, jopa muilla palvelimilla oleviin sivuihin, kun ne sisältävät tietoa, joka voisi mieluusti olla täälläkin.

Valikon alaosassa pidetään erikseen joukkoa linkkejä ulos kyseisestä sivustosta paikkoihin, jotka ovat tärkeitä sivuston ympäristönä, mutta nämä ovat yleensä laajahkoja kokonaisuuksia. Tämä mekanismi pidettäköön erillään sivuston sisäisistä linkeistä.

Lähdetiedostot (XHTML-muotoiset) ja säännöstöt (kuten XSL- ja Makefile-tiedostot pidetään erillisessä (XML -nimisessä) alisivuston hakemistossa. Sekin on eri asia kuin ensimmäisessä kappaleessa mainittu sivulinkkien valikon ja tiedostojen ja alihakemistojen samanrakenteisuus.

3. Yksittäisen alisivuston rakenne

Esimerkki osasivustosta, jossa aloitussivu index.shtml ja kaksi muuta katseltavaa sivua (atk-palv-dok-ohje.shtml ja emacs-nsml.shtml):

$ ls -l /web/ling/atk/ohjelmointi/web
total 40
-rw-rw-r-- 1 koskenni webist 9796 Feb 20 10:37 atk-palv-dok-ohje.shtml
-rw-rw-r-- 1 koskenni webist 5369 Feb 20 10:37 emacs-nxml.shtml
-rw-rw-r-- 1 koskenni webist 3034 Feb 19 09:10 index.shtml drwxrws--- 3 koskenni webist 4096 Feb 20 10:37 XML

4. Sivujen yhteiset koristelusäännöstöt

Yhteisesti käytetävät XSL-koristelusäännöstöt, CSS-tiedostot ja koristelussa tarvittavat logot ja muut visuaalisen ilmeen edellyttämät graafiset osaset sijoitetaan yhteiseen ylimmän tason alihakemistoon esim. seuraavasti:

  • /web/ling/util/css: HTML:n tyylitiedostot, tänne kaikilla pääsy ja lukuoikeus.
  • /web/ling/util/img: symbolien ja logojen ym. kuvatiedostot, tänne kaikilla pääsy ja lukuoikeus.
  • /web/ling/util/MK: yhteisiä Makefile-tiedostojen osia sisällytettäviksi enemmän ja vähemmän erikoistuneisiin osasivustojen Makefile-tiedostoihin include-komennolla.
  • /web/ling/XSL/ kaikkien, keskenään hiukan eri tavoin koristeltujen sivujen yhteiset XSL-koristelusäännöstöt. Esim. kunkin oppiaineen omilla erityisteksteillä varustettu säännöstö on tässä hakemistossa. HY:n visuaalisen ilmeen edellyttämä yhteinen XHTML:stä HTML:ää tekevä säännöstö on versioittain alihakemistoissa, esim. /web/ling/util/XSL/hy-1.01/. Eri alisivustot voivat toimia erilaisella HY-versiolla (jotta yleisen säännöstön muuttaminen ei tärväisi vaivihkaa isoja osia sivustoista). Näihin hakemistoihin ei maailman oikeuksilla ole pääsyä eikä lukuoikeutta.