Koska rakenteisen dokumentoinnin sisältöjä on tarkoitus hyödyntää useammassa julkaisussa, ei yksittäisille sisällöille kannata antaa dokumenttikohtaisia tunnisteita kuten ’taulukko 1’. Sama taulukko voi olla täysin eri kohdassa toista julkaisua ja siksi vaatia täysin eri (numero)tunnistetta. Tästä syystä näihin osioihin ei pystyisi myöskään viittaamaan suoraan osana tekstiä kuin ehdollistamalla kaikki kyseisenlaiset viittaukset.
Onneksi rakenteisen dokumentoinnin järjestelmät kuitenkin osaavat täydentää tällaiset yksityiskohdat julkaisuvaiheessa. Tämä artikkeli käsittelee sitä, kuinka tämä käytännössä toimii, ja kuinka käytänteet siltä osin poikkeavat suorasta tekstinkäsittelystä. Samalla kuvataan, kuinka osa sisällöistä voi saapua myös tyylitiedoston kautta, ja muistutetaan siitä, kuinka viitesisällöt toimivat. Viittauksien työympäristöön tuomia eroja käsiteltiin jo tämän sarjan ensimmäisessä osassa.
Sisäiset Linkit

Koska osioiden ja elementtien (numero)tunnisteet määräytyvät niiden käyttöyhteyden perusteella, ei niitä voi kirjoittaa suoraan osaksi tekstiä, kun kyseiset osat mainitaan. Ratkaisu tältä osin on sisäisten linkkien käyttäminen eli kyseisiin osiin viittaaminen. Ainakin DoX CMS täydentää tällaiset viitteet julkaisuvaiheessa oikeilla tunnisteilla sen mukaisesti kuin ne määriytyvät kyseiseen dokumenttiin. Tunnisteiden täydentymistä käsitellään tarkemmin alempana.
Sisäiset linkit voi joko kytkeä itse muotoiltuun ilmaisuun tai jättää tyhjiksi. Jälkimmäisessä tapauksessa DoX CMS täydentää linkkinä toimivan tekstin itse: osioille lisätään sekä niiden numerotunniste että otsikko ja elementeille niiden numerotunniste, mukaanlukien kyseisen elementin tyyppi. Jälkimmäisen yksityiskohdat määräytyvät sen mukaisesti, kuinka elementtien tunnisteet on määritetty yhtiönne DoX CMS:ssä (katso alla).
Koska numerointi tapahtuu automatisoidusti, ei siihen sisälly riskiä kirjoitettujen arvojen päivittämisen yhteydessä. Jos esimerkiksi sisältöihin lisätään uusi taulukko ennen taulukkoa 3, kaikkien taulukoiden numerointi päivittyy heti tämän mukaisesti ja taulukko 3 onkin taulukko 4. Sisäiset linkit seuraavat näitä muutoksia ja vastaavat aina senhetkistä arvoa senkertaisessa julkaisussa.
Muiden osien dokumenttia tunnisteiden vaihtuvuus tekee sisäisistä linkeistä välttämättömiä rakenteisen dokumentoinnin osalta. Alla käydään läpi esimerkkejä sisällöistä, joiden osalta linkkien käyttäminen on tarpeen.
Osioiden Numerointi

Rakenteinen dokumentaatio kasataan sisältömoduuleista, joiden perusteella määräytyvät kunkin osion numerotunnisteet. Nämä sisällöt voidaan järjestää hierarkioiksi, jotka vaikuttavat niiden numerotunnisteisiin. Vakioitu merkintätapa, jota myös DoX CMS käyttää, lisää kutakin osioiden järjestystasoa kohden yhden pisteellä erotuetun järjestysluvun lisää numerotunnisteen loppuun. Täten esimerkiksi kolmannen järjestystason osion tunniste voisi olla ’2.1.3’.
Julkaisukohtaisten sisältöjen järjestys ja hierarkia määritetään käyttämällä ennalta määritettyjä puurakenteita. DoX CMS:ssä tähän käytetään niin sanottuja otsikkopuita, joihin sisällöt voidaan järjestellä uudelleen haluttuun tapaan. Tämä tapahtuu ennen julkaisujen kasaamista sisältöjä osaksi otsikkopuuta vetelemällä ja pudottelemalla. Haluttu otsikkopuu valitaan sitten julkaisuun, missä vaiheessa siitä voidaan vielä suodattaa pois kyseiseen julkaisuun kuulumattomat ehdollistetut osiot ja muut sisällöt.
Koska kukin osio tulee mukaan julkaisuun ainakin otsikkona, on jokaiseen parasta lisätä vähintään jotakin sisältöä. Muutoin julkaisuun jää välittömästi toisiaan seuraavia otsikoita tai otsikkoa vaille tyhjiä sivuja verkkojulkaisuissa, mikä on useimmiten heikkoa asettelua.
Yhdessä järjestelmän täyttämien sisäisten linkkien kanssa osioiden automaattinen numerointi tarkoittaa, että samoja sisältöjä on mahdollista käyttää eri julkaisuissa ilman niiden mukauttamista. Missään käyttöyhteydessä käyttäjien ei tarvitse itse huolehtia käytettyjen tunnisteiden koordinoimisesta.
Nimetyt Elementit

Myös yksittäisillä sisältöelementeillä voi olla otsikko ja numerotunniste. Näistä tärkeimpiä ovat taulukot ja erikseen käytetyt kuvat. DoX CMS sisältää kahdenlaisia taulukoita: aina otsikoituja ja toiminnallisuudeltaan kattavampia täysiä taulukoita ja otsikoimattomia perustaulukoita. Kuville saa lisättyä otsikot ja kuvatekstit käyttämällä niiden yhteydessä erillisiä kuvakehyselementtejä. Myös muun tyyppisille elementeille kuten tekstikappaleille voidaan lisätä otsikot sisäisien linkkien avulla. Tämä ei kuitenkaan ole suositeltavaa.
Toisin kuin osiot, nimetyt elementit eivät noudata numeroinniltaan vain yhtä mahdollista formaattia. DoX CMS:n tapauksessa niille kaikille määritetään toistaiseksi yksi formaatti osana järjestelmän asetuksia, mutta tämä formaatti on vapaasti hallinnoitavissa. Se käyttää muuttujia, jotka on kytketty arvoihin kuten siihen, monesko kyseisenlainen elementti on kyseessä saman ensimmäisen järjestystason alaisissa sisällöissä. Muuttujat ovat ulkoisesti hallinnoitavia viitesisältöjä, joista ensimmäinen osa kertoo lisää.
Nimettyjen elementtien numerotunniste voi olla esimerkiksi muotoa ’Taulukko 1.5’, missä ensimmäinen osa kertoo elementin tyypin ja numeroitu osuus kertoo kyseisen osion ensimmäisen järjestystason ja jälkimmäinen, monesko sen sisäinen kyseisenlainen elementti on kyseessä. Tämä taulukko olisi siis dokumentin ensimmäisen pääosion viides (täysi) taulukko. Elementtien tunnisteet voi kasata myös esimerkiksi pelkästä tyypin tunnisteesta ja dokumentin sisäisestä järjestysnumerosta kuten ’Kuva 12’ koko dokumentin kahdennelletoista kuvakehykselle. Elementtityyppien nimet käyttävät muuttujia, joiden avulla ne saadaan aina käännettyä vastaamaan julkaisun kieltä.
Kun DoX CMS:ssä käytetään sisäistä linkkiä täten nimettyyn elementtiin ja kyseinen linkki ei liity ennalta määritettyyn sanamuotoon, täydentää järjestelmä kyseiseen sijaintiin linkitetyn elementin numerotunnisteen.
Tyylipohjaiset Lisäykset

Järjestelmän tekemien lisäyksien päälle on mahdollista määrittää muita lisäyksiä osana julkaisemisen yhteydessä käytettyjä tyylitiedostoja. Varsinkin erilaisten huomioelementtien symbolit ja nimet on parasta toteuttaa tällä tavoin. Näin saadaan lisättyä esimerkiksi teksti ’Vaara’ ja siihen liittyvä varoitusmerkki siten merkittyihin huomioelementteihin.
Tyylipohjaisten lisäyksien osalta on oltava erityisen varovainen. Nämä tulee tietää ennen kirjoittamisen aloittamista. Vaikkapa yllä mainittu ’Vaara’-teksti voi tulla toisinnetuksi sekä osana tekstiä että tyylitiedoston kautta lisättynä osana muussa tapauksessa. Tyylitiedostojen rajoituksien vuoksi joissakin olosuhteissa voi olla välttämätöntä kirjoittaa nämä tunnisteet osaksi tekstiä esimerkiksi muuttujien avulla. Täten täydennystä ei myöskään voi pitää itsestäänselvyytenä.
DoX CMS:n käyttämät tyylitiedostot ovat useimmiten CSS-muotoisia (Cascading Style Sheets). Tällä hetkellä CSS sallii lisätä kuhunkin elementtiin enintään yhden elementin ennen sitä ja yhden sen jälkeen, ja näiden elementtien oma muotoilu on muuta dokumenttia rajoittuneempaa esimerkiksi sivunvaihtojen hallinnoinnin osalta. Tämän lisäksi kuvia saa kuitenkin lisättyä myös elementtien taustakuvina, mutta kuhunkin mahdolliseen ratkaisuun liittyy rajoituksensa ja haasteensa. Esimerkiksi taustakuvien korkeus ei saa olla korkeampi kuin matalin kyseisenlainen elementti. Muutoin matalien elementtien taustakuvat leikkautuvat niitä pienempien elementtien korkuisiksi.
Vaikka DoX Systems tarjoaa alustavien tyylitiedostojen luomisen sekä niitä koskevaa neuvontaa, on myös käyttäjien tärkeää ymmärtää, mitä tyylitiedostot tekevät. Niiden tekemät muutokset näkyvät dokumenttien esikatselussa ja esivedoksissa, mutta tämä ei selvennä suoraan kyseisen toteutuksen rajoitteita. Kaikkiin toteutustapoihin liittyy joitakin rajoitteita, jotka käyttäjien on kyettävä huomioimaan osana kirjoitusprosessia. Lisäksi tyylipohjaisten lisäyksien käännöksien hallinnointi tapahtuu useimmiten suoraan tyylitiedostojen kautta.
Niin kauan kuin tyylitiedostoista ollaan tietoisia ja niiden rajoitukset ymmärretään osana tekstin järjestelyä, on kyseessä kuitenkin tehokas asettelun apukeino. Sen sallimat lisäykset poistavat käyttäjiltä tarpeen muotoilla kyseisenlaiset sisällöt osana kirjoitusprosessia.
Viitesisällöt
Kuten ensimmäisessä osassa käytiin läpi, rakenteinen dokumentointi kattaa myös sisältöjä, jotka haetaan muualta julkaisuvaiheessa. Tarkkaan ottaen tällaiset sisällöt eivät ole täydennettyjä samassa mielessä kuin yllä mainitut muut esimerkit. Kyseiset sisällöt ovat olemassa ennalta ja ne vain haetaan osaksi julkaistavaa materiaalia. Ero pohjamateriaalin ja lopullisen julkaisun välillä kuitenkin kattaa materiaalia, jota alkuperäinen ei itsessään sisällä. Tästä syystä viitesisältöjä vielä sivutaan myös tässä yhteydessä.
Yhteenveto
Koska rakenteisen dokumentoinnin sisältöjä tulee voida tarvittaessa käyttää osana eri julkaisuja, ei niihin voi kiinnittää kirjoitusvaiheessa numerotunnisteita. Täten kaikenlainen sisällön numerointi tapahtuu vasta julkaisuvaiheessa ja viitteet numeroituihin sisältöihin saa koordinoitua käyttämällä sisäisiä linkkejä. Nämä linkit täydennetään viitatun sisällön tunnisteilla osana tekstiä.
Lisäksi pohjamateriaaliin kuulumatonta sisältöä voidaan asettaa osaksi julkaisua joko käytetyn tyylitiedoston tai sisältöön kuuluvien viitteiden kautta. Varsinkin tyylitiedostojen osalta tarkka toteutustapa voi vaihdella, koska eri tarpeet vaativat erilaisia sopeutuskeinoja. Siksi käyttäjien tulee tietää, mitä tyylitiedosto lisää heidän puolestaan ja kuinka tällaiset lisäykset tulee huomioida esimerkiksi sisällön järjestelyn osalta.
Perimmiltään kyseessä on hyvin yksinkertainen rakenteisen dokumentoinnin piirre. Se kuitenkin korostaa, kuinka tällaisten järjestelmien käyttäminen vaatii erilaista ajattelutapaa kuin suora tekstinmuokkaus. Osana rakenteista dokumentointia sisältöjen välille luodaan suhteita, jotka mukautuvat kuhunkin käyttötarkoitukseen. Lisäksi sisältöjä merkitään erilaisilla tunnisteilla, joihin liittyvät muutokset niiden käsittelytavassa tulee ymmärtää kirjoitusvaiheessa, vaikka eroa ei näkisi välittömästi osana toimintaympäristöä.
Näin kuitenkin saavutetaan sekä uudelleenkäytettävyyden vaatima sisältöjen mukautuvuus että yhdenmukaistetaan monimutkaisten elementtien kuten varoituksien muotoilu. Niin kauan kuin tällaiset toteutustavat pidetään mielessä osana kirjoitusprosessia, niistä on vain hyötyä lopputuleman kannalta.