Luetus-julkaisun tuottaminen risukoodaamalla
Sisällys
- Lukijalle
- Risukoodaus
- Tiedostomuoto
- Julkaisun rakenteen merkitseminen
- Otsikot
- Ingressi ja leipätekstikappaleet
- Lyhytriviset elementit, kuten runot, listat
- Osion vaihto
- Valmiiksi muotoillut elementit
- Esimerkki risukoodatun julkaisun rakenteesta
Lukijalle
Tämä ohje on sinulle, joka tuotat aineistoa Näkövammaisten liiton Luetus-palveluun. Tekstitiedostoon viety julkaisu ns. ”risukoodataan” ja lähetetään Minna-järjestelmään.
Risukoodaus
Risukoodauksella tarkoitetaan julkaisun rakenteen merkitsemistä käyttäen risu(#)-merkkiä otsikkotasojen merkitsemiseen. Risukoodauksessa on käytössä myös muita erikoismerkkejä erilaisten rakenteiden ja elementtien merkitsemiseksi.
Lähetettyäsi aineiston, Minna-järjestelmä tekee vastaanotetulle tiedostolle aina seuraavat toimet:
- Rivien aluista ja lopuista poistetaan sisennykset
- Elementtien sisältä poistetaan sarkainmerkit, yhtä useammat välilyönnit ja rivinvaihdot
- Elementtien välistä poistetaan kahta useammat rivinvaihdot.
Ohjeen lopussa on esimerkki tekstistä, johon on rakenne merkitty ns. risukoodauksen avulla.
Tiedostomuoto
Minna-järjestelmään lähetettävän tiedoston muoto tulee olla txt ja merkistö Unicode UTF-8.
Julkaisun rakenteen merkitseminen
Käytettävissä olevat rakenne-elementit.
Ns. risukoodauksella voi merkitä
- Otsikoita ja väliotsikoita
- Ingressejä
- Osion vaihtoja
- Lyhytrivisiä luettelo- tai runoelementtejä
- Valmiiksi muotoiltuja osioita, joiden muotoilu halutaan säilyttää julkaisussa.
Erota elementit yhdellä näkyvällä tyhjällä rivillä eli kappaleet päättyvät kahteen rivinvaihtoon (=Enterin painallukseen) paitsi osionvaihdoissa.
Otsikot
Merkitse julkaisun otsikot risumerkeillä (#). Risun ja otsikon väliin ei saa jäädä välilyöntiä. Kirjoita otsikosta kertova risumerkki rivin ensimmäiseksi merkiksi. Risumerkkien määrä kertoo otsikkotason. Merkitse ensimmäisen tason otsikot (=pääotsikko) yhdellä risumerkillä, toisen tason otsikot (=alaotsikot) kahdella risumerkillä jne.
Esimerkki:
#Lemmikkieläimet
##Kissat
###Rotukissat
Otsikon jälkeen tarvitaan yksi tyhjä rivi eli kaksi Enterin painallusta. Tyhjän rivin jälkeen alkava teksti on leipätekstiä, ellei rivin alussa ole jotain rakennetta osoittavaa merkkiä.
Esimerkki:
###Rotukissat
Rotukissoja on sekä lyhyt- että pitkäkarvaisia. Molempia…
Jos otsikon teksti alkaa #-merkillä (esimerkiksi: #Saavuta 2024 -seminaari), pitää säilytettävä risumerkki ympäröidä pienempi kuin (<)- ja suurempi kuin (>) merkeillä, jotta Minna-järjestelmä ei tulkitse risua otsikkotason merkinnäksi.
Esimerkki, jossa #Saavuta 2024 -seminaari on tason 2 otsikko.
##<#>Saavuta 2024 -seminaari
Merkitse väliotsikot aloittamalla rivi dollarimerkillä ($). Väliotsikon jälkeen lisää yksi tyhjä rivi eli kaksi Enterin painallusta.
Ingressi ja leipätekstikappaleet
Merkitse ingressi aloittamalla rivi prosenttimerkillä (%). Ingressikappaleen jälkeen lisää yksi tyhjä rivi eli kaksi Enterin painallusta. Aloita leipätekstikappale ilman ohjaavia merkkejä (#, %, $ ja |).
Esimerkki:
#Lemmikit
%Tähän julkaisuun on kerätty kattava esittely erilaisista lemmikkieläimistä.
Lemmikit-kirja täydentää aiemmin ilmestynyttä kirjasarjaa…
Lyhytriviset elementit, kuten runot, listat
Jos halutaan, että runot tai sisällys- muut luettelot säilyttävät alkuperäisen rivityksen, aloita jokainen ennalleen jätettävä rivi pystyviivalla (|). Ellei rivin alussa ole pystyviivaa, Minna-järjestelmä poistaa elementin sisältä rivinsiirrot.
Esimerkki:
|Aurinko, aurinko lättyjä paistaa.
|Hauska on auringon lättyjä maistaa!
|Pistelen suuhun,
|kiipeän puuhun.
|Loput heitän ukolle kuuhun.
Osion vaihto
Esimerkiksi kirjoissa on toisinaan osion vaihtoja. Ne ovat tyypillisesti jonkin tilanteen tai tunnelman vaihtuminen ilman, että luku vaihtuu. Erota nämä osiot toisistaan merkinnällä <ov>. Tee merkintä omalle rivilleen. Lopullisessa julkaisussa osion vaihto näkyy tyhjien rivien välissä kolmena ajatusviivana.
Esimerkki:
Maaseudun rauhan rikkoi vain kaisloja suhisuttava tuulen vire. Vene keinui laiturissa laineiden liplatellessa rantakiviin.
<ov>
Kaupungin hälinässä nainen kiiruhti puristaen tiukasti käsilaukkuaan kainalossaan. Märkä tie kiilteli neonvalojen loisteessa.
Valmiiksi muotoillut elementit
<Pre>-alku- ja loppumerkin </pre> välisen tekstin Minna-järjestelmä säilyttää sellaisenaan.
Esimerkki risukoodatun julkaisun rakenteesta
#Kissan hoito (ensimmäisen tason otsikko)
##Yleistä (toisen tason otsikko)
%Tämä opas on kirjoitettu kaikille kissojen ystäville. Oppaassa on tietoa kissojen hoidosta ja niiden ruokinnasta. (Tämä kappale on merkitty ingressiksi).
Kissa on ihmisen paras kaveri. Hoida sen turkkia hyvin, huolehdi sen monipuolisesta ruokinnasta, ja anna sille rakkautta. Saat rakkauden moninkertaisena takaisin. (Tämä kappale alkoi tyhjän rivin jälkeen ilman erityisiä ohjausmerkkejä eli tämä oli tavallinen leipätekstikappale).
$Runo kissalle (väliotsikko)
|Kuin rukki kissa hyrisee
|kaiken hoivan se ansaitsee.
|Hoida hellästi ystävää
|se vuosiksi silloin viereesi jää.
## Turkki (toisen tason otsikko)
###Kampaaminen (kolmannen tason otsikko)
Kissan turkki on hyvä kammata säännöllisesti. (Leipätekstiä).
###Peseminen (kolmannen tason otsikko)
Vaikka kissa on erittäin siisti eläin ja huolehtii hyvin oman turkkinsa siisteydestä, voi kissan kuitenkin välillä pestä kissoille tarkoitetulla shampoolla. (Leipätekstiä).
# Loppusanat (ensimmäisen tason otsikko)
Tässä ovat esimerkkitekstin loppusanat leipätekstikappaleena. Tämän esimerkin perusrakenteilla saa tehtyä jo hyvän julkaisun.