Törmään hieman liian usein tilanteisiin, missä ainoa sisäinen kirjoittaja on vaihdettu toiseen ja uusille kirjoittajille ei ole jätetty lainkaan sisäistä dokumentaatiota DoX CMS:n käytön tueksi. Pitäkää yllä sisäisiä käyttöoppaita. Kukaan ei halua joutua kyseiseen tilanteeseen. Syynä tälle on, että DoX CMS on joustava järjestelmä, joka koostuu eri tavoin yhdisteltävissä olevista yleismuotoisista ominaisuuksista. Uudelle käyttäjälle ei siis ole välttämättä lainkaan selvää, kuinka niitä on kulloinkin sovellettu. Tämä johtaa helposti virheisiin, joiden oikaiseminen voi viedä valtavasti aikaa ja vaivaa.
Jos tällaista opastusta ei kuitenkaan ole saatavilla, tämä artikkeli käy läpi seikkoja, jotka uusien käyttäjien on syytä ottaa huomioon, kun he alkavat työskennellä muiden jälkeensä jättämässä DoX CMS -ympäristössä. Tarjoamme pyydettäessä kaikille uusille käyttäjille myös lyhyen tutustutuksen DoX CMS:ään ja tarvittaessa tuntilaskutettavia lisätapaamisia järjestelmän tarkempaa läpikäyntiä varten.
Merkinnät
Yleiskäsityksen saaminen ympäristöstä kannattaa aloittaa erilaisten tunnisteiden ja muiden erotteluperiaatteiden tutkimisella. Tältä osin auttaa, jos näkymissä määrittää näkyviksi niihin liittyvät sarakkeet kuten sekä otsikkosisältöjen että niiden revisioiden kommentit. Lisäksi käytetyt tagit ja niiden kategoriat kertovat paljon sisällön erotteluperiaatteista.
Kommentit
DoX CMS antaa lisätä kommentteja esimerkiksi otsikkosisältöihin, otsikkosisältöjen revisioihin ja julkaisujen revisioihin. Nämä kommentit antavat lisätä sisältöihin vapaamuotoista metadataa, jonka perusteella listanäkymiä voi suodattaa haluttujen kohtien löytämiseksi. Tästä syystä monessa ympäristössä niissä käytetään vakioituja tunnisteita ja avainsanoja. Kun aloitat muiden kasaamassa ympäristössä, on siis syytä varmistaa ensin, millaisia tunnisteita (jos mitään) on käytetty tällä tavoin. Jos tällaisia tunnisteita on käytetty, aseta kyseiset sarakkeet näkyviksi kyseisissä listanäkymissä.
Lisätietoja listanäkymien suodattamisesta löytyy täältä.
Tagit
Uusien käyttäjien on todella tärkeää ymmärtää, kuinka aiemmat käyttäjät ovat käyttäneet tageihin perustuvia erotteluita. Tätä käydään läpi tarkemmin suhteessa sisällön ehdollistamiseen. Tutustumisen vanhaan ympäristöön varhaisessa vaiheessa on kuitenkin syytä tarkistaa myös, mille seikoille siellä on käytetty tageja ja kuinka ne on kategorisoitu.
Tagien ensisijaiset kategoriat määrittyvät tason 1 tagien perusteella. Myös näiden pääkategorioiden sisäiset alakategoriat ovat kuitenkin mahdollisia. Tarkista siis, mille seikoille on varattu tagien pääkategorioita, ja onko niiden sisällä käytetty minkäänlaisia alakategorioita.
Tarkista myös, onko joukossa tagikategorioita, jotka eivät liity suoraan julkaisujen suodattamiseen tai joiden käyttötapa ei muusta syystä ole ilmeinen. Esimerkiksi ennen otsikkopuiden järjestelmään lisäämistä pystytetyissä ympäristöissä (ja S-versiossa) voi olla erillisia tageja sisältöjen pois kaikista julkaisuista suodattamiseen, koska osa julkaisuista on perustunut Editori-valikon pääotsikkopuun tagipohjaiseen suodattamiseen.
Tarkoituksena on selvittää, mitä tageja on tarkoitus käyttää yhdessä sekä ehdollistamisvaiheessa että julkaisuvaiheessa. Kun sinulla on yleinen käsitys kategorioiden ja niiden sisältöjen perusteella, voit verrata sitä sisältöön käytettyihin tageihin ja julkaisuihin valittuihin tageihin. Samoin tällä tavoin selviää, mikäli järjestelmässä on erikoisempia tageihin liittyviä ratkaisuja kuten keskeneräisyyden merkitsemistä kertomalla puuttuvat työvaiheet. Tässä tapauksessa sinun on syytä suodattaa näkyviin kyseisiin tageihin liittyvät sisällöt niiden tarkistamiseksi ja loppuun kirjoittamiseksi.
Asetukset
Seuraavaksi on syytä käydä läpi laajemmin toimintatapoja määrittäviä asetuksia. Tällä tavoin tiedät, missä puitteissa muut ympäristön osat on rakennettu toimimaan.
Asetukset-valikko
Asetukset-valikon kautta määritetään useampia yleisiä toimintaperiaatteita, jotka vaikuttavat laajalti ympäristön asianmukaisiin käyttötapoihin. Tärkein näistä on, tulevatko tagittomat otsikkosisällöt julkaisuihin. Se kertoo, onko kaikille julkaistaville otsikkosisällöille pakko antaa tageja. Asianmukaisesti määritettyjen otsikkopuiden kanssa merkitsemättömien otsikkosisältöjen julkaisuihin pääsemistä ei yleensä ole syytä estää. Tämä asetus vuorovaikuttaa toisen asetuksen kanssa: jos tagittomat sisällöt eivät tule julkaisuihin, on yleensä syytä käyttää myös asetusta, joka lisää elementeille lisättävät tagit samalla kyseisille otsikkosisällöille.
Asetukset-valikko hallinnoi myös uusien revisioiden lisäämistä otsikkosisältöihin. Ne täytyy joko lisätä ennen muutoksien tekemistä, tai muutokset voi tehdä editorissa ja sisällön tallentaa uutena revisiona. Jälkimmäinen vaihtoehto on intuitiivisempi mutta riskialttiimpi.
Lisäksi Asetukset-valikossa näkee täysille taulukoille ja kuvakehyksille (fig) lisättävien otsikoiden formaatin. Tätä otsikon muotoilua käytetään myös sisäisille linkeille kyseisenlaisiin elementteihin. Jos tämä arvo on jätetty tyhjäksi, on kyseisessä ympäristössä käytössä johonkin koettuun erityistarpeeseen vastaava kiertokeino, joka ei sovi yhteen näiden valmisotsikoiden kanssa. Osanottoni. Tämä tarkoittaa, että järjestelmää ei ole käytetty tarkoitetulla tavalla ja se rajoittaa varsinkin sisäisten linkkien käytettävyyttä.
Työnkierto
Lista ympäristössä käytössä olevista työnkierron tiloista löytyy Työnkierron Tilat -valikosta Työkalut-ikonin alla. Tutkimalla sitä voit saada selville, millaisia lisätiloja ympäristössä on mahdollisesti tarkoitus käyttää ja mitkä siirtymät tilojen välillä ovat sallittuja.
Mahdolliset siirtymät näytetään kunkin tilan rivillä Seuraavat Tilat -sarakkeessa. Tällä tavoin voit kaavioida mahdolliset reitit uuden sisällön lisäämisestä (Normal-tila) sen hyväksymiseen (normaalisti Approved-tila). Lisäksi on hyvä tarkistaa Approved-tilan ja lisätilojen asetukset muilta osin. Muokkaa Työnkierron Tilaa -valikossa voi määrittää myös, mitkä roolit omaaville käyttäjille sisällöt voi varata kyseisessä tilassa. Jos mitään roolia ei ole valittu, on kyseinen tila tarkoitettu sisällön lukitsemiseen esimerkiksi hyväksymisen tai arkistoinnin jälkeen.
Julkaisut
Julkaisut ovat kaiken valmistellun sisällön yhteenvetoja. Niiden asetukset kertovat siis, kuinka kyseisiä sisältöjä on tarkoitus käyttää niiden varsinaisessa käyttöpaikassa.
Muokkaa Julkaisua -valikko antaa tarkistaa kunkin julkaisun asetukset. Se näyttää esimerkiksi, mitä tyylejä, kansilehtiä ja otsikkopuita millekin julkaisulle on tarkoitus käyttää. Lisäksi se näyttää, miten eri julkaisumuuttujia käytetään ja mitkä niistä on tarkoitettu monikielisiksi. Monikielisten julkaisumuuttujien arvojen edessä on aktiivisen kielen tunniste. Sisältöjen listan Revisio-sarake näyttää, onko revisioita lukittu julkaisujen käyttöön, vai päivittyvätkö ne aina oletusrevisioon. Tagit-välilehti puolestaan näyttää, mitä tageja julkaisun sisältöjen suodattamiseen on käytetty.
Palaset
Otsikkosisällöt ovat pääpalasia, joista rakenteinen sisältö DoX CMS:ssä koostuu. Ne käsitellään kuitenkin erikseen muotoilun yhteydessä. Otsikkosisältöjen lisäksi DoX CMS sisältää esimerkiksi muuttujia ja sisältöviitteitä, joilla toistuvia sisällön osia hallinnoidaan yhdessä sijainnissa. Lisäksi käyttäjien on syytä jossakin määrin tuntea käyttämänsä tyylit, vaikka he eivät itse osaisi tehdä niihin muutoksia. Ne kertovat usein, kuinka erilaisia elementtejä on oletettu käytettävän.
Muuttujat
Muuttujat ovat tekstikappaleiden sisäisiä toistuvia osuuksia kuten ikoneiden kuvia, yhteystietoja tai mallien nimiä. Niiden avulla on mahdollista tehdä erilaisia yllättävän monimutkaisia toteutuksia, jotka sisältävät sisäkkäisiä muuttujia, ehdollistettuja arvoja, elementtiluokkia ja niin edelleen. Tästä syystä muuttujiin on syytä tutustua tarkasti, jos niitä on käytetty kyseisessä ympäristössä. Muuttujat löytyvät Muuttujat-valikosta Työkalut-ikonin alla.
Muuttujia on kolmenlaisia: (1) perusmuuttujat, (2) käännösmuuttujat ja (3) julkaisumuuttujat. Julkaisumuuttujien arvot käytiin läpi yllä. Ota kuitenkin huomioon, että niitä ei välttämättä käytetä dokumenteissa suoraan. Ne voivat olla sidottuina osiksi muita muuttujia tai sivutunnisteisiin. Perusmuuttujilla on vain yksi arvo ja käännösmuuttujilla on kielikohtaiset arvot. Avaa nämä muuttujat Muuttujat-valikon editorissa ja laita muistiin, kuinka eri muuttujien arvot on rakennettu. Kiinnitä huomiota varsinkin tageihin, elementtiluokkiin ja muihin muuttujiin. Muuttujat tekstissä käyttävät kyseisten muuttujien nimiä kaksien aaltosulkeiden ({}) sisällä.
Tarkista tämän jälkeen, mitä muuttujia on käytetty sisällöissä. Muuttujat-valikossa on komento, joka näyttää otsikkosisältöjen revisiot, joissa muuttujia on käytetty. Vaikka muuttujaa ei olisi käytetty missään otsikkosisällössä, voi sitä olla käytetty toisen muuttujan sisällä tai osana sivutunnisteita.
Sisältöviitteet
Sisältöviitteet (conref) toimivat kuten muuttujat. Niiden avulla soveltuvien toistuvien elementtien sisältöjä voi hallinnoida yksittäisten lähde-elementtien avulla. Sisältöviitteiden avulla samoja sisältöjä käyttävät kohde-elementit saavat haettua sisältönsä näiltä lähde-elementeiltä. Koska nämä elementit on rakennettu käytettäviksi uudelleen, täytyy käyttäjien tietää, missä tilanteissa niitä on tarkoitus käyttää.
Sisältöviitteiden kohde-elementtejä käyttävät otsikkosisällöt löytää tekemällä Editori-valikossa sisältöhaun arvolla ’conref’. Ainoastaan nämä elementit käyttävät Conref-arvoa, ja sisältöhaku vertaa hakusanoja raakasisältöön. Kun teet tällaisen otsikkosisällön Koodi-näkymässä selaimen etsimistoiminnon avulla haun arvolle ’conref’, näet sen sisältämien kohde-elementtien käyttämien lähde-elementtien sijainnin. Tämän arvon sisältämien merkkien # ja / välissä on numerosarja. Kopioi tämä luku ja liitä se Editori-valikon Otsikon Tunniste -sarakkeen otsikon alla olevaan suodatuskenttään. Poista sisältöhakuun perustuva suodatus tekemällä uusi sisältöhaku tyhjällä arvolla. Tällä tavoin paljastat kyseisen lähde-elementin sisältävän otsikkosisällön. Valitse se ja poista hakukriteeri(t). Luultavasti kaikki muut lähde-elementit ovat saman kansion muissa otsikkosisällöissä.
Tyylit
Tyylit eivät ole ainoastaan julkaisuvaiheessa käytetty asettelun määrittäjä. Kuten esimerkiksi täällä mainitaan, kukin tyyli myös osaltaan vaatii siihen rakennettujen oletuksien mukaista sisällön muotoilua. Esimerkiksi suuret, katkeamattomiksi määritetyt elementit kuten isot kuvat tai taulukot saattaa olla tarpeen lisätä otsikkosisältöjen loppuun. Tyyliin voi myös olla lisättynä sääntö, joka estää sivunvaihdot aina ennen listoja, koska ennen listoja oletetaan aina käytettävän lyhyttä tekstikappaletta, joka kuvaa kyseisen listan sisältöjä. Vaikka et itse osaisi hallinnoida tyylitiedostoa CSS:n avulla, on se silti syytä selata läpi jonkinlaisen peruskuvan saamiseksi.
Erityisesti täytyy kiinnittää huomiota elementtiluokkien sääntöihin ja kielikohtaisiin arvoihin. Elementtiluokat on lisätty järjestelmään käytettäviksi tiettyihin tarkoituksiin. Toivon mukaan nämä käyttötavat ovat joko ilmeisiä niiden nimien perusteella tai ne on kuvattu elementtiluokkien kuvauksissa. Tästä syystä on kuitenkin erityisen tärkeää ymmärtää, millaisia muutoksia niihin liittyy ennen niiden käyttämistä (tai käyttämättä jättämistä). Elementtiluokkien osuuden tyylitiedostosta tunnistaa tunnisteen ’doxelementclass’ avulla, ja tätä arvoa voi myös etsiä tyylitiedostosta.
Kielikohtaiset osuudet puolestaan tunnistaa tunnisteesta ’lang’. Niihin liittyy lähes poikkeuksetta komento ’content’, jonka käyttöpaikat kannattaa muutoinkin tarkistaa hakemalla sitä tyylitiedostosta. Kielikohtaisten osuuksien selvittäminen on erityisen tärkeää, koska niihin täytyy päivittää uudet arvot, kun käännöksiä pyydetään uusille kielille. Lisätietoja aiheesta löytyy täältä.
Muotoilu
Kun sinulla on yleiskäsitys kaikista eri tekijöistä, jotka vaikuttavat pääsisällön muotoiluun, on aika tarkistaa, kuinka sisällöt on muotoiltu. Toki voit tehdä näin alustavasti myös ennakkoon, koska nämä järjestelyt vuorovaikuttavat molempiin suuntiin. On erityisen tärkeää, että muodostat todenmukaisen kuvan sisällön muotoilusta. Ilman sisäistä tyyliopasta joudut kuitenkin päättelemään sitä ohjanneet säännöt. Tältä osin ei ole varaa erehtyä.
Kirjoitussäännöt
Rakenteiseen kirjoittamiseen liittyy usein piilotettuja sisällön muotoilun sääntöjä, jotta sen kasaaminen olisi mahdollisimman ennakoitavissa olevaa. Tästä syystä sisäinen tyyliopas on niin tärkeä yhdenmukaisuuden varmistamiseksi. Käsittelen tässä yhteydessä vain joitakin seikoista, joihin on syytä kiinnittää erityishuomiota, kun tällaista opasta ei ole saatavilla.
Ensimmäinen ja ilmeisin seikka, johon on syytä kiinnittää huomiota, on ero tekstieditorin Content-kentän ja Sections-kentän käyttämisen välillä. Yleensä käyttöön valitaan vain toinen näistä. Sections-kenttä vaatii soveltuvaa tyylitiedostoa, mutta se tarjoaa lisätoimintoja, kuten sisältöviitteet (conref) osioille (section) ja niihin perustuvat alaotsikot. Käytä samaa kenttää kuin aiemmissa sisällöissä. Varmista myös, milloin ja miten Shortdesc– ja Prolog-kenttiä on mahdollisesti käytetty.
Käy läpi, milloin ja miten erilaisia taulukoita on käytetty. Osassa tilanteista voidaan vaatia simpletable-elementtejä. Jos taulukoissa käytetään sarakkeiden välillä vaihtelevia syvennysarvoja, ei niissä sovi käyttää jaettuja soluja. Tästä syystä solujen jakamisen kanssa täytyy olla tarkkana. Suosittelemme samasta syystä, että syvennykset ja muut vastaavat seikat pidetään samoina sarakkeiden ja rivien välillä. Tarkista, onko täysissä taulukoissa (ja kuvakehyksissä (fig)) käytetty otsikoita tai kuvauksia ja kuinka ne on muotoiltu.
Listojen osalta on syytä tarkistaa, milloin ja miten niitä on sisennetty. Lisäksi on syytä katsoa, kuinka listan kohtien osalta on käytetty isoja alkukirjaimia, pilkutusta, lihavointia, ja niin edelleen. Kuten yllä mainittiin, on myös syytä tarkistaa, edeltääkö listoja aina jonkinlainen vakioitu kuvaus niiden sisällöistä.
Lisäksi on tietenkin syytä kiinnittää huomiota sanamuotoihin, käytettyihin elementtiluokkiin, kuvien kokoihin ja muihin elementtien DITA-ominaisuuksiin. Varsinkin mediaelementtien kuten videoiden osalta DITA-ominaisuudet on pakko säätää pois oletusarvoisista arvoista, ja vaihtoehtoja niiden toiminnan osalta on useampia.
Ehdollistaminen
Sinun täytyy selvittää tarkkaan, millä tavoin tageja on käytetty sisällön ehdollistamiseen. Mikäli niitä käytetään eri tavoin eri yhteyksissä, ovat myös suodattamisen lopputulokset ei-yhteneviä.
Oikeanlaisen ehdollistamisen merkitys korostuu sisäkkäisten elementtien tapauksessa. Kun sisemmät elementit ehdollistetaan, suodatus ei vaikuta niihin nähden ylemmän tason elementteihin. Tästä syystä tulisi siis ehdollistaa ylimmän sallitun tason sisällöt, kun samalla tasolla voidaan esittää kaikki vaaditut vaihtoehdot. Aina tämä ei ole välttämätöntä kuten huomioelementtien (note) sisäisten tekstikappaleiden ja itse huomioelementtien tapauksessa. Tärkeintä on pitää järjestelmä yhdenmukaisena. Tämä koskee varsinkin tilanteita, joissa useampi vaihtoehto olisi yhtälailla käyttökelpoinen.
Erityisen huolellinen on syytä olla, kun kyse on saman rivin soluista. Joissakin tapauksissa esimerkiksi saatetaan näyttää tai olla näyttämättä kuva tekstiä sisältävän osuuden vieressä. Tämä koskee varsinkin tilanteita, missä näkymättömiä taulukoita on käytetty sisällön asettelemiseen useampaan sarakkeeseen. Varmista tällöin, että ehdollistamisen lisäksi sarakkeiden leveydet on määritetty tavalla, joka varmistaa jäljelle jäävän sisällön oikeanlaisen asettumisen. Käytännössä määreitä kannattaa antaa vain ehdollistettaville osuuksille. Kun ne on suodatettu pois, leveydeltään määrittelemättömät muut osuudet jakavat yli jäävän osuuden keskenään taulukon oletusmääritelmän mukaisesti.
Käyttöopas
Uusien käyttäjien on tietenkin syytä myös tarkistaa DoX CMS:n käyttöopas. Se antaa ainakin yleiskuvan järjestelmän ominaisuuksista ja toimintatavoista. Järjestelmässä on joitakin uuden käyttäjän kannalta vähemmän ilmeisiä ominaisuuksia, kuten että jo tietylle kielelle käännetyt revisioita jätetään oletusarvoisesti pois uusista käännöspyynnöistä kyseiselle kielelle. Tällaisien ominaisuuksien toiminnan selventäminen on osa käyttöönottokoulutusta. Kuten yllä tosin mainittiin, perustutustutuksen lisäksi annettava koulutus vanhoissa järjestelmissä tapahtuu tuntilaskutuksella.
Käyttöopas kertoo sekä erilaisten toimintojen käyttämisestä että käyttöliittymän eri osien toimintatavoista. Käy läpi käyttötavoista kertova osio sekä taulukot hyvistä käyttötavoista ja usein kysytyistä kysymyksistä ennen järjestelmän käytön aloittamista. Käyttöliittymän eri valikoiden osuudet on syytä käydä läpi ainakin, kun käytät kyseisiä valikoita ensimmäistä kertaa. Ne auttavat ymmärtämään, mitä jokainen näkymän eri osa tekee.
Toki voit myös aina ottaa yhteyttä tukeemme. Tuen sähköpostiosoite löytyy oppaasta. Voit käyttää tähän myös Ota Yhteyttä -toimintoa Työkalut-ikonin alla.
Yhteenveto
Kun uusi käyttäjä tulee olemassa olevaan ympäristöön ilman opastusta aiemmilta käyttäjiltä tai sisäistä tyyliohjetta, täytyy hänen selvittää kyseisen järjestelmän aiemmat käyttötavat itse. On erittäin epähuomaavaista asettaa ketään tähän tilanteeseen. Tästä syystä olisi tärkeää ylläpitää sisäistä dokumentaatiota tällaisista toimintatavoista.
Tutustuminen vanhaan järjestelmään kannattaa aloittaa sen sisältöä koskevista merkinnöistä. Nämä merkinnät kertovat, kuinka kyseinen sisältö on jaoteltu. Tämä auttaa sekä saman jaottelun jatkamista että oikeiden sisällön osuuksien löytämistä. Tärkeimpiä tällaisia jaottelun muotoja ovat erilaiset kommentit sekä käytetyt tagit ja niiden kategoriat.
Seuraavaksi on syytä saada yleiskäsitystä siitä kehyksestä, missä sisällön lisääminen ja muokkaaminen tapahtuu. Tässä auttaa Asetukset-valikon eri asetuksien tilan tarkistaminen sekä työnkiertoon ja julkaisujen asetuksiin tutustuminen. Työnkierto kertoo, kuinka sisältöä käsitellään sen kirjoittamisen eri vaiheissa. Julkaisujen asetukset puolestaan näyttävät, mitä sisällön osia kussakin näistä varsinaisista käyttöpaikoista käytetään ja millä tavoin.
Tämän jälkeen on syytä tutustua eri palasiin, joista sisältö koostetaan julkaisuvaiheessa. Ennen varsinaisiin otsikkosisältöihin tutustumista suosittelen muiden sisällön osien tarkistamista. Tällaisia sisällön osia ovat esimerkiksi muuttujat, sisältöviitteet ja tyylitiedostot. Varsinkin muuttujien osalta on syytä tarkistaa, mitä niistä käytetään varsinaisiin sisältöihin ja mitä vain joko sivutunnisteisiin tai muiden muuttujien sisällä. Lisäksi on syytä tarkistaa, onko niissä käytetty tageja muuttujien sisällön julkaisukohtaiseen suodattamiseen. Tyylitiedostojen osalta on syytä saada jonkinlainen yleiskuva ja varmistaa varsinkin kielikohtaisten sisältöjen ja elementtiluokkien tila.
Kun viimein päästään käsiksi pääsisältöön ja sen muotoiluun, täytyy selvittää, millaisiin sääntöihin sisällön muotoilu perustuu ja kuinka tämä sisältö on ehdollistettu. Tämä tarkoittaa sitä, mitä valinnaisia kenttiä kuten sisällön osiointia on käytetty tai jätetty käyttämättä, sekä muita muotoilun yksityiskohtia kuten isojen alkukirjaimien käyttöpaikkoja. Ehdollistamisen osalta on tärkeää varmistaa, että se jatkuu yhdenmukaisena halki kaiken sisällön. Muussa tapauksessa eri tavoin ehdollistetut osuudet samoissa julkaisuissa käyttäytyvät eri tavoin julkaisuvaiheessa.