Myllyn työkalu: VRT Manipulation / Validate VRT document
in English
VRT-dokumentin validointi
Työkalu tarkistaa erinäisiä seikkoja VRT-muotoiseksi aiotusta dokumentista ja laatii siitä raportin.
Parametreilla voi valita, kuinka yksityiskohtainen raportista tulee.
- level
- error, warning, tai info (oletuksena warning) —
error-tasolla raportoidaan vain varsinaisista
virheistä; info-tasolla raportoidaan myös seikoista,
jotka eivät ole ollenkaan ongelmia vaan ovat muuten
hyödyllisiä tietää - verbosity
- verbose tai summary (oletuksena verbose) —
verbose-tasolla raportoidaan jokaisen raportoitavan
seikan jokaisen esiintymän rivinumero; summary-tasolla
raportoidaan esiintymien lukumäärät mutta vain
ensimmäisen esiintymän rivinumero
Esimerkki
Oletetaan, että seuraavan dokumentin on tarkoitus olla VRT-muotoinen.
<!DOCTYPE html>
<text license="not
to make nay use of this data">
<sentence>
five
years
<sentence>
Dokumentti on väärällään ongelmia: Ensimmäinen rivi alkaa ”vasemmalla kulmasululla” (pienempi kuin -merkillä) mutta ei ole elementin alku- tai loppumerkintä eikä kommentti. Toinen ja kolmas rivi olisivat kelvollinen text-elementin alkumerkintä yhtenä rivinä, mutta kahtena rivinä kumpikaan niistä ei ole kelvollista VRT:tä. Toisen sentence-elementin alkumerkinnän pitäisi olla loppumerkintä — tai ehkä todellinen virhe on jotain ihan muuta, kuten useamman rivin puuttuminen kyseisessä kohdassa. Ja loppumerkinnät puuttuvat sekä text-elementiltä että sentence-elementiltä.
Dokumentissa näyttää myös olevan kirjoitusvirhe (”nay”pitäisi ehkä olla ”any”), ja lainopillisesti ei ehkä ole perusteltua yrittää kieltää tämän aineiston käyttöä yhtään mihinkään. Tällaisia seikkoja validaattori ei tarkista.
Validointiraportti on seuraavanlainen taulukko, jossa jokainen rivi ilmaisee yhden havaitun seikan ja viittaa rivinumerolla sen esiintymään dokumentissa. Ongelmallista sisältöä ei näytetä raportissa. (Aikaisemmat yritykset ovat opettaneet, että ongelmatapausten sisällyttäminen raporttiin tekee raportin lukemisen työlääksi. Eräät ongelmat voivat myös olla ongelmallisia näyttää.)
| line | kind | level | issue |
|---|---|---|---|
| 1 | form | error | malformed tag |
| 2 | form | error | malformed tag |
| 3 | data | error | bare angle |
| 7 | nest | error | element already open: sentence |
| 8 | nest | error | element not closed: sentence |
Raportin ”bare angle” viittaa ”oikeaan kulmasulkuun” (suurempi kuin -merkkiin), joka sisältörivillä pitäisi koodata muotoon >. Validaattori tulkitsee kyseisen rivin sisältöriviksi, koska se ei ala vasemmalla kulmasululla.
Tässä raportissa validaattori ei ole tunnistanut text-elementin alkumerkintää. Siksi se ei myöskään havaitse, että vastaava loppumerkintä puuttuu.
Rivi 8, jossa puuttuvat loppumerkinnät havaitaan, on yhden rivin verran dokumentin ulkopuolella.
Raportti saattaa poiketa tässä esitetystä riippuen siitä, mikä nimenomainen versio validaattorista on käytössä.
Muita työkaluja
- JOSKUS
Katso myös
- VRT-tiedostomuoto Kielipankissa
