Tarjoamme heidän tarpeitaan vastaavan valmiiksi kirjoitetun tyylitiedoston uusille asiakkaille, jotka ottavat käyttöön DoX CMS -järjestelmän. Tämä artikkeli käy läpi yksityiskohdat, jotka sitä koskevassa ohjeistuksessa tulee huomioida. Näistä huomioista voi kuitenkin olla hyötyä myös muille, joiden täytyy suunnitella tyylitiedostoja.
Nämä tyylitiedostoja koskevat vaateet on jaettu kolmeen osioon: 1. ensisijaiseen julkaisumuotoon (PDF vai HTML), 2. tekstin yksityiskohtiin ja 3. elementtikohtaisiin huomioihin.
Ensisijainen Julkaisumuoto
Eri julkaisumuodoilla on omat erityispiirteensä ja -vaateensa ja tästä syystä on hyvä ajatus erottaa niitä varten tehdyt tyylitiedostot toisistaan. Kaksi rakenteisen dokumentoinnin pääjulkaisutyyppiä ovat verkkojulkaisuihin käytetty HTML ja kirjamuotoinen PDF. Tyylitiedoston kirjoittamisen kannalta on tärkeää tietää, kummanko tiedostotyypin julkaisuihin sitä tullaan käyttämään ja kuinka kyseisen tiedostotyypin erityispiirteet halutaan huomioida.
HTML-julkaisut
HTML-julkaisuja käytetään verkossa ja usein myös esimerkiksi virtuaaliympäristöissä. Kun DoX VAD -otetaan käyttöön, HTML-julkaisut ovat sen kanssa parhaiten yhteensopiva vaihtoehto. HTML-julkaisujen osalta on tärkeää tietää valmispohjan tunnisteet niihin tehtävien muokkauksien varalta sekä käytetäänkö muotoilussa tämän julkaisumuodon sallimia aktiivisia elementtejä.
Valmispohjat
Usein HTML-sisältöjä käytetään osana ympäristöä, jonka kautta sille lisätään kehykset. Näillä ympäristöillä on omat tyylitiedostonsa, mutta tyylitiedostot liitetään usein yhteen osana verkkosivun kasaamista. Vaikka teillä ei olisi suoraa pääsyä kyseiseen tyylitiedostoon, on julkaisun tyylitiedostoon mahdollista lisätä tätä kehystä koskevia sääntöjä ja tehdä niistä yliajavia !important-määritteellä.
Jos pohjaan täytyy tehdä sovituksia julkaisujen käyttöön kirjoitettavan tyylitiedoston kautta, täytyy sitä varten tietää kehyksen elementtien tunnisteet. Tällöin niitä on mahdollista käyttää tyylitiedoston kohdistajiin.
Lisäksi on tärkeää tietää, onko kehyksen tyylitiedostossa sääntöjä koskien eri elementtejä. Usein esimerkiksi sisällön eri tasojen otsikoiden koko on vakioitu. Samat yksityiskohdat on parasta määrittää myös osana kirjoitettavaa tyylitiedostoa, jotta sitä voidaan tarvittaessa käyttää myös muissa asiayhteyksissä ja tyyli säilyy yhtenäisenä niiden välillä. Lisäksi on tärkeää tietää, mitä mittayksiköitä, värejä ja fontteja kyseinen täydentävä tyylitiedosto käyttää. Tällöin myös uusi tyylitiedosto voidaan kirjoittaa valinnoiltaan yhteneväiseksi.
Aktiiviset Elementit
HTML tukee erilaisia aktiivisia sisältöjen muutoksia kuten animaatioita ja vuorovaikutettavia sisältöjä. Jos näitä ominaisuuksia halutaan käyttää, tulee käyttötavat suunnitella ennalta.
Animaatiot on parasta kytkeä vuorovaikutuksiin ja ne antavat esimerkiksi säädellä linkin värin vaihtumisen siirtymää, kun osoitin siirretään linkin ylle. On tosin tärkeää huomioida, että esimerkiksi kuvien kokoon liittyvää siirtymää ei voi tehdä suoraan kokoa säätämällä. Keinoja sen tekemiseen löytyy, mutta ne täytyy huomioida myös esimerkiksi käytettävien kuvien koon osalta.
Tärkeimmät vuorovaikutuksen muodot ovat osoittimen siirtäminen elementin ylle (:hover) ja elementin valitseminen (:active tai :focus). Niiden avulla on mahdollista hallinnoida esimerkiksi kuvien kokoa, taulukoiden rivien värejä, tekstin kokoa, tekstiefektejä kuten lihavointia ja linkkien värejä.
PDF-julkaisut
Tärkeimmät PDF-julkaisujen vaatimat ratkaisut tyylitiedostoon koskevat sivunvaihtojen hallinnointia sekä sivutunnisteita. Lisäksi on hyvä miettiä sisällysluettelon asettelun yksityiskohtia.
Sivunvaihdot
Sivunvaihtojen hallinnointi kattaa halutun tason osioiden aloittamisen uudelta sivulta sekä ehdot vähimmäissisällöille kullakin sivulla. Aiempi artikkeli aiheesta löytyy täältä. Taulukkojen osalta on tärkeää myös tiedostaa ennalta, kuinka taulukoita tullaan käyttämään: nämä säännöt eivät automaattisesti huomioi, onko koko taulukko riittävän pieni tullakseen aina siirretyksi seuraavalle sivulle, tai sen rivien korkeutta. Eri tilanteisiin voidaan vaatia erilaisia sääntöjä, jotka ovat toteutettavissa elementtiluokilla.
Sivutunnisteet
Sivujen ylä- ja alatunnisteet ovat olennainen osa PDF-julkaisuja. Niiden osalta täytyy päättää, halutaanko niistä symmetrisiä vai epäsymmetrisiä, sekä mitä tietoja niihin lisätään. Lisäksi niissä käytettävät kuvaelementit täytyy tietenkin toimittaa soveliaassa muodossa.
DoX CMS antaa käyttää muuttujia osana sivutunnisteita ja tunnisteiden sisältö voidaan ehdollistaa. Tällä tavoin on mahdollista esimerkiksi kertoa, onko kyse koevedoksesta. Lisäksi täytyy päättää sivunumeroinnin muotoilu eli esimerkiksi, näytetäänkö myös dokumentin sivujen kokonaismäärä, ja minkä tason sisältöjen otsikko mahdollisesti näytetään sivutunnisteissa.
Sisällysluettelo
Sisällysluettelon toteutus vaatii lähinnä kunkin sisällön tason otsikoiden syvennyksien koon päättämistä. Lisäksi on mahdollista päättää, tuleeko otsikoiden ja sivunumeroiden väliin merkkejä kuten pisteitä, sekä käytetäänkö osalle otsikoista pienempää fonttia. On myös tärkeää tietää, halutaanko sivunumerointi tai sivutunnisteet aloittaa jo sisällysluettelossa vai vasta leipäsisällössä.
Tekstin Muotoilu
Tekstin muotoilua koskevat säännöt ovat kenties tärkein osuus tyylitiedostoa, koska dokumentit koostuvat ensisijaisesti tekstistä. Tämä kattaa sekä leipätekstin että otsikoinnin. Jotkin elementit kuten taulukot voivat myös käyttää omia muotoilusääntöjään esimerkiksi tekstin kirjasinkoon osalta. Tämä osio käsittelee värikoodeja, fontteja, koon yksityiskohtia ja välityksien sekä syvennyksien toteutusta.
Värikoodit
Usein yrityksillä on niille ominainen paletti, joka on määritetty niiden sisäisessä markkinoinnin tyylioppaassa. Joskus näitä paletteja on useampia eri käyttötarkoituksiin eikä ulkopuolisille ole selvää, mitä niistä tulisi käyttää. Ajoittain nämä oppaat eivät edes sisällä tarkkaa värikoodia vaan pelkästään värinäytteitä. Värikoodilla tarkoitetaan joko värikohtaista heksatunnistetta kuten #0ff1ce tai RGB(A)-arvoa kuten (15, 241, 206). Jälkimmäisessä tapauksessa läpinäkyvyys on neljäs arvo väliltä 0 (täysin läpinäkyvä) ja 1 (täysin peittävä).
Tyylitiedostoa varten tulee toimittaa tarkat värikoodit, joita käytetään värjättäville tekstin osuuksille tai niiden taustoille. Lisäksi täytyy kertoa, mitkä osiot värjätään ja millä tavoin. Tämä kattaa eri tasojen otsikot, jos niille halutaan käyttää eri värejä kuten eri harmaan sävyjä.
Fontit
Jos käyttöön otetaan vakivalinnoista poikkeavia fontteja, tulee ne toimittaa. Jos käytetään useampaa fonttia, tulee kertoa, missä kutakin niistä käytetään. Mikäli ennakkoon tiedetään, että käännöksiä eri aakkostoja käyttäville kielille tullaan tekemään, tulisi näiden aakkostojen osalta käytettävät fontit myös toimittaa ennakkoon. Ne voidaan tällöin määrittää käyttöön kielikohtaisesti.
Fontteja koskevat vaateet koskevat myös kansilehtiä ja niiden otsikointia, jos ne tehdään järjestelmän sisäisesti eikä erillisellä asetteluohjelmistolla. Lisätietoja kannen asettelun suosituksista löytyy täältä.
Tekstikoko
MS Word ilmoittaa fonttikoot pisteissä (pt), mutta muualla voi olla hyvä ajatus käyttää eri yksiköitä kuten pikseleitä (px). Lisäksi varsinkin HTML-julkaisuja varten on parasta käyttää suhteellisia yksiköitä kuten kertoimia yläelementin fonttikokoon (em) tai prosentteja yläelementin mitoista (%). Lista käytettävistä olevista yksiköistä löytyy täältä.
Välitykset ja Syvennykset
Itse tekstin muotoilun lisäksi on tietenkin välttämätöntä myös asetella se. Iso osa tätä koostuu marginaaleista ja toppauksista (padding) sekä pysty- että sivusuunnassa.
Jos joitakin sisältöjä kuten huomioelementtien ikoneita halutaan asettaa sivumarginaalien sisään, täytyy sen toteuttamistapaan liittyviä vaateita ja rajoitteita harkita erityisen tarkkaan. Jos tämä esimerkiksi tehdään käyttämällä ikonia elementin taustakuvana, täytyy kyseisille elementeille määrittää vähimmäiskorkeus, jolla estetään kyseisen taustakuvan leikkautuminen korkeussuunnassa.
Lisäksi taulukot voivat vaatia sovituksia tässä suhteessa. Suosituksemme on samojen syvennyksien käyttäminen jokaisessa sarakkeessa. On mahdollista ylläpitää erotuksia sarakkeiden välillä, mutta niihin liittyy aina riskejä jaettujen solujen tapauksessa. Näin syntyviin ongelmiin vastaaminen voi vaatia lisätoimenpiteitä kuten elementtiluokilla tehtyjä kohdistettuja korjauksia.
Elementtikohtaiset Huomiot
Erilaisiin elementteihin liittyen on omia vaateitaan, jotka tulee huomioida. Täällä käsitellään näistä 1. numerointilogiikka, 2. taulukot, 3. kuvat, 4. huomioelementit, 5. kansilehdet ja 6. poikkeustilanteet yleisiin sääntöihin.
Numerointilogiikka
Otsikoitaville elementeille kuten kuvakehyksille (fig) ja täysille taulukoille tulee määrittää muoto, jossa niiden numerotunnisteet merkitään. DoX CMS:ssä tämä tapahtuu Asetukset-valikossa ja toistaiseksi kaikkien elementtien numerointi käyttää samaa formaattia.
Olennaisin päätös tässä suhteessa on, halutaanko tämä numerointi tehdä koko dokumentin pituudelta kasvavaksi vai suhteutetaanko se osioihin. On helpompaa laskea, monesko kyseisenlainen elementti on kyseessä koko dokumentin sisällä. Toisaalta esimerkiksi pääosioiden näyttäminen osana numerointia auttaa löytämään oikeat sijainnit helpommin, jos niihin viitataan kauempaa. Jos puolestaan kyseisenlaisia elementtejä on usein useampia kussakin otsikkosisällössä, voi olla hyvä ilmoittaa, monesko niistä on kyseessä.
Taulukot
Taulukot ovat monimutkaisin elementtityyppi, joiden toteutustapa vaatii useita päätöksiä. Usein tarvitaan useita erilaisia sääntöjä seuraavia taulukoita, jotka saadaan erotettua muista asianmukaisilla tunnisteilla kuten elementtiluokilla.
Kenties tärkein päätös on, käytetäänkö sarakkeiden leveyden säätämiseen sisällöt huomioivaa asetusta vai määräjakoa. Sisällön huomiointi on altis rikkoutumiselle, joka vaatii ongelmakohtien paikantamista usein näkemättä suoraan, minne toimet tulee kohdistaa. Lisäksi se voi johtaa eri tavoin tasautuviin sarakkeisiin eri kielten tai peräkkäisten muutoin vastaavien taulukoiden osalta. Määräjako tarkoittaa tasajakoa muutoin leveydeltään määrittämättömien sarakkeiden osalta. Tällöin korostuu sarakkeiden leveyden säätäminen antamalla vaaditut arvot itse. Tällöin sisältö voi ylittää sarakkeiden rajat, jos se on liian leveää, mutta nämä kohdat on mahdollista jäljittää ja korjata tarkkarajaisesti.
Lisäksi taulukoiden määrityksiin kuuluu myös, halutaanko niissä käyttää taustavärejä esimerkiksi joka toisella rivillä, sekä käytetäänkö joissakin sarakkeissa eri toppauksia kuin toisissa. Tällaiset säädöt eivät kuitenkaan usein toimi oikein, kun soluja jaetaan. Tästä syystä ne vaativat joko solujen jakamisen välttämistä tai elementtiluokkia, joilla tilanne saadaan korjattua.
Kuvat
Kuvien osalta on tärkeää määrittää puitteet niiden koolle eri asiayhteyksissä. Usein ei ole mielekästä määrittää kuvatiedostojen kokoa valmiiksi loppukäyttöpaikkoihin mitoitetuksi. Tämä on mahdollista tehdä tyylitiedoston kautta asettamalla vähimmäis- ja enimmäiskoot kuvatiedostoille, mieluiten osana muita elementtejä kuten kuvakehyksien (Fig) tai taulukoiden sisällä. Näin on mahdollista esimerkiksi tehdä suurien kuvien asettumisesta ennakoitavampaa suhteessa niiden haluttuun sijoitteluun.
Lisäksi kuville on mahdollista määrittää esimerkiksi niiden ympärille kiedotut kehykset. Kehyksille puolestaan tulee määrittää niiden tyyli, paksuus ja väri, jos niitä käytetään. Myös kaikki nämä yksityiskohdat on mahdollista kohdistaa erikseen tiettyihin käyttöyhteyksiin.
Huomioelementit
Kuten täällä on mainittu, huomioelementtien (note) tyyli vaatii erityishuomiota. Ne koostuvat usein useammasta tyylitiedoston kautta lisätystä osiosta ja erilaisiin ratkaisuihin liittyy omat rajoituksensa. Tärkeimmät näistä osista ovat erityyppisten huomioelementtien ikonit ja niiden otsikot.
Toisin kuin sisällössä suoraan käytettävien kuvien, tyylitiedoston kautta lisättävien kuvien olisi ihanteellista olla oikean kokoisia jo ennakkoon. Näin lisättyjen sisältöjen hallinnointi on rajatumpaa kuin sisällön kuvaelementtien. Jos ne halutaan upottaa marginaaliin, vaatii tämä joko kaikkien muiden elementtien sivumarginaalien hallinnointia erikseen tai kuvien asettamista omaksi elementikseen. Jos taustakuvana käytetty kuva siirretään yleistasolla määritettyyn sivumarginaaliin käyttämällä negatiivista marginaaliarvoa, jää se piiloon.
Huomioelementtien otsikot ovat yksinkertaisempia hallinnoida, mutta niiden kääntämisen hallinnointiin löytyy muutama eri keino. Nämä sisällöt voidaan joko määrittää kielikohtaisesti tyylitiedostossa tai ne voidaan hakea otsikkosisällöstä, jossa on käytetty asianmukaista käännösmuuttujaa. Jälkimmäisessä tapauksessa hakutapana voidaan käyttää keinoa, joka piilottaa nämä sisällöt niiden alkuperäisessä sijainnissa.
Näiden otsikoiden toteuttaminen tyylitiedoston kautta vaatii ::before-tunnistetta. Kullakin elementillä voi olla vain yksi näin määritetty sisältö. Jos ikoni siirretään sivumarginaaliin sitä käyttämällä, ei huomioelementin otsikkoa voi lisätä tavalliseen tapaan. Tällöin paras ratkaisu on sen kirjoittaminen osaksi sisältöä esimerkiksi käyttämällä muuttujia.
Kansilehdet
Jos kansilehtiä ei tehdä ulkoisella ohjelmistolla esimerkiksi PDF-otsikoksi, vaativat ne paljon muotoilua. Yleensä on välttämätöntä tietää, mitä kaikkia tietoja kuhunkin kansilehteen voi tulla. Tällöin niille voidaan määrittää säännöt esimerkiksi elementtiluokkien avulla. Lisäksi täytyy tietää, käytetäänkö eri julkaisuille eri kansilehtiä. Tällöin niille täytyy käytännössä käyttää eri tyylitiedostoja, jos kansilehtien taustakuvat on määritetty tyylitiedoston kautta.
Kansilehtien tyyli voidaan tehdä tyylitiedostoon kirjoitetun pohjan avulla. Tällöin kansilehtenä käytettävän otsikkosisällön elementtien järjestys määrittää niiden sijoittelun. Tämä voidaan myös tehdä käyttämällä kullekin osalle elementtiluokkaa, jolloin käyttäjä hallinnoi kannen asettelua osana kirjoitusprosessia.
Poikkeustilanteet
Tyylitiedosto antaa yleisluontoisia sääntöjä sekä ehdollistettuja sääntöjä. Ehdollistaminen vaatii tilannekohtaisia tunnisteita kuten käytettyä kieltä. Iso osa näistä tunnisteista on sisäänrakennettuja välttämättömiin tarpeisiin vastaamiseksi. Jos kuitenkin juuri teillä tarvitaan muita erotteluita, DoX CMS:ssä sille saadaan tunnisteet käyttämällä elementtiluokkia.
Elementtiluokilla saadaan esimerkiksi tehtyä eri näköisiä taulukoita ja taulukkopohjia. Niillä voi tarvittaessa värjätä tekstiä tai antaa sille laatikoidun väritaustan. Tällaiset tarpeet tulisi tuntea etukäteen, jos ette hallinnoi itse tyylitiedostoanne, koska elementtiluokkien vaikutukset täytyy edelleen määrittää tyylitiedoston kautta.
Yhteenveto
Tyylitiedostot joutuvat ennakoimaan kaikki dokumenttien tarpeet. Tästä syystä nämä tarpeet tulee tiedostaa tyylitiedoston kirjoittamisvaiheessa. Jos tyylitiedoston toteuttaja on ulkoinen taho kuten me, täytyy nämä tarpeet kommunikoida selvästi ja niihin liittyvät rajoitteet tiedostaen. Kukin ratkaisu tyylitiedostossa vaikuttaa osaltaan vaateisiin koskien itse kirjoittamisprosessia.
Tarpeet erilaisten julkaisumuotojen ja erilaisten poikkeustilanteiden osalta on erityisen tärkeää huomioida. Aina ei myöskään ole saatavilla helppoa ratkaisua, jolla saataisiin toisinnettua esimerkiksi MS Wordin toiminnallisuutta kuten aktiivista solukohtaista taulukoiden hallinnointia. On täysin mahdollista, että tyylitiedoston kautta tehtävissä oleva ratkaisu vaatii jonkinlaista kompromissia, joka tulee huomioida myös sisällöntuotannon osalta.