Ensimmäinen versio
This commit is contained in:
commit
6ee186221b
62
README.md
Normal file
62
README.md
Normal file
@ -0,0 +1,62 @@
|
||||
# Testitiedotteet
|
||||
|
||||
Tähän tietovarantoon voi lisätä tiedotteita tiedotejärjestelmän testaamista
|
||||
varten. Tiedotetiedoston voi lisätä mihin tahansa hakemistoon millä tahansa
|
||||
nimellä, mutta sen tulee olla muotoiltu
|
||||
[markdownina](https://commonmark.org/help/) (tosin siinä voi käyttää
|
||||
[pandocin](https://pandoc.org/MANUAL.html#pandocs-markdown)
|
||||
oletuslaajennuksia). Markdown-tiedostot päättyvät yleensä `.md`, joten
|
||||
tiedotetiedostoille kannattaa käyttää samaa päätettä.
|
||||
|
||||
Tiedotetiedoston tulee alkaa metadatalohkolla, joka määrittää mm. lähetysajan,
|
||||
tiedotteen otsikon ja muotoilun tarkistajan. Metadatalohko alkaa ja päättyy
|
||||
kolmeen tavuviivaan (`-`) eikä sen sisällä saa olla tyhjiä rivejä. Esimerkiksi:
|
||||
|
||||
```yaml
|
||||
---
|
||||
otsikko: OMS-testitiedote 1
|
||||
deadline: 2023-08-06T00:00:00+03:00
|
||||
lähetysaika: 2023-08-07T10:00:00+03:00
|
||||
tarkistaja: saku.laesvuori@mail.olarinmaensamoojat.fi
|
||||
---
|
||||
```
|
||||
|
||||
Aikaleimat `deadline` ja `lähetysaika` on muotoiltava tarkasti tässä muodossa,
|
||||
eli `YYYY-MM-DDTHH:MM:SSAIKAERO`. Numeroiden määrän on täsmättävä, eli alussa
|
||||
olevia nollia ei voi jättää pois (esim. `2023-8-6T10:00:00+3:00` olisi väärin).
|
||||
Aikaero on annetun ajan vyöhykkeen ero UTC:hen, eli Suomessa kesäaikaan
|
||||
`+03:00` ja talviaikaan `+02:00`.
|
||||
|
||||
Tarkistajia voi olla useampia, jolloin ne merkataan omille riveilleen ja rivit
|
||||
aloitetaan tavuviivalla. Esimerkiksi:
|
||||
|
||||
```yaml
|
||||
tarkistaja:
|
||||
- saku.laesvuori@mail.olarinmaensamoojat.fi
|
||||
- saku@laesvuori.fi
|
||||
```
|
||||
|
||||
Kun deadline on ylittynyt, tiedotteesta lähetetään esikatseluversio
|
||||
sähköpostilla kaikille sen tarkistajille. Tarkistajat lukevat tiedotteen läpi
|
||||
ja tekevät tarvittaessa viimeiset muutokset. Deadlinen jälkeen tehdyistä
|
||||
muutoksista lähtee heti uusi esikatselu. Kun tiedote on valmis, tarkistaja
|
||||
vastaa esikatseluviestiin sähköpostilla, jossa on vastaanottajien
|
||||
sähköpostiosoitteet. Jokaisen sähköpostiosoitteen pitää olla yksin omalla
|
||||
rivillään normaalissa tekstissä. Mikäli et ole varma, lähettääkö
|
||||
sähköpostiohjelmasi viestit raakatekstinä vai HTML:nä, kannattaa sähköpostit
|
||||
laittaa viestiin tekstitiedostoliitteessä (`.txt`, wordin yms. dokumentit eivät
|
||||
ole tekstitiedostoja). Vastaanottajien lähettämisen jälkeen tiedote lähtee
|
||||
kaikille vastaanottajille *lähetysaikaan*. Vastaanottajat täytyy lähettää
|
||||
vastauksena uusimpaan esikatseluun; vanhempaan versioon vastaaminen ei tee
|
||||
mitään. Aiemmin lähetetyt vastaanottajat nollaantuvat, jos tiedotteeseen
|
||||
tehdään muutoksia ja siitä lähetetään uusi esikatselu. Tällöin vastaanottajat
|
||||
täytyy lähettää uudestaan vastauksena uuteen esikatseluun.
|
||||
|
||||
Jos tiedoteen *lähetysaika* ohittuu ilman, että sille on määritetty
|
||||
vastaanottajia, se vanhenee eikä siitä tule esikatseluita eikä sitä voi
|
||||
lähettää ennen kuin sen *lähetysaika* on uudelleen siirretty tulevaisuuteen.
|
||||
|
||||
Esimerkki kokonaisesta tiedotteesta löytyy tiedostosta
|
||||
[esimerkkitiedote.md](esimerkkitiedote.md).
|
||||
|
||||
Mikäli järjestelmän toiminnasta jää kysyttävää, voi siitä kysyä Sakulta.
|
61
esimerkkitiedote.md
Normal file
61
esimerkkitiedote.md
Normal file
@ -0,0 +1,61 @@
|
||||
---
|
||||
tarkistaja: saku@laesvuori.fi
|
||||
deadline: 1970-01-01T00:00:00+00:00
|
||||
lähetysaika: 2000-01-01T00:00:00+02:00
|
||||
otsikko: Esimerkkitiedote
|
||||
---
|
||||
|
||||
# Tämä tiedote on esimerkki
|
||||
|
||||
Sen sisältämällä tekstillä ei ole paljoakaan informaatioarvoa, vaan se toimii
|
||||
pääasiassa esimerkin muotoilun täytteenä.
|
||||
|
||||
# Tässä tiedotteessa on enemmän kuin yksi osio
|
||||
|
||||
Tekstiä voi painottaa ympäröimällä sen asterikseilla (`*`). Painotuksessa on
|
||||
kolme tasoa, *ensimmäinen*, **toinen**, ja ***kolmas***. *Ensimmäisen* tason
|
||||
painotuksessa on yksi asteriksi, **toisen** tason painotuksessa kaksi ja
|
||||
***kolmannen*** kolme.
|
||||
|
||||
## Joista toisessa on kaksi alaotsikkoa
|
||||
|
||||
- Tiedotteissa voi olla listoja
|
||||
- Numeroimaton lista alkaa jollain näistä merkeistä
|
||||
* `+`
|
||||
* `*`
|
||||
* `-`
|
||||
* Listassa voi olla alilistoja, jotka aloitetaan sisentämällä välilyönneillä
|
||||
* Ensimmäinen alilista
|
||||
+ Toinen alilista
|
||||
- Kolmas alilista
|
||||
- Listojen aloitusmerkillä ei ole teknisesti väliä, mutta hyvä tyyli
|
||||
edellyttää, että niitä käytetään johdonmukaisesti
|
||||
|
||||
## Toinen alaotsikoista on tässä
|
||||
|
||||
Linkkejä voi tehdä joko suoraan osoitteista kulmasuluilla (pienempi- ja
|
||||
suurempi kuin -merkit), kuten
|
||||
<https://git.olarinmaensamoojat.fi/OMS/tiedote-testi> ja <saku@laesvuori.fi>.
|
||||
Linkin näkyvän tekstin voi myös päättää erikseen, kuten [tässä](https://olarinmaensamoojat.fi).
|
||||
|
||||
Kuvia voi lisätä samalla tavalla kuin linkkejä, paitsi että hakasulun eteen
|
||||
lisätään huutomerkki. Mikäli kuvan jättää omaan kappaleeseensa, sen
|
||||
linkkiteksti tulee kuvatekstiksi sen alle.
|
||||
|
||||
![OMS:n logo](https://olarinmaensamoojat.fi/tiedotekuvat/logo.png)
|
||||
|
||||
# Osioita on jopa kolmas
|
||||
|
||||
Normaalisti rivinvaihdoilla ei ole väliä, ellei niitä ole kahta peräkkäin
|
||||
jakamassa kappaleita. Mikäli tekstiä tarvitsee erikseen rivittää, voi käyttää
|
||||
kenoviivaa (`\`) rivin lopussa.\
|
||||
Uusi\
|
||||
rivi.
|
||||
|
||||
Rivittää voi myös lohkoittain lisäämällä putkimerkin (`|`) jokaisen rivin
|
||||
alkuun.
|
||||
|
||||
| Tiedoteterveisin,
|
||||
| Saku Laesvuori
|
||||
| [@slaesvuo](https://t.me/slaesvuo)
|
||||
| <saku@laesvuori.fi>
|
Loading…
Reference in New Issue
Block a user