Rakenteinen kirjoittaminen ja sitä tukevat järjestelmät muodostavat monivaiheisen prosessin. Vaikka tämän prosessin yksityiskohdat voivat poiketa eri toimijoiden tarpeiden mukaisesti, järjestelmiin on rakennettu oletustyönkierto. Tämä oletustyönkierto on runko, jonka varaan muutokset prosessissa tehdään ja joka rajoittaa mahdollisia toteutustapoja.
Käyn alla läpi DoX CMS:n oletustyönkiertoa ja sen syitä. Vastaava osuus on tarkoitus lisätä myös käyttöoppaan alkuun.
Esitetty työnkierto kattaa koko käyttöönoton sekä sisällön toimitukset. Olen jakanut sen seitsemään päävaiheeseen, joihin liittyen käydään läpi niihin liittyvät järjestelmät ja toteutustavat.
Suunnitteluvaihe
Tämä on kaikkein tärkein vaihe. Suunnittelu auttaa järjestämään järjestelmän ominaisuudet tiettyihin tarpeisiin vastaavaksi kokonaisuudeksi. Ilman riittävää suunnittelua rakenteisen kirjoittamisen järjestelmän käyttöönotto voi johtaa sen alihyödyntämiseen tai sisällön uudelleen rakentamiseen. Kun käyttöönotto puolestaan perustuu asianmukaiseen suunnitteluun, voi uuden oppaan valmistelu koostua pelkästä muutaman muuttujan arvon määrittämisestä sekä oikeiden tagien valitsemisesta.
Ohessa on esimerkkejä seikoista, jotka tulee huomioida osana DoX CMS:n käyttöönottoa.
Roolit ja Oikeudet
Perusroolit DoX CMS:ssä ovat käyttäjä (user) ja pääkäyttäjä (admin). Niiden lisäksi usein käytettyjä rooleja ovat katselmoija (reviewer) ja kääntäjä (translator). Näiden vakioroolien lisäksi on mahdollista määrittää myös muita käyttäjärooleja, joilla on kullakin omat käyttöoikeutensa.
Rooleihin liittyvään suunnitteluun liittyy, keille annetaan pääkäyttäjän oikeudet, miten pelkkään katselmointiin käytetyt käyttäjätunnukset toteutetaan ja tarvitaanko erityisrooleja.
Pääkäyttäjillä on lähes täydet hallinnointioikeudet. Vaikka voi olla houkuttelevaa antaa nämä oikeudet kaikille käyttäjille, niiden varomaton käyttäminen voi johtaa köydenvetoon, joka haittaa tuotantoprosessia. Pääkäyttäjät voivat esimerkiksi pakkovarata muilla varattuja sisältöjä itselleen. Jos toinen henkilö kuitenkin muokkaa tätä sisältöä samanaikaisesti, vain viimeisimmäksi tallennettu versio näiden kahden käyttäjän välillä säilytetään.
Toissijaisille käyttäjille kuten katselmoijille ja kääntäjille on mahdollista luoda omat käyttäjätilinsä, joiden kirjautumisoikeuksia on mahdollista kierrättää tarvetta vastaavalla tavalla. Tämä vaatii kuitenkin hallinnointia, jota varten on hyvä suunnitella oma toteutustapansa käyttäjien kesken.
Sisältöformaatti
DoX CMS tukee sisällön kirjoittamista joko LW-DITA– tai HTML-muotoisena. Lisäksi on mahdollista laittaa mukaan aiempia PDF-sisältöjä, mutta niiden käytettävyys on rajoitettua.
Kullakin näistä formaateista on vahvuutensa ja heikkoutensa ja niitä on mahdollista yhdistää tarpeen mukaan. Oletusformaatti on kuitenkin LW-DITA, johon liittyy enemmän toimintoja kuten sisältöviitteet (conref), joiden avulla uudelleenkäytettyjä elementtejä voi hallinnoida yhdessä sijainnissa.
LW-DITA sisältää laajemman valikoiman käyttötarkoituksiltaan erotettuja elementtejä kuten erilliset huomioelementit (note) esimerkiksi varoituksille. Siihen liittyy myös enemmän toiminnallisuutta kuten kyky määrittää jokaiselle elementille, halutaanko se käännättää, sekä laajemmat otsikoimismahdollisuudet.
Kun käytössä on LW-DITA, tulee myös päättää, halutaanko sisältö kirjoittaa ensisijaisesti Content-kenttään vai Sections-kenttään. Ensin mainittu on helpommin hallinnoitavissa. Jälkimmäisen käyttäminen kuitenkin antaa esimerkiksi tehdä sisältöviitteitä elementeille, jotka eivät muutoin tue tätä toimintoa, tai joukoille peräkkäisiä elementtejä.
HTML-editori sisältää omat elementtityyppinsä, joille ei löydy suoria vastineita LW-DITA:n osalta kuten vaakaviivat, ja komentoja kuten Korvaa Kaikki. Lisäksi taulukot HTML-sisällöissä ovat helpommin hallinnoitavissa ainakin tällä hetkellä.
Asetukset
DoX CMS antaa käyttäjien vaikuttaa joidenkin toimintojen käyttäytymiseen asetuksien kautta. Nämä asetukset koskevat kaikkia jaetun ympäristön käyttäjiä. Ne on syytä huomioida osana haluttua käyttökokemusta.
Yksi asetus määrittää, tulevatko ilman tageja olevat otsikkosisällöt mukaan julkaisuihin. Kun se on käytössä, yleismuotoisiin sisältöihin ei tarvitse laittaa tageja. Kun se ei ole käytössä, kaikkiin julkaisuihin tuleviin sisältöihin täytyy käyttää näitä julkaisuja vastaavia tageja.
Toinen tärkeä asetus määrittää, kuinka sisältöjen tallentaminen toimii. Kun se on käytössä, otsikkosisältöjen tallennuksen yhteydessä kysytään, tapahtuuko tallennus nykyiseen vai uuteen revisioon. Näin muutokset saa tehtyä suoraan uusiin revisioihin. Kun se ei ole käytössä, uudet revisiot täytyy lisätä ennen niihin tulevien muutoksien aloittamista. Tämä vaihtoehto kuitenkin varmistaa, että uuteen revisioon tarkoitetut muutokset eivät epähuomiossa tallennu vanhaan revisioon. Lisäksi se estää tilanteet, missä tallentaminen ei rekisteröidy, koska varmennusvalikko on suljettu ennen sisällön tallentamista.
Tätä kautta määritetään myös esimerkiksi sekä elementtien otsikoiden formaatti että sisältöjä sinulle varattaessa lähetettävän sähköpostiviestin formaatti. Varsinkin elementtien otsikoiden formaatti on tärkeää määrittää tarpeisiinne soveltuvaksi tarjottujen muuttujien avulla.
Työnkierto
DoX CMS sallii rakentaa halutunlaisen työnkierron muutaman perusominaisuuden päälle. Järjestelmään tehtävien muutoksien lisäksi on tietenkin tärkeää suunnitella, kuinka sisällön tiloja ja varaamista tullaan käyttämään parhaiden tuloksien saavuttamiseksi.
Oletustilat työnkierrossa ovat (1) Normal, (2) InTranslation, (3) Approval ja (4) Approved. Normal on lähtöoletus. InTranslation on käytössä kohdekielen revisioissa, joiden käännöksiä ei ole vielä tuotu järjestelmään. Tämä tila vaihtuu valitun oletussiirtymän mukaisesti, kun käännökset tuodaan järjestelmään. Approval näyttää sisällöt Katselmointi-valikossa. Approved lukitsee kyseisen revision. Sitä ei voi enää varata muokattavaksi eikä siirtää aiempiin työnkierron tiloihin, ellei näitä asetuksia muuteta.
Näiden tilojen lisäksi on mahdollista lisätä esimerkiksi tila, jossa sisältö varataan takaisin kirjoittajalle katselmoinnin jälkeen, jos siihen täytyy tehdä kommenttien mukaisia muutoksia. On myös mahdollista lisätä tila, joka kertoo sisältöjen olevan julkaistu, tai tila, joka kertoo sisältöjen oleva arkistoituja. Tällainen työnkierron suunnittelu kuuluu tähän vaiheeseen.
Järjestely
Eri näkymien DoX CMS:ssä järjestely ja käyttötavat on syytä suunnitella ennalta. Tämä kattaa listat (1) otsikkosisällöistä, (2) tageista ja (3) julkaisupohjista sekä (4) liitetiedostojen kansioinnin.
Otsikkosisältöjen ja tagien osalta käyttäjät saavat itse järjestellä näkymät. Täten käytetyille järjestelymenetelmille on syytä olla perusteet. Kun samaa sisältöä käytetään uudelleen kuten rakenteista sisältöä on tarkoitus käyttää, on se parasta järjestellä aihekohtaisesti eikä julkaisukohtaisesti. Tällä tavoin sisällöt uusiin julkaisuihin löytää niiden aiheen perusteella. Tällöin käyttäjien ei tarvitse muistaa, minkä julkaisun yhteyteen minkäkin aiheen sisällöt on ensisijaisesti yhdistetty. Kun sisällöt kuitenkin järjestellään aihekohtaisesti, on syytä käydä läpi ennakkoon, minkä aihekokonaisuuksien mukaisesti sisältö tullaan erittelemään. Aihekohtaisia kansioita lisätään listalla yläkategorioina toimivien otsikkosisältöjen muodossa. Kaikkia otsikkosisältöjä ei tarvitse käyttää osana julkaisuja. Tämä koskee myös esimerkiksi sisältöviitteille (conref) lisättyjä otsikkosisältöjä, jotka on syytä erottaa muusta sisällöstä.
Vastaavasti tagien järjestely määrittää, kuinka ne toimivat. Ylimmän tason tagit toimivat niminä niiden pääkategorioille. Näiden pääkategorioiden sisään voi luoda alakategorioita järjestelemällä tagit useammalle sisäkkäiselle järjestystasolle. Koska käytetyt tagikategoriat vaikuttavat tagien toimintaan ja koska tagit on parasta lisätä sisältöön sen kirjoittamisen ohessa eikä jälkikäteen, on niiden asianmukainen ennalta järjesteleminen erityisen tärkeää.
Varsinaisen järjestelemisen lisäksi on syytä valmistella näiden näkymien hallinnoimisen keinoja. Tätä aihetta käydään läpi tarkemmin täällä. Käytännössä kuhunkin listanäkymään liittyy erinäisiä kenttiä, joihin lisättyjä arvoja on mahdollista käyttää näkymän sarakekohtaiseen suodattamiseen. Näihin kenttiin kuten Kuvaus-kentän sekä Editori-valikossa että Julkaisut-valikossa arvojen osana on mahdollista käyttää esimerkiksi avainsanoja, jotka auttavat eristämään näiden valikoiden näkymistä vain tilannekohtaisesti tarvitut sisällöt.
Liitetiedostojen järjesteleminen ei juurikaan poikkea muusta kansiorakenteiden käyttämisestä. DoX CMS:n osalta olennaista on kuitenkin mahdollisen tarpeen kuvakäännöksille huomioiminen. Kuvakäännökset ovat joukkoja saman kansion kuvia, jotka on asetettu näytettäviksi eri kielillä, kun sisällössä on viittauksia näihin kuvakäännöksiin. Jotta viittaukset saadaan kohdistettua alusta alkaen oikein, on kuvakäännökset syytä tehdä jo ennen käännöksien lisäämistä, jos kuvissa on käännettävää sisältöä.
Valmisteluvaihe
Rakenteisen dokumentaation käyttöönottoon liittyy toimenpiteitä, jotka tekevät alkuun pääsemisestä raskaampaa kuin suorasta tekstinkäsittelystä. Tämä sijoitus kuitenkin korvaantuu huomattavasti pienempänä ylläpitoon ja uudelleenkäyttöön liittyvänä panostuksena. Valmistelu tarvitsee tehdä vain kerran.
Valmisteltaviin osuuksiin DoX CMS:ssä sisältyvät (1) tagit, (2) muuttujat, (3) tyylitiedostot (ja elementtiluokat), ja (4) työnkierron tilat.
Tagit
Kuten yllä mainittiin, osa tagien toteutusta on niiden asianmukainen järjesteleminen. Tarvittavat tagikategoriat ja niissä tiedossa oleviin tuotteisiin liittyvät tagit on syytä lisätä järjestelmään ennen sisällön kirjoittamista. Tällä tavoin näitä tageja voi lisätä sisältöön tarpeen mukaan osana kirjoitusprosessia. Jos tageja käytetään myös muilla tavoin kuten keskeneräisten sisältöjen puutteiden merkitsemiseen, myös nämä tagit on hyvä lisätä ajoissa.
Muuttujat
Koska muuttujia käytetään osana sisältöä, myös ne on hyvä valmistella etukäteen. Tältä osin on tärkeää tietää, millaisia muuttujia kullekin sisällölle käytetään. Perusmuuttujat on tarkoitettu sisällöille, jotka ovat samoja kaikilla kielillä. Käännösmuuttujat sisältävät käännettäviä mutta julkaisujen kesken samoja sisältöjä. Julkaisumuuttujia puolestaan käytetään julkaisukohtaisesti hallinnoitaviin osuuksiin. Näitä muuttujia voidaan käyttää myös keskenään sisäkkäin, mistä syystä tarpeisiin soveltuvan järjestelyn ennalta valmisteleminen on tärkeää.
Perusmuuttujien ja käännösmuuttujien sisällä on mahdollista käyttää myös tageihin perustuvaa ehdollistamista. Lisätietoja siitä löytyy alempaa.
Tyylitiedostot
Tyylitiedostot määrittävät, kuinka sisältö asettuu ja miltä se näyttää. Kuten myös täällä käydään läpi, kyseessä on kuitenkin suhde, missä myös sisältö on parasta kirjoittaa tyylitiedoston vaateet huomioiden. Valmiit tyylitiedostot myös auttavat katselmoimaan sisältöjä halki koko kirjoitusprosessin. Toimitamme DoX CMS:n käyttöönoton yhteydessä yhden tarpeidenne mukaisen tyylitiedoston, mutta teidän täytyy antaa vaaditut määreet sen kirjoittamista varten.
Elementtiluokat ovat toiminnallisuudeltaan riippuvaisia tyylitiedostosta. Tästä syystä ne tulisi määrittää tyylitiedoston kirjoittamisen yhteydessä eli on syytä arvioida ennalta, millaisia poikkeustilanteita tyylin tai asettelun osalta tullaan tarvitsemaan. Jos niitä lisätään myöhemmin, täytyy uusien elementtiluokkien säännöt kirjoittaa silloin tyylitiedostoon.
Työnkierron Tilat
Suunnitellun työnkierron valmisteleminen koostuu tarvittavien uusien tilojen lisäämisestä ja valmiiden tilojen asetuksien muuttamisesta. Kullekin työnkierron tilalle täytyy määrittää (1) nimi, (2) roolit, joiden omaajille sisältöä voidaan varata tässä työnkierron tilassa, ja (3) mahdolliset seuraavat siirtymät. InTranslation-tilan tapauksessa myös oletussiirtymä on tärkeä, koska järjestelmä siirtää käännetyt sisällöt kyseiseen tilaan, kun käännökset tuodaan järjestelmään. Lähtökohtaisesti tänä arvona käytetään Approval-tilaa, joka antaa katselmoida käännöksiä.
Kirjoitusvaihe
Myös kirjoitusvaiheeseen liittyy muitakin toimintoja kuin tekstin ja erilaisten elementtien editorissa lisääminen. Tärkeimmät näistä ovat (1) sisällön revisiot, (2) DITA-ominaisuudet ja (3) ehdollistaminen tageilla.
Revisiot
Kunkin sisältökokonaisuuden saa tallennettua erikseen ylläpidettävinä revisioina, joista voidaan valita käyttöön soveltuvat. Näiden revisioiden ylläpitäminen on osa kirjoitusprosessia, koska usein muutokset on syytä erottaa omaksi revisiokseen, jonka kuvaus kertoo, mitä siinä on muutettu.
Kuten asetuksien yhteydessä mainittiin, sisällön revisioinnin voi toteuttaa joko pelkästään siihen tarkoitetun erillisen toiminnon kautta tai osana tallentamistoimintoa.
Kun revisiot ovat muokattavina, täytyy kyseisen käyttäjän varata ne itselleen. Varaus on mahdollista jättää voimaan, jos sama henkilö jatkaa saman sisällön muokkaamista myöhemmin. Muussa tapauksessa on hyvä poistaa revision varaus, kun sitä ei työstetä.
DITA-ominaisuudet
LW-DITA-muotoisten sisältöjen tapauksessa iso osa niiden toiminnallisuuden hallinnoinnista tapahtuu niiden DITA-ominaisuuksia hallinnoivien valikoiden kautta.
Esimerkiksi liitettävien kuvien osoitteet määritetään kuvaelementtien DITA-ominaisuuksissa, samoin kuin linkkien kohteet xref-elementtien osalta.
Tärkeimpiin DITA-ominaisuuksiin kuuluvat joidenkin elementtien käyttämät ID-kenttä ja Conref-kenttä.
ID-arvoja käytetään tiettyihin elementteihin viittaamiseen. Yleisimmät viittauksien muodot ovat sisäiset linkit ja sisältöviitteet (conref). Sisäiset linkit siirtävät näkymän kyseisen elementin kohdalle ja sisältöviitteet hakevat merkityn elementin sisällön muiden samanlaisten elementtien käyttöön.
Vastaavasti Conref-arvoja käytetään sisältöviitteiden kohde-elementeillä, jotka hakevat sisältönsä tässä kentässä nimetystä sijainnista. Sisältöön lisätään tällöin tyhjiä elementtejä ja niille annetaan Conref-arvot, joiden perusteella ne käyttävät viitatuissa sijainneissa olevien elementtien sisältöjä. Näin kunkin kohde-elementin sisältö päivittyy lähde-elementtiä päivitettäessä. Nämä lähdesisällöt on syytä erottaa täysin julkaisuihin suoraan käytettävistä sisällöistä. Tällä tavoin alkuperäisiä elementtejä ei tarvitse etsiä muun sisällön joukosta, kun niitä tarvitsee päivittää.
Ehdollistaminen Tageilla
Kun sisältökokonaisuuksia kirjoitetaan, on ne usein tarkoitettu useamman julkaisun käyttöön. Tällöin niihin täytyy usein kirjoittaa osuuksia, joita käytetään vain osassa näistä julkaisuista. Nämä osuudet puolestaan täytyy tällöin merkitä tageilla, jotka toimivat sisällön julkaisukohtaisen suodattamisen vaatimina tunnisteina.
Tageja voi lisätä sekä otsikkosisällöille että elementeille niiden sisällä. Otsikkosisällöt on helpointa merkitä Tagit-toiminnolla Editori-valikon listanäkymässä, koska se antaa valita useamman sisällön kerrallaan. Elementeille lisätään tageja editorissa valitsemalla ne oikealla hiiren painikkeella ja käyttämällä samaa toimintoa.
Julkaisuvaiheessa ei näytetä tageilla merkittyjä sisältöjä, jotka eivät vastaa julkaisuun valittuja tageja. Tarkkaan ottaen näytetään ne sisällöt, joihin käytettyjen tagien jokaisesta tagikategoriasta on julkaisun käytössä ainakin yksi samoista kyseisten kategorioiden tageista.
Tarkistusvaihe
Tarkistamista on syytä tehdä useamman vaiheen välissä ja aikana. Kirjoitusvaiheen alettua saatavilla ovat kuitenkin siihen erikseen tarkoitetut järjestelmät.
DoX CMS tarjoaa sisällön tarkistamiseen katselmointitoiminnon osana työnkiertoa. Kun otsikkosisältö tai julkaisu on Approval-tilassa, näkyy se Katselmointi-valikossa käyttäjälle, jolle se on varattu, ja kaikille käyttäjille, joilla on roolin kautta oikeus nähdä kaikki katselmoitava sisältö. Tällöin siihen on mahdollista lisätä kommentteja, jotka ovat nähtävissä myös editorissa, ja sisältö voidaan joko hyväksyä ja lukita asettamalla se Approved-tilaan tai lähettää takaisin muokattavaksi kommenttien mukaisesti. Käyttäjät saavat aina sähköpostiviestin, kun heille varataan sisältöä työnkierrossa.
Julkaisujen katselmoitavissa olevat esikatseluversiot ovat yhtenäisiä HTML-julkaisuja, joissa ei näy sivurajoja tai sivutunnisteita. Näiden yksityiskohtien katselmoiminen vaatii esivedoksen julkaisemista asianmukaisessa formaatissa.
Myös sisältöä voi esikatsella kirjoittamisen yhteydessä käyttämällä editorin Julkaise-komentoa ja sen Esikatselu-komentoa. Tämä näyttää esimerkiksi, kuinka sisältö asettuu valitun tyylitiedoston mukaisesti. Kyseinen näkymä ei tosin ole tagien perusteella suodatettu ja esimerkiksi linkit muihin otsikkosisältöihin eivät löydä kohteitaan, koska ne eivät ole osa kyseistä koejulkaisua.
Kirjoitusvaiheen kanssa lomittain sisältöjen katselmoinnin lisäksi niin on syytä tehdä ainakin kasaamisvaiheessa lopullisille julkaisuille sekä kääntämisvaiheessa vastaanotetuille käännöksille. Vaikka itse kieltä ei ymmärtäisi, saa näin kiinni mahdollisia käännösvirheitä kuten että muuttujien arvoja ei ole käännetty tai että muuttujan osuus sisällöissä on käännetty, jolloin se ei hae oikeaa arvoa lainkaan.
Kasaamisvaihe
Kun tarvittavat puitteet ja sisällöt on saatu käyttövalmiiksi, julkaisut tarvitsee enää kasata niitä käyttäen. Tämä koostuu kolmesta vaiheesta: (1) otsikkopuiden kasaamisesta, (2) julkaisupohjan yksityiskohtien määrittämisestä ja (3) julkaisun revision lukitsemisesta. Kolmas vaihe ei ole vaadittu julkaisemista varten, mutta se varmistaa julkaisujen revisioiden säilymisen alkuperäistä vastaavina, vaikka sen sisältämiin osatekijöihin tehtäisiin muutoksia myöhemmin.
Otsikkopuut
Otsikkopuut ovat julkaisujen käyttöön tarkoitettujen sisältöhierarkioiden mukaisesti järjestettyjä joukkoja otsikkosisältöjä. Niiden avulla itsenäisesti hallinnoidut sisällöt järjestetään julkaisu(tyyppi)kohtaisiksi kokonaisuuksiksi.
DoX CMS:ssä otsikkopuut kasataan niiden omassa valikossa, missä sisällöt voidaan vetää niiden päälistauksesta ja järjestellä halutunlaiseksi sisältöhierarkiaksi. Julkaisua kasattaessa valitaan sen käyttöön yksi näin kasatuista otsikkopuista, josta suodatetaan sen jälkeen pois poikkeavalla tavoin ehdollistetut sisällöt.
Koska otsikkopuiden sisältöjä suodatetaan julkaisuvaiheessa, ei niitä tarvitse tehdä julkaisukohtaisiksi. Sen sijaan esimerkiksi jokaiselle ohjetyypille voi tehdä oman otsikkopuunsa, johon on sisällytetty kaikkia malleja koskevat kyseisenlaiseen ohjeeseen kuuluvat sisällöt.
Julkaisupohjat
Kun kaikki vaaditut osatekijät on saatu valmisteltua, tarvitsee ne enää yhdistää julkaisupohjaksi. Tätä julkaisupohjaa käytetään sitten sen mukaisten sisältöjen julkaisemiseen eri formaateissa.
Julkaisupohjan määrittäminen vaatii (1) nimen, (2) tyylin, (3) kansilehdet, (4) otsikkopuun, (5) julkaisumuuttujien arvot, (6) tagit ja (7) sisältöjen revisiot. Lisäksi on hyvä ajatus antaa julkaisupohjalle kuvaus, johon voi lisätä esimerkiksi revision sisältämiä muutoksia tai hakua helpottavia avainsanoja.
Tyylit ovat yhdistelmiä yhden tai useamman tyylitiedoston sekä sivutunnisteiden välillä. Lista kansilehdistä näyttää otsikkosisällöt, jotka on merkitty mahdollisiksi kansilehdiksi, ja valituille sisällöille annetaan asianmukaiset tunnisteet ja sijoituspaikat. Julkaisumuuttujien arvot voi määrittää joko kielikohtaisesti tai yhdeksi arvoksi kaikkien kielten kesken. Sama pitää paikkansa julkaisun nimen osalta.
Kuten yllä mainittiin, sisällön suodatus perustuu yhteneväisyyksiin tageilla ehdollistettujen sisältöjen ja julkaisun käyttöön valittujen tagien välillä. Ehdollistetut sisällöt näkyvät julkaisussa, kun julkaisun käyttöön valittu ainakin yksi vastaava tagi jokaisesta tagikategoriasta, josta kyseiseen sisältöön on käytetty tageja.
Tiettyyn julkaisupohjaan on mahdollista valita sen käyttämät revisiot eri otsikkosisällöistä. Oletusarvoisesti nämä arvot päivittyvät käyttämään uusimpia revisioita kustakin sisällöstä. Julkaisun käyttöön voi kuitenkin pakottaa tietyt revisiot joko yksitellen tai massakomentona. Saatavilla olevat massakomennot perustuvat perusteisiin kuten ’viimeisin hyväksytty revisio’ eli uusin revisio, joka on Approved-tilassa.
Revisioiden Lukitseminen
Kun julkaisupohja on valmis ja se on hyväksytty katselmoinnin perusteella, on hyvä ajatus käyttää julkaisujen työnkiertoa sen lukitsemiseksi kyseiseen muotoon. Jos samasta julkaisusta tarvitaan myöhemmin uusi vedos, voi siitä tehdä uuden revision, johon sisällöt päivittyvät.
Yksittäiset julkaisupohjat ovat julkaisujen revisioita. Kun tietty julkaisun revisio asetetaan työnkierrossa joko tilaan Approval tai Approved, kaikki sen yksityiskohdat säilyvät samoina, vaikka käytettyihin osiin tehtäisiin myöhemmin muutoksia. Tämä kattaa sisältöjen revisiot, tyylitiedostot, liitetiedostot ja niiden sijainnit ja niin edelleen.
Tällä tavoin varmistetaan, että kyseiset vedokset julkaisuista säilyvät samanlaisina kuin ne olivat niiden toimitushetkellä, vaikka sisältöön tai esimerkiksi tyyliasetuksiin voi myöhemmin olla tehty päivityksiä.
Kääntämisvaihe
Kun julkaisut ovat valmiita kirjoituskielellä, voi ne käännättää myös muille kielille. Tätä varten kohdekieli täytyy ensin määrittää järjestelmään sisältöjen ylläpitämistä varten. Sen jälkeen sisällöistä tehdään käännöspyyntö joko vapaavalintaisena joukkona otsikkosisältöjä tai valittuun julkaisuun sisältymisen perusteella. Kun nämä sisällöt on käännetty, ne tarvitsee vain tuoda järjestelmään, joka asettelee ne pääosin automaattisesti.
Kielet
Uusien kielien lisääminen DoX CMS:ään vaatii tunnisteen niille määrittämistä joko ISO 639-1 tai 639-2/T mukaisesti.
Kun järjestelmään lisätään uusi kieli, sen voi valita aktiiviseksi kieleksi, jonka sisällöt näytetään eri valikoissa, päänäkymän oikeasta yläkulmasta. Lisäksi monikielisille sisällöille kuten muuttujille lisätään kyseistä kieltä vastaavat osuudet, joihin täytyy lisätä soveltuvat arvot.
Kun otsikkosisällöstä ei ole yhtään käännöstä tai käännöspyyntöä kyseisellä kielellä, näkyy sen kohdalla vain arvo Ei Käännetty. Sitä ei voi avata editorissa ennen kuin ainakin yksi käännöspyyntö, joka sisältää sen, on tehty kyseiselle kielelle.
Käännösprojektit
Sisällön kääntämiseksi täytyy käyttää Käännä-toimintoa joko Editori-valikossa tai Julkaisut-valikossa. Tämä aloittaa uuden käännösprojektin ja joko lähettää valitulle henkilölle tai lataa sinulle käännettävän XML-tiedoston.
Käännösprojektille täytyy antaa nimi, joka auttaa tunnistamaan sen ja toimii sen tiedostonimenä. Tiedostonimessä sen perään lisätään kohdekielen tunniste. Lisäksi täytyy päättää kohdekieli, kenelle käännöstiedosto lähetetään ja mitkä käännösmuuttujat sisältyvät kyseiseen käännösprojektiin.
Jos kyseessä ei ole ensimmäinen käännös kyseisistä sisällöistä, täytyy käännösprojektia varten myös määrittää, mitä kohdekielen sisällöille tehdään. Lisää Uusi Revisio lisää lähtökieltä sisällöltään vastaavan uuden revision samalla revisionumerolla kohdekielelle. Korvaa Revisio kirjoittaa viimeisimmän kohdekielen revision päälle lähdekielen sisällöt käännöksen sijoittelemiseksi. Tätä vaihtoehtoa on syytä käyttää ainoastaan silloin, kun uusi käännöspyyntö tehdään ennen edellisen käännöksen tuomista järjestelmään esimerkiksi sisältövirheen vuoksi. Jätä Pois (Käytä Nykyistä) tarkoittaa, että kyseinen otsikkosisältö ei tule mukaan käännösprojektiin. Tämä on oletusvalinta revisioille, joista on jo tehty käännöspyyntö. Tästä syystä on tärkeää, että käännettävät sisällöt on ensin hyväksytty ja asetettu tilaan Approved. Tällöin muutokset vaativat uutta revisiota, jolloin sisältö lisätään jälleen oletusarvoisesti käännösprojekteihin.
Julkaisujen käännöksiin tulevat kaikki otsikkosisällöt, joiden sisältöä kyseisissä julkaisuissa käytetään. Niissä on myös mahdollista sisällyttää käännöstiedostoon julkaistu versio lähdekielen sisällöistä. Toinen lisäkomento Käytä Revisioita Kohdekielen Julkaisuissa antaa lukita käännösprojektin valintoja vastaavat kohdekielen revisiot kohdekielen revision kyseisestä julkaisusta käyttöön. Tällä tavoin nämä sisällöt pysyvät käytössä ja alkuperäisen kielen julkaisun revisiota vastaavina, vaikka niihin lisättäisiin myöhemmin uudet revisiot uuden käännösprojektin vuoksi. Muussa tapauksessa kohdekielen julkaisu käyttää sille valittuja sisällön revisioita. Jos mitään niistä ei ole lukittu myöskään julkaisun aiemmissa tämän kielen revisioissa, päivittyvät ne vastaamaan uusimpia kohdekielen revisioita.
Käännöstiedoston voi ladata aloittamatta uutta käännösprojektia käyttämällä Esikatselu-komentoa. Tällöin kohdekielen revisioita ei muokata ja järjestelmä ei vielä lisää tätä käännösprojektia käännöstenhallintaan.
Käännöstenhallinnassa on mahdollista ladata uudelleen aloitettujen käännösprojektien käännöstiedostot.
Käännösten Tuominen
Kun käännös on valmis, voi käännöstiedoston lähettää takaisin järjestelmään ja sen sisällöt asetellaan automaattisesti oikeisiin otsikkosisältöihin ja käännösmuuttujiin kohdekielellä.
Käännösten tuominen tapahtuu käännöstenhallinnan listassa käännösprojekteista. Se tehdään Lataa Palvelimelle -komentoa käyttämällä. Tässä yhteydessä voit jälleen valita, mitä kohdekielen revisioille tehdään. Tällä kertaa oletusvalinta on Korvaa Revisio, koska oletusarvoisesti käännösprojektin aloittamisen yhteydessä kohdekielelle on valmisteltu lähtökielen versiota vastaava revisio käännöksien tuomista varten. Julkaisujen käännöksien tapauksessa myös toiminto Käytä Revisioita Kohdekielen Julkaisuissa on käytettävissä uudelleen, mikäli tässä vaiheessa tehdyt valinnat vaihtavat käännöksien kohderevisioita.
Kaikkien sisältöjen käännökset eivät sijoitu automaattisesti. Tyylitiedoston kautta sijoitetut arvot vaativat kielikohtaisia säätöjä tyylitiedostossa. Yleisin näistä arvoista ovat erilaisten huomioelementtien tyypit kuten ’vaara’.
On syytä huomioida, että tunnisteet kuten elementtiluokat ja tagit ovat osa käännettävää sisältöä. Niitä ei koordinoida kielten kesken kuin käännöksien yhteydessä. Myös tästä syystä on tärkeää varmistaa, että lähtökielen sisältö on loppuun asti valmisteltua ennen sen käännättämistä.
Vaikka siis itse vieraskielisen käännöksen kieliasua voi olla vaikeaa katselmoida, on käännetyt sisällöt syytä katselmoida muista syistä. Tällä tavoin huomataan, jos esimerkiksi huomioelementeille tai muuttujille ei ole annettu kielikohtaisia arvoja.
Toimitusvaihe
Kun kaikki sisältö on valmisteltu ja sen laatu on varmistettu, täytyy se tietenkin toimittaa asianmukaisesti.
DoX CMS antaa julkaista sisällön eri formaateissa ja tarvittaessa se voidaan siirtää suoraan käyttämällenne alustalle. Muussa tapauksessa sisällöistä ladataan paikallinen kopio, joka voidaan sijoitella eteenpäin.
Sisällön julkaiseminen tapahtuu Julkaisut-valikossa käyttämällä Julkaise-toimintoa valittuun julkaisupohjaan.
Jos käyttöympäristöönne on rakennettu integraatio tietyn järjestelmän kanssa tai käytätte DoX DMS -lisäosaa, voitte valita sen julkaistavan tiedoston sijoituspaikaksi tällöin avautuvassa valikossa.
Lisäksi täytyy päättää tiedostomuoto kasattavalle julkaisuille. DoX CMS sallii julkaista sisältöä tiedostoformaateissa (1) PDF, (2) HTML tai (3) DITA. PDF-tiedostojen kasaan on saatavilla useampi kasaaja, joiden saatavuutta voidaan hallinnoida käyttöympäristökohtaisesti. HTML voidaan julkasta joko raakaversiona tai WebHelp-muotoisena. Lisäksi julkaisut voidaan pakata EclipseHelp-formaattiin avattavaksi omana tiedostonaan. Samat sisällöt voi julkaista erikseen useammassa formaatissa tarpeen mukaan. Tähän suositellaan käytettävän erillisiä tyylitiedostoja.
Julkaisuvaiheessa on mahdollista vaihtaa käytettyä tyyliä muuhun kuin kasaamisvaiheessa valittuun oletustyyliin.
Julkaisuun käytetyn kielen voi valita julkaisuvaiheessa. Kyseisellä kielellä täytyy tietenkin löytyä vaaditut käännökset.
Myös julkaisumuuttujien arvoja voi määrittää uudelleen tässä vaiheessa. Tällä tavoin voi esimerkiksi nimetä toimituskohtaisen asiakkaan, vaikka kyseessä ei olisi muutoin ainutkertainen julkaisu.
Yhteenveto
Rakenteinen kirjoittaminen sisältää varsinaisen sisällön kirjoittamisen lisäksi sekä valmisteluvaiheita että kasaamisvaiheen. Näistä syntyy sille ominainen oletustyönkierto, jossa voi olla järjestelmäkohtaisia eroja.
Koska rakenteiseen kirjoittamiseen liittyy useita yhteen kietoutuvia järjestelmiä, on niiden käyttötapojen ennakkoon suunnitteleminen erityisen tärkeää. DoX CMS:ssä tämä tarkoittaa varsinkin käyttäjien rooleja, sisällön formaattia ja sijoittelua, yleistason asetuksia sekä työnkierron suunnittelemista.
Suunnittelua seuraa niiden osioiden valmisteleminen, mitä tullaan tarvitsemaan osana kirjoittamisprosessia tai sisältöjen lisäksi julkaisuvaiheessa. DoX CMS:ssä tällaisia osioita ovat sisällön ehdollistamiseen käytetyt tagit, vakioituja sisältöjä hallinnoivat muuttujat, asettelun määrittävät tyylitiedostot sekä mahdollisesti tarvitut lisätilat työnkiertoa varten.
Kun sisältöä aletaan kirjoittaa, on syytä pitää mielessä revisioiden käyttäminen muutoshistorian seuraamiseen, DITA-ominaisuuksien kuten sisältöviitteiden (conref) ja tunnistearvojen käyttäminen sekä tilannekohtaisten osuuksien ehdollistaminen tagien avulla.
Sekä yksittäiset sisältökokonaisuudet että julkaisujen esivedokset voi katselmoida työnkierron kautta.
Kasaamisvaiheessa sisältökokonaisuudet asetellaan julkaisuiksi. Tämä koostuu rakenteen kasaamisesta otsikkopuiden avulla, julkaisupohjien asetuksien kuten käytettyjen tagien säätämisestä sekä valmiiden julkaisupohjien arvojen lukitsemisesta.
Sisältöjen kääntämisvaihetta varten tarvitsee ensin määrittää käytettävissä olevat kohdekielet tarpeen mukaan. Tämän jälkeen joukkoja otsikkosisältöjä tai kaikki julkaisukohtaiset otsikkosisällöt voi lähettää käännettäviksi sitä varten kasattuina XML-tiedostoina. Kun käännetyt tiedostot ovat valmiita, voi ne tuoda takaisin järjestelmään, jolloin niiden sisällöt asetellaan asianmukaisesti kohdekielelle. On syytä kuitenkin huomioida, kuinka kohdekielen revisioita hallinnoidaan osana käännösprosessia sekä kuinka esimerkiksi tyylitiedoston kautta lisättävät osuudet tai kuvat täytyy kääntää ja tuoda järjestelmään erikseen.
Kun on viimein aika toimittaa julkaisut, saa ne kasattua julkaisemalla jonkin valmistelluista julkaisupohjista. Nämä tiedostot joko ladataan paikallisina kopioina tai lähetetään käyttöympäristöön yhdistettyihin sijainteihin muissa järjestelmissä. Mahdollisia julkaisumuotoja on myös useampia ja julkaisuvaiheessa on mahdollista hallinnoida yksityiskohtia kuten käytettyä tyyliä.