Oppimapin sisällön tuotannon vinkkejä

Normaalin tekstin muotoiluohjeet

Thu, 20 Dec 2007 15:21:00 +0200

Oppimappi muotoilee tavallisen tekstin pääasiassa rivinvaihtojen perusteella. Sisältöä kirjoitettaessa rivitys tapahtuu automaattisesti yksittäisen kappaleen sisällä. Kappaleväli tunnistetaan kahdesta peräkkäisestä rivinvaihdosta. Yksittäistä rivinvaihtoa voi puolestaan käyttää esimerkiksi runon eri rivien erottamiseen toisistaan. Tekstin sisällä olevat www-osoitteet (URL) muutetaan linkeiksi automaattisesti.

Tähtimerkkiä (*) käytetään tekstin korostamiseen, listojen tekemiseen ja pienten väliotsikoiden tekemiseen. Merkkiä käytetään välilyönnin ja sanan alun välissä osoittamaan korostuksen alkua ja sanan viimeisen kirjaimen ja välilyönnin välissä osoittamaan korostuksen loppua. Listan tekemiseksi jokainen listan kohta kirjoitetaan omalle rivilleen siten, että rivin ensimmäinen merkki on tähti ja viimeinen merkki on jokin muu. Väliotsikoissa taas käytetään tähteä rivin ensimmäisenä ja viimeisenä merkkinä.

Vastaavasti "risuaita"-merkkiä (#) käytetään numeroidun listan tekemiseen.

Viimeisenä tavallisessa tekstissä käytettynä tehokeinona voi kirjoittaa tekstiä putkimerkkien (|) väliin, jolloin se näytetään tasalevyisellä tekstillä. Esimerkiksi ATK-kurssilla esimerkkisyöte voitaisiin esittää tällä tavoin. Putkimerkki löytyy suomalaisessa näppäimistöstä yleensä z-kirjaimen lähellä samasta näppäimestä kuin pienempi kuin -merkkikin. Paina näppäintä yhdessä AltGr-näppäimen kanssa.

Oppimapissa kaikissa kuvaus ja sisältökentissä voi myös viitata muihin Oppimapin dokumentteihin. Viittaaminen toimii dokumenttien viitenumeroiden perusteella. Oppimapissa näkee aina sillä hetkellä olevan dokumentin viitenumeron otsikkopalkin lopussa kaksien hakasulkujen sisällä. Esimerkiksi [[252]] tarkoittaisi, että dokumentin viitenumero on 252. Sijoittamalla tämä viitenumero kahden hakasulun sisään tekstikenttään muodostetaan viittaus toiseen dokumenttiin. Jos viitattu dokumentti on kuva, näytetään se viittauksen kohdalla. Jos viitattu dokumentti on esimerkiksi tekstidokumentti tai palautuskansio, näytetään viittauksen kohdalla dokumentin nimi (joka päivittyy automaattisesti, jos viittauksen kohdetta muutetaan) ja linkki viitattuun dokumenttiin. Jos viitattuun dokumenttiin ei ole tarvittavia oikeuksia tai se on poistettu näytetään viittauksen tilalla vain viittauksessa käytetty merkkijon, esimerkiksi [[252]]. Jos kuvaan halutaan viitata siten, että sitä ei suoraan näytetä viittauksen tilalla, voidaan numeron ja hakasulkujen väliin laittaa huutomerkki (!) osoittamaan, että halutaan todellakin pelkkä viittaus. Esimerkiksi [[252!]].

Tekstin sekaan voi kirjoittaa "punakynämerkintöjä" tai "reunahuomautuksia" käyttämällä merkintää [[!:punakynällä kirjoitettu teksti]] tai [[!!:reunahuomautuksen teksti tässä]]. Osa selaimista piirtää reunahuomautuksen yhtä riviä alemmaksi kuin missä merkintä on itse sivun sisällä. Jos lukijan www-selain ei osaa muuttaa tekstin väriä tai sijaintia niin yleensä "punakynällä" kirjoitettu teksti näkyy kursivoituna tai alleviivattuna ja "reunahuomautus" lihavoituna tai eri värillä kuin leipäteksti.

Muita käytettävissä olevia muotoilumerkintöjä:

[[<:tekstiä]]: Tekee korjausmerkinnän, jossa sana "tekstiä" on alleviivattu punaisella ja sanan yhteydessä on nuoli vasemmalle
[[>:tekstiä]]: Tekee korjausmerkinnän, jossa sana "tekstiä" on alleviivattu punaisella ja sanan yhteydessä on nuoli oikealle
[[..:tekstiä]]: Tekee korjausmerkinnän, jossa sana "tekstiä" on alleviivattu punaisella katkoviivalla
" tekstiä tekstiä: Tekee kappalelainauksen. Lainaus jatkuu seuraavaan kappaleväliin asti (kaksi peräkkäistä rivinvaihtoa). Huomaa välilyönti lainausmerkin jälkeen. Lainausmerkin tulee olla rivin ensimmäinen merkki.
! tekstiä tekstiä: Tekee "infolaatikon". Tiedotteen teksti jatkuu seuraavaan kappaleväliin asti (kaksi peräkkäistä rivinvaihtoa)
!! tekstiä tekstiä: Tekee "varoituslaatikon". Varoituksen teksti jatkuu seuraavaan kappaleväliin asti (kaksi peräkkäistä rivinvaihtoa)

Esimerkiksi kun tekstikenttään kirjoitetaan

Tekstiä tekstiä tekstiä tekstiä http://peda.net/ ja www.peda.net tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. Tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. [rivinvaihto tässä:] Tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. Tekstiä *[[!!:reunahuomautus tähden kohdalla]]tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. [[!:punakynää tässä]] Tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. *Väliotsikko* * listan ensimmäinen kohta * listan toinen kohta * listan kolmas kohta *Toinen väliotsikko* # numeroidun listan ensimmäinen kohta, # numeroidun listan toinen kohta - huomaa, että tämä teksti voi olla pitkäkin ja se voi sisältää *korostettuja* sanoja, # ja kolmas kohta Vastaavasti voidaan kirjoittaa esimerkiksi |pascal|-ohjelmointikielen rakenteista; esimerkiksi |procedure|-avainsanan avulla voidaan määritellä apuohjelmia. Kuva: [[525]] tai pelkästään suora linkki siihen [[525!]]. Katso lisäohjeita dokumentista [[252]].

niin Oppimappi näyttää tuloksena seuraavaa:

Tekstiä tekstiä tekstiä tekstiä http://peda.net/ ja www.peda.net tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä.

Tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. [rivinvaihto tässä:]
Tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä.

Tekstiä *reunahuomautus tähden kohdallatekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä. punakynää tässä Tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä tekstiä.

Väliotsikko

listan ensimmäinen kohta

listan toinen kohta

listan kolmas kohta

Toinen väliotsikko

numeroidun listan ensimmäinen kohta,

numeroidun listan toinen kohta - huomaa, että tämä teksti voi olla pitkäkin ja se voi sisältää korostettuja sanoja,

ja kolmas kohta

Vastaavasti voidaan kirjoittaa esimerkiksi pascal-ohjelmointikielen rakenteista; esimerkiksi procedure-avainsanan avulla voidaan määritellä apuohjelmia.

Kuva: tai pelkästään suora linkki siihen kukka.png.

Katso lisäohjeita dokumentista Oppimappi-ohjeita.

Automaattista muotoilua ei käytetä, jos Oppimappi tunnistaa, että sivu on kirjoitettu HTML-kielellä. Esimerkiksi yksikin kappaleen aloitusmerkki "<p>" riittää pakottamaan automaattisen muotoilun pois päältä. Jos kirjoitat itse sivun sisältöä HTML-kielellä, tulee merkkauksen olla XHTML-yhteensopivaa; Esimerkiksi jokaista kappaleen aloittavaa merkkiä "<p>" kohden pitää löytyä lopetusmerkki "</p>". Jos näin ei ole, Oppimappi antaa virheilmoituksen lukijalle. Samoin IMG-elementistä täytyy käyttää XHTML-yhteensopivaa muotoa "<img src="kuvan osoite" />"

Jos haluat kirjoittaa jonkin Oppimapin käyttämän erikoismerkin tekstin sisällöksi, sinun tulee käyttää merkkiviittausta. Lista Oppimapin käyttämistä erikoismerkeistä ja niitä vastaavat merkkiviittaukset:

Merkki	Merkkiviittaus
*	`*`
\|	`\|`
[	`[`
]	`]`
$	`$`

Matemaattisten merkintöjen ohjeet

Thu, 26 Feb 2009 12:02:00 +0200

Oppimapissa voi kirjoittaa matemaattisia merkintöjä mihin tahansa, missä Oppimappi tekee automaattisen muotoilun normaalille tekstillekin. Käytännössä tämä tarkoittaa pääasiassa kuvauskenttiä, sisältötekstiä ja keskusteluviestejä.

Matemaattisiin merkintöihin voi käyttää joko suoraan MathML-koodia, joka on etäisesti sukua HTML-kielelle tai Peda.net:n käyttämää yksinkertaistettua tekstimerkkausta, joka käännetään automaattisesti MathML-kieliseksi kaavaksi. Jos Oppimappi tunnistaa, että selain ei osaa näyttää MathML-koodia, se näyttää kaavan kuvana. Tämän etuna on, että kaavan voi aina nähdä, jos selain voi näyttää kuvia. Haittapuolena puolestaan on, että kaavassa olevan tekstin kokoa ei voi muuttaa isommaksi, jos teksti tuntuu liian pieneltä. Ylläpidon puolelta löytyvästä "Omat asetukset"-toiminnosta löytyy asetus, jolla ohitetaan automaattinen selaimen tunnistus sen varalta, että tunnistus menee joskus väärin (www-selain voi esimerkiksi osata näyttää MathML-koodia, mutta tietokoneeseen ei ole asennettu kaikkia tarvittavia fontteja tekstin näyttämiseen - esimerkiksi neliöjuuren merkki voi puuttua).

Oppimapissa käyttää matemaattisen merkkauksen aloitusmerkkinä joko pelkkää dollarin merkkiä $ tai merkkiyhdistelmää vasen hakasulku ja dollarimerkki [$. Näistä edellistä käytetään tekstin sisällä olevan matemaattisen merkinnän kirjoittamiseen ja jälkimmäistä isommille kaavoille, jotka halutaan näyttää omana rivinään. Lopetusmerkki on vastaavasti dollari $ tai dollari ja oikea hakasulku $]. Itse kaavat muodostuvat kirjaimista, jotka esittävät muuttujia, numeroista, merkkitunnisteista, jotka alkavat &-merkillä ja loppuvat ;-merkkiin sekä suluista. Eri merkeistä muodostuvia tunnisteita erotetaan toisistaan välilyönneillä tai muilla "tyhjillä" välimerkeillä (esim. rivinvaihto on ok). Eri asioiden ryhmittelyyn käytetään tavallisia kaarisulkeita ( ja ). Muut sulkumerkit, kuten [, ], { ja } tulkitaan kaavoissa tavallisten merkkien tapaan.

Esimerkiksi, jos tekstikenttään kirjoitetaan:

Yhtälön $ x + 2 = 3 $ ratkaisu on $x = 1$.

niin Oppimappi näyttää

Yhtälön ratkaisu on .

Monimutkaisemmat kaavat esitetään samaan tapaan kuin kehittyineissä taskulaskimissa. Kaavat muodostetaan suluilla rajoitetuista lauseista yhdistävien merkkien avulla:

_ (alaviiva): Esittää alaindeksin alkua
^: Esittää yläindeksin tai eksponentin alkua
/ (kauttaviiva): Esittää jakoviivaa
// (kaksi kauttaviivaa): Esittää vinoa jakoviivaa
* (tähti): Esittää kertomerkkiä (esitetään miinus-merkin korkeudella olevalla pisteellä)
** (tähti*2): viisisakarainen tähti
*** (tähti*3): rasti (neljä sakaraa)
∫: integraalimerkki
∑: summamerkki
⁢: näkymätön kertomerkki (pieni väli)
&inf;: äärettömän merkki
&alfa;: Kreikkalainen kirjain alfa (pienaakkonen)
&Alfa;: Kreikkalainen kirjain alfa (suuraakkonen)
<=>: Jos ja vain jos -merkki
<=: Jos -merkki
->: Nuoli oikealle
=<: Pienempi tai yhtäsuuri
>=: Suurempi tai yhtäsuuri
!=: Erisuuri
~~: Likimäärin-merkki
<<: Vasen kulmasulku (korkeampi kuin pienempi kuin -merkki)
∅: Tyhjä-merkki (O ja / päällekkäin)
A ⊂ B: A on B:n osajoukko
A &nsub; B: A ei ole B:n osajoukko
A ⊃ B: A on B:n sisältävä joukko
A &nsup; B: A ei ole B:n sisältävä joukko
A ∪ B &union; C: A yhdiste B yhdiste C (kaksi eri merkintää)
A ∩ B &intsec; C: A leikkaus B leikkaus C (kaksi eri merkintää)
A &setminus; B: A:sta poistettuna B
a &in; B: a on B:n alkio
a ∉ B: a ei ole B:n alkio
A &ni; b: A:n alkio b
A &notni; b: A:han ei sisälly alkio b
∀: kaikille
∃: on olemassa
&R;: kaksoisviivalla piirretty iso R (käytetään yleensä esittämään reaalilukujen joukkoa)

Kaikkia MathML-kielessä määriteltyjä merkkejä voi käyttää. Merkin alussa on aina "&" ja lopussa ";". Väärin kirjoitetut tai tunnistamattomat merkit näytetään sellaisenaan. Jos samalle merkille on olemassa useita nimiä, tulee niistä käyttää versiota, joka on kirjoitettu kokonaan pienillä kirjaimilla ja on lyhin.

Esimerkiksi x:n toinen potenssi esitetään muodossa $ x^2 $ ja n+1:n käänteisluku voidaan esittää muodossa $ (n+1)^(-1) $ tai $ 1/(n+1) $ . Jos tarvitaan samaan aikaan ala- ja yläindeksiä, kuten esimerkiksi integraalin tapauksessa, kirjoitetaan alaindeksi ensin. Esimerkiksi $ ∫_a^b 1/x d x $ . Tässä ∫ tarkoittaa integraalimerkkiä, _a^b tarkoittaa integrointiväliä a:sta b:hen ja 1/x on integroitava lauseke. Monimutkaisemmassa integrointivälissä pitäisi käyttää sulkuja; esimerkiksi 2:n mittainen väli a:n ympärillä esitettäisiin muodossa _(a-1)^(a+1).

Näiden lisäksi voidaan esittää esimerkiksi 2:n neliöjuuri $ sqrt(2) $ tai piin n:s juuri $ root(n)(π) $ . Vastaavasti voidaan esittää 2x2 matriisi $ [ mat2 ((a)(b)) ((c)(d)) ] $ .

Monimutkaisempi esimerkki, kuten

*Toisen asteen yhtälön $ a x^2 + b x + c = 0$ ratkaisut* ovat [$ x_(1,2) = (-b +- sqrt(b^2-4 a c)) / (2 a) $] *Standardinormaalijakauman tiheysfuntio* on [$ φ(x) = 1 / (sqrt(2 π)) ⁢ e ^ ((-x^2) // 2), x &in; &R; $] *Standardinormaalijakauman kertymäfunktio* on [$ Φ(x) = ∫_(-&inf;)^x 1 / (sqrt(2 π)) ⁢ e^((-t^2) // 2) d t $]

näytettäisiin oppimapissa muodossa

Toisen asteen yhtälön ratkaisut ovat

Standardinormaalijakauman tiheysfuntio on

Standardinormaalijakauman kertymäfunktio on

Jos matemaattisia merkintöjä yhdistetään automaattiseen tekstin muotoiluun, niin matemaattiset kaavat tulkitaan ennen automaattista tekstin muotoilua.

Merkki	Merkkiviittaus
*	*
[	[
]	]
$	$

Lomake-työkalun muotoilukoodit

Fri, 13 Apr 2012 13:59:00 +0300

Oppimapissa lomakkeet koodataan pelkkää tekstiä kirjoittamalla. Peruslähtökohtana on kirjoittaa sisältöä vastaavasti kuin normaalin tekstinkin muotoilussa. Lisäksi Lomake-työvälineessä voi käyttää lomakekenttiä, jotka koodataan hieman samaan tapaan kuin normaalin tekstin sisällä olevat viittauksetkin. Tämä ohje tulee tulkita laajennuksena normaalin teksin muotoilun ohjeisiin ja kaikki normaalit tekstin muotoilun toiminnot ovat käytettävissä, jos alla ei toisin mainita.

Kaikki lomakekentät koodataan merkinnöillä, jotka ovat muotoa [[{kentän tyyppi}{lisävalintoja}]]. Esimerkiksi [[_____]] on lyhyt tekstikenttä, jossa ei oletuksena lue mitään. Tuettuja kenttätyyppejä ovat seuraavat:

[[_]]: Tekstikenttä, joka on koko rivin mittainen.
[[______]]: Tekstikenttä, joka on yhtä monen merkin mittainen, kuin merkinnässä on alaviivoja (yhden merkin mittaista tekstikenttää ei voi tehdä).
[[_:h=5]]: Monirivinen tekstikenttä, jossa on niin monta riviä, kuin lisävalinta h määrittää.
[[x]]: Valintaruutu ("rasti ruutuun laatikko"), jonka käyttäjä voi halutessaan rastittaa.
[[o]]: Radiopainike ("pyöreä täppä"-nappula), joissa yhdestä painikeryhmästä voi valita aina vain yhden valinnan. Ensimmäinen ryhmän painike on oletuksena valittu.
[[_:v=vastaus1|vastaus2:s=1:t=vinkkiteksti]]: Aukkotehtävä, jonka koko määräytyy sen oikean vastauksen merkkien mukaan, joka sisältää eniten merkkejä. vastauksen perusteella. Mahdolliset oikeat vastaukset määritellään lisävalinnalla v ja jos kenttään kelpaa usea eri vastaus, niin eri vaihtoehdot erotellaan putkimerkillä |. Lisävalinnalla s voidaan määritellä oikeasta vastauksesta annettava pistemäärä ja lisävalinnalla t voidaan määritellä vikkiteksti, jolla voidaan antaa käyttäjälle vihjettä oikeasta vastauksesta. Jos väärästä vastauksesta halutaan antaa jokin (esimerkiksi negatiivinen) pistämäärä, niin se voidaan määritellä lisävalinnalla u. Lisävalintoja ei tarvitse käyttää, jos vihjettä tai pistemääriä ei ole tarvetta käyttää. Aukkotehtävässä minimissään on vain kooodi [[_:v=oikea vastaus]].
=== väliotsikon teksti: Tämä merkintä aloittaa uuden osan lomaketta, jossa osuuden otsikoksi tulee "väliotsikon teksti". Tämä merkintä tulee aloittaa rivin alusta.

Lisäksi on mahdollista tehdä Likert-kyselylomake käyttämällä seuraavaa koodausta:

[[likert:5]] Väittämän 1 teksti Väittämän 2 teksti Väittämän 3 teksti [[/likert]]

Tällöin muodostuu Likert-kyselylomake (tai kenttä), jossa on kolme väittämää, joissa on kussakin 5 vaihtoehtoa ja oletuksena on aina valittuna keskimmäinen valinta. Lomaketta, jossa mikään valinnoista ei ole valmiiksi valittu ei ole mahdollista tehdä. Kenttien lisävalinnat kirjoitetaan kentän tunnuksen jälkeen käyttäen ensin erotinmerkkiä (kaksoispiste, :) ja tämän jälkeen lisävalinnan tunnistekirjain ja välittömästi sen jälkeen yhtäsuuruusmerkki (=) ja sen jälkeen lisävalinnan arvo. Mahdolliset lisävalinnat:

v: Tekstikentässä oikea vastaus (aukkotehtävä)
w: Tekstikentän leveys merkkeinä (jos tekstikentän koko on määritelty sekä alaviivojen lukumäärällä, että lisävalinnalla w niin käytetään lisävalinnan arvoa.
h: Tekstikentän oletuskorkeus merkeissä. Joissakin selaimissa käyttäjä voi muuttaa tekstikentän korkeutta itse.
s: Oikeasta vastauksesta annettava pistämäärä, jos kyseessä on aukkotehtävä, tai valinnasta annettava pistemäärä, jos kyse on valintaruudusta tai radiopainikkeesta.
u: Väärästä vastauksesta annettava pistämäärä, jos kyseessä on aukkotehtävä, tai valinnan puuttumisesta annettava pistemäärä, jos kyse on valintaruudusta tai radiopainikkeesta.
p: Tekstikentän oletusarvo kun lomakkeelle saavutaan. Tässä voidaan käyttää haluttaessa kahta erikoisarvoa $name tai $time, jos halutaan esitäyttää tekstikenttään kirjautuneen käyttäjän nimi tai lomakkeen avaushetken kellonaika.
t: Tekstikentässä käyttäjälle näytettävän vihjeen teksti. Vihje tulee näkyviin, kun kentän perään ilmestyvää pientä vihreää kysymysmerkkiä osoitetaan hiiren kursorilla. Kaikki selaimet eivät välttämättä kykene näyttämään vihjetekstiä.

Merkki	Merkkiviittaus
*	`*`
\|	`\|`
[	`[`
]	`]`
$	`$`