1. RSS-syötteet

RSS-syötteillä on mahdollista julkaista usein päivittyvää tietoa helposti esimerkiksi kotisivuillaan. Asio-Datan RSS-syötetyökalu tarjoaa mahdollisuuden muodostaa RSS-syöte lyhytkurssi- tai tilavarausohjelmiston tapahtumista, kuten alkavista kursseista tai lähiaikojen tilaisuuksista. Syötteisiin on lisäksi mahdollista sisällyttää suora linkki ilmoittautumislomakkeelle. Muodostetun syötteen sisällön ja näkymisajankohdan voi itse määrittää.

1.1 Syötteiden sisältö

Syötteet koostuvat lyhytkurssi- tai tilavarauspuolen tapahtumista. Kustakin tapahtumasta voidaan valita näytettävät tiedot syötteeseen käyttämällä yksinkertaista merkkauskieltä, josta kerrotaan enemmän osiossa 2.5 Syötteessä listattavat tiedot. Tyypillisiä tapahtumista listattavia tietoja ovat esimerkiksi nimi, ajankohta, kuvaus ja hinta.

1.2 Syötteiden osoitteet

Muodostetun syötteen sisällön pääsee kuka tahansa näkemään menemällä syötteen URL-osoitteeseen. Kuitenkin vain kirjautuneet käyttäjät pääsevät näkemään ja muokkaamaan syötteiden asetuksia.

Osoitteiden perään on myös mahdollista lisätä lyhyt kuvaus syötteen sisällöstä. Esimerkiksi syksyn 2010 rakennustekniikan kurssit listaavan syötteen osoitteen https://asp.asio.fi/lyhytkurssi/feed.php/view/rss/12/course/rakennustekniikka/ viimeinen sana rakennustekniikka antaa käyttäjälle selkeän kuvan syötteen sisällöstä.

2. Syötetökalun ominaisuudet

2.1 Näkyvyys päävalikossa

Käyttäjä, jolle on annettu oikeus RSS-syötteiden ylläpitoon, näkee lyhytkurssiohjelmiston päävalikossaan kohdan RSS-syötteet. Tästä klikkaamalla avautuu ohjelman aloitusruutu uuteen ikkunaan.

Kuva 1. RSS-syötteet päävalikossa

2.2 Ohjelman aloitusruutu

Ohjelman aloitusruudusta voit joko perustaa uuden syötteen tai listata olemassaolevat.

Kuva 2. Aloitusruutu

2.3 Syötteiden listaus

Klikkaamalla syötteen muokkausruudun yläpalkissa näkyvää << Listaukseen -nappia ohjelma listaa tietokantaan tallennetut RSS-syötteet. Klikkaamalla syötteen nimeä aukeaa kyseisen syötteen muokkausikkuna.

Kuva 3. Syötelistaus

2.4 Syötteen tiedot

Syötteen tärkeimpiin parametreihin kuuluvat:

Syötteen nimi on näkyy lukuohjelmassa syötteen otsikkona. Syötteen nimenä voisi olla esimerkiksi "Asio-Datan kurssitarjonta syksylle 2010" tai muu syötteen sisältöä kuvaava teksti.

Syötteen kuvaus näkyy myös lukuohjelmassa ja sen on tarkoitus antaa hieman tarkempi kuvaus syötteen sisällöstä. Esimerkiksi "Asio-Datan avoimen yliopiston kurssit syksylle 2010. Katso myös muut lyhytkursimme."

Syötteen sisäinen kuvaus näkyy ainoastaan syötteiden ylläpitäjille. Kenttä on tarkoitettu helpottamaan syötteiden erottamista toisistaan ja siihen voi kirjoittaa lyhyen vapaamuotoisen kuvauksen syötteestä, joka näkyy syötteiden listauksessa.

Tunniste-kenttään voi laittaa tekstin, joka lisätään syötteen URL-osoitteeseen. Kentän tarkoitus on tehdä osoitteesta ihmisille helpommin luettava. Esimerkiksi arvo "avoin", joka kuvaa aiemmin mainittua "Asio-Datan avoimen yliopiston kurssitarjonta" -syötettä, lisättäisiin syötteen osoitteen loppuun ja lopullinen URL-osoite voisi tässä tapauksessa olla esimerkiksi http://palvelin/lyhytkurssi/feed.php/view/rss/12/course/avoin/

Syötteen näkyvyysmääreisiin kuuluvat kentät syöte käytössä, alkupäivämäärä ja loppupäivämäärä. Näistä ensin mainittu mahdollistaa syötteen piilottamisen käyttäjiltä ja kaksi jälkimmäistä kertovat millä aikavälillä syöte on julkinen. Mikäli Syöte käytössä -kentässä ei ole ruksia ei syöte näy ulkopuolisille lainkaan.

Kuva 4. Syötteen tiedot

2.5 Syötteessä listattavat tiedot

Syötteessä näkyvillä kursseilla on olennaisesti 2 muokattavissa olevaa osaa:

  • otsikko ja
  • kuvaus.

Kumpaankin voi sisällyttää sekä staattista tekstiä tai tietokannasta haettua kurssikohtaista tietoa. Ohjelma osaa erottaa normaalin tekstin tietokannasta haettavasta datasta risuaitamerkkien avulla. Mikäli sanan ensimmäinen ja viimeinen merkki on # ja ohjelma osaa yhdistää risuaitojen välissä olevan merkkijonon tietokantakenttään, korvautuu sana kyseisestä tietokantakentästä haetulla tekstillä.

Esimerkiksi teksti "Kurssi #nimi# alkaa #apvm# ja loppuu #lpvm#." voisi näkyä syötteessä muodossa "Kurssi Analoginen säätö alkaa 1.1.2010 ja loppuu 28.3.2010". Esimerkissä sanat #nimi#, #apvm# ja #lpvm# korvattiin kurssin tiedoista löytyvällä nimellä, alkamispäivällä ja päättymispäivällä. Kattava lista ohjelman tunnistamista tietokantakoodeista löytyy syötetyökalun ohjeesta ja tämän dokumentin lopusta.

2.6 Syötteeseen sovellettavat rajaukset

Syötteeseen haetaan kaikki kurssit, jotka täyttävät annetut hakuehdot. Rajaavina tietoina voi käyttää suurinta osaa kurssitietojen ylläpidosta löytyvistä kentistä.

Rajattaviin kenttiin voidaan soveltaa 4 erilaista vertailuoperaatiota:

  • Yhtä suuri ==
  • Pienempi kuin <
  • Suurempi kuin >
  • Sisältää %

Näistä ensimmäinen (==) on tarkoitettu lähinnä kategorisen tiedon, kuten kurssityypin tai -kategorian rajaamiseen. Kaksi seuraavaa vertailuoperaatiota (<, >) soveltuvat päivämäärien, kuten kurssien alkamis- tai päättymisajankohtien, vertailuun. Viimeinen (%) on tarkoitettu tekstikenttien vertailuun. Tämä operaattori rajaa tekstikentät mikäli parametrina annettu arvo löytyy tekstin sisältä. Syötteeseen voidaan rajata esimerkiksi kurssit, joiden nimestä löytyy sana "matematiikka".

Kuva 5. Syötteessä listattavat tiedot ja syötteeseen sovellettavat rajaukset

3. Esimerkkejä

3.1 Rakennustekniikan opinnot

Rss

A. RSS-syötetyökalun tunnistamat tietokantakoodit

Voit muotoilla syötteen otsikot ja kuvaukset halutun kaltaisiksi kirjoittamalla tekstikenttään haluamasi muotoilutekstin. Kenttiin voi sisällyttää kenttiä kurssin tiedoista ympäröimällä ne risuaitoihin (#). Ohjelma esimerkiksi korvaa tekstin #nimi# kurssin nimellä. Järjestelmän tunnistamat muotoilutekstit: