Aiemmin kävin läpi, kuinka DoX CMS:n eri ominaisuudet saadaan käyttöön oXygen XML-editorin kanssa, kun sisältöjä muokataan DoX CMS:n WebDav-verkkolevyn kautta. Tällä kertaa esitellään, kuinka sama saadaan tehtyä Adobe FrameMakerin rakenteisen kirjoittamisen näkymässä. Käytetty version on FrameMaker 2020.
On hyvä huomioida, että FrameMaker on rakennettu oXygeniä vahvemmin hyödyntämään (vain) ennalta määritettyjä pohjarakenteita (EDD), joita vasten se jatkuvasti tarkistaa sisältöä. Vaikka esimerkiksi voit kirjoittaa vaaditut tunnisteet myös suoraan editorin XML-näkymässä, seuraa siitä virheilmoitus, jos määritteitä ole asetettu käyttöön muuta kautta.
Puhtaasti henkilökohtaisena anekdoottina: oli lievästi huolestuttavaa, kun FrameMakerin koeversion asennusta ei voinut suorittaa ennen Microsoft Outlookin sulkemista.
Tagit ja Elementtiluokat
Samaan tapaan kuin aiemmin, sekä kullekin tagikategorialle että elementtiluokille täytyy lisätä oma ominaisuutensa (attribute), jonka voit määrittää elementtikohtaisesti editorissa.
Framemakerissa itse lisätyt elementtien mahdolliset ominaisuudet täytyy lisätä osaksi tiedostossa käyttöön otettavaa pohjarakennetta. FrameMakerin pohjarakenteet ovat ns. EDD-tiedostoja (Element Definition Document), jotka vastaavat muualla käytettyjä DTD-tiedostoja (Document Type Definition). EDD-tiedostot käyttävät samaa pohjaformaattia kuin DTD-tiedostot ja sisältävät lisäksi mahdollisuuden lisätä FrameMaker-kohtaisia ohjeita.
Koska EDD-tiedostojen muokkaaminen on huomattavasti raskaampaa kuin muiden ulkoisten editorien vaatimat säädöt, on erityisen tärkeää, että määrität kaikki tarvitsemasi tagit ja elementtiluokat etukäteen DoX CMS:ssä. Jos asiakkaamme käyttävät FrameMakeria ulkoisena editorinaan, voidaan sisäänrakennetusta EDD-tuesta DoX CMS:n ominaisuuksien osalta neuvotella.
Vaiheet DoX CMS:n tagit ja elementtiluokat sisältävien EDD-tiedostojen tekemiseen on listattu alla.
Lataa DoX CMS:n DTD-tiedosto
Koska EDD-tiedoston voi rakentaa DTD-tiedoston varaan, on DoX CMS:n käyttämä DTD-tiedosto hyvä tapa saada suurin osa vaadituista määreistä valmiiksi kirjoitettuna.
DTD-tiedoston saamiseksi sinun täytyy tehdä DITA-formaatin julkaisu mistä tahansa sisällöistä. Pura tällöin ladattava .zip-arkisto johonkin sijaintiin. Sen sisällä oleva schema-kansio sisältää käytetyt .dtd- ja .mod-tiedostot. Tulet tarvitsemaan näistä tiedostoa ’topic.dtd’, jonka voit halutessasi kopioida tai siirtää muualle.
Muuta DTD-tiedosto EDD-tiedostoksi
Kun avaat FrameMakerin, ota ensin käyttöön rakenteinen kirjoittaminen. Tehdäksesi niin, käytä yläpalkista komentoa Edit > Preferences ja valitse tällöin avautuvassa valikossa Product Interface -kentän arvoksi Structured FrameMaker. Paina sitten OK-painiketta.
Tämän jälkeen luo uusi EDD-tiedosto. Avaa ensin ’topic.dtd’ käyttäen FrameMakeria ja kopioi sen sisällöt. Tämän jälkeen käytä yläpalkista komentoa Structure > EDD > New EDD. Periaatteessa voit myös vain luoda uuden tyhjän tiedoston muuta kautta, mutta näin varmistat sen soveltuvuuden.
Valitse kaikki uuden EDD-tiedoston sisällöt ja korvaa ne sisällöillä, jotka kopioit tiedostosta ’topic.dtd’. Tallenna tämä tiedosto .fm-tiedostona. Se on nyt toimiva EDD-tiedosto, mutta sinun täytyy vielä lisätä määreet tageille ja elementtiluokille.
Lisää Tagien ja Elementtiluokkien Määreet
Koska käytettävissä olevat määreet kytketään erikseen kunkin tyypin elementtiin, täytyy sinun lisätä ne erikseen kullekin elementille (jossa niitä tullaan käyttämään). Voit kuitenkin kopioida kunkin elementin määreet ja liittää ne toisiin elementteihin. Niitä ei tarvitse kirjoittaa erikseen joka kerta.
Aloita listan yläpäästä lisätäksesi uusia ominaisuuksia. Valitse elementtikohtaisen ’Attribute List’ -rivin loppuosa ja paina Enter-näppäintä lisätäksesi alla olevaan listaan uusi rivi Name-elementillä. Kirjoita Name-arvoksi tagikategorian tai elementtiluokkien tunniste. Tagikategorian tunniste on ’data-doxattribute-kategoria’, missä ’kategoria’ tulee korvata käytetyn tagikategorian (piilo)tunnisteella. Sinun täytyy lisätä erillinen ominaisuus kutakin tagikategoriaa varten. Elementtiluokkien tunniste on ’doxelementclass’.
Kun olet kirjoittanut ominaisuudelle nimen, paina Enter-näppäintä sen muiden piirteiden määrittämiseksi. Ensin sinun täytyy valita, miten sen arvot annetaan. Jos haluat aina kirjoittaa tagien tai elementtiluokkien nimet esimerkiksi siksi, että kategoriaan lisätään uusia vaihtoehtoja kuten uusien mallien tunnisteita säännöllisesti, voit valita arvoksi ’String’. Tämä on ihanteellista myös, jos samasta kategoriasta on tarpeen käyttää useampia tageja samaan elementtiin. Suosituksemme on kuitenkin valita ’Choice’. Seuraavaksi, valitse ’Optional’.
Jos valitsit ’Choice’, tulisi seuraavan rivin aloittamisen Enter-näppäintä painamalla automaattisesti lisätä ’Choices’-kenttä. Jos niin ei käy, valitse se käyttöön itse. Kirjoita sitten mahdollisiksi arvoiksi kategorian tagien (piilo)tunnisteet. Elementtiluokkien tapauksessa käytä elementtiluokkien tunnisteita. Erota ne toisistaan pystyviivalla (|), jonka molemmin puolin tulee välilyönti.
Toista tämä prosessi kullekin tagikategorialle ja elementtiluokille ja kopioi arvot kaikkiin elementteihin, missä niitä voidaan käyttää. Helpointa on aloittaa uusi lisäys kuhunkin listaan ja poistaa sen ’Name’-kenttä ennen kopioitujen tietojen liittämistä.
Ota EDD-käyttöön Tiedostoissa
Kun EDD-tiedosto näyttää valmiilta, täytyy se vielä ottaa käyttöön otsikkosisällöissä.
Ensimmäinen askel on EDD-tiedoston sisältöjen validointi. Muussa tapauksessa sitä ei saa otettua käyttöön muualla. Käytä tähän ylävalikosta komentoa Structure > Validate. Jos järjestelmä varoittaa mistään kohtaa, on kyse luultavasti puuttuvasta pakollisesta määreestä (kuten ’Optional’-osiosta).
Kun EDD-tiedosto on validoitu onnistuneesti, jätä se auki FrameMakerissa. Avaa DoX CMS:n sisältöjä WebDav-verkkolevyn kautta. Keinot päästä käsiksi siihen löytyvät käyttöoppaasta. Kun sisältö on avattu FrameMakerissa, käytä komentoa File > Import > Element Definitions. Valitse ’Import from Document’ -kenttään EDD-tiedostosi ja napsauta sitten ’Import’-painiketta.
Lisää Tunnisteita Elementteihin
Kun oikein määritetty EDD-tiedosto on otettu käyttöön, tagikategoriat ja elementtiluokat ovat käytettävissä olevia ominaisuuksia eri elementeille. Kun valitset elementin ja käytät oikeasta pystypalkista komentoa ’Attributes’, ovat ne käytettävissä olevia ominaisuuksia listalla.
Jos valitsit näiden ominaisuuksien tyypiksi ’Choice’, niiden arvon kentän napsauttaminen avaa listan käytettävissä olevista arvoista. Jos määritit tyypiksi ’String’, joudut kirjoittamaan käyttämiesi tagien tai elementtiluokkien (piilo)tunnisteet näihin kenttiin.
Muuttujat
Muuttujien toimintaperiaate on edelleen sama kuin myös oXygenissä. Voit siis kirjoittaa ne suoraan tekstiin lisäämällä niiden nimien ympärille kaksi paria aaltosulkeita ({}). Jos siis muuttujan nimi on esimerkiksi ’email-support’, tulisi sinun kirjoittaa dokumenttiin ’{{email-support}}’.
Sama periaate pätee myös järjestelmämuuttujiin, jotka korvautuvat julkaisuvaiheessa järjestelmän sisältä haetuilla arvoilla. Lista järjestelmämuuttujista löytyy DoX CMS:n käyttöoppaasta.
Sisäiset Linkit
Framemaker käyttää valitettavasti omaa ’fm-xref’-tyypin elementtiään muihin kuin ulkoisiin linkkeihin. Vaikka se vastaa tavallisia xref-elementtejä julkaisuvaiheessa, ei se näy DoX CMS:n editorissa tallennuksen jälkeen. Tästä syystä linkit täytyy ensin lisätä ulkoisina linkkeinä ja vaihtaa sisäisiksi tai rinnakkaisiksi linkeiksi niiden DITA-ominaisuuksien kautta.
Lisää ensin xref-elementti Element > Insert Element -komennon kautta. Sen ’Cross-Reference’-valikossa, joka avautuu myös oikeasta pystypalkista, sinun täytyy napsauttaa ’External Xref’ -painiketta. Valitse siellä ’Xref Target(href)’ ja kirjoita siihen haluamasi otsikkosisällön, elementin tai verkko-osoitteen sijainti. Elementtien tapauksessa sinun täytyy sisällyttää arvoon myös niiden otsikkosisällön tunniste ennen elementin tunnistetta, erotettuna siitä vinoviivalla (/).
Lisää linkki painamalla OK-painiketta. Kun kyseessä on sisäinen linkki, valitse se ja avaa sen ominaisuudet painamalla ’Attributes’-painiketta oikeassa pystypalkissa. Vaihda ’scope’-ominaisuuden arvoksi joko ’local’ tai ’peer’. ’Local’ soveltuu saman otsikkosisällön sisäisiin linkkeihin ja ’peer’ linkkeihin muihin otsikkosisältöihin tai niiden elementteihin.
Kuvien tapauksessa joudut ensin käyttämään väliaikaista jonkin tiedoston sijaintia ja sitten muokkaamaan href-arvoa XML-näkymän kautta. Kun WebDav-verkkolevylle lisätään myös liitetiedostojen kansiot, tullaan niiden sijainnit lisäämään hyväksyttäviksi href-arvoiksi, jotka järjestelmä tulkitsee julkaisuvaiheessa. Koska FrameMaker pyrkii lisäämään href-arvoon tiedostoon viittaavan alkuosan, voit toistaiseksi joutua muokkaamaan sen pois DoX CMS:ssä.
Mitä Et Voi Tehdä
FrameMaker sisältää vähemmän lisätoimintoja kuin esimerkiksi oXygen. Kuten xref-esimerkki yllä kuitenkin osoittaa, se ajoittain lisää omia tunnisteitaan elementteihin.
Kaikkein huomattavin toiminto, joka ei sovellu yhteen DoX CMS:n editorin kanssa ja johon liittyviä eroja ei voi vain muokata pois on ’Conditional Tags’. Näitä ehdollistuskeinoja käytettäessä DoX CMS:n editori kieltäytyy avaamasta sisältöjä lainkaan.
Lisäelementit, joita DoX CMS ei (vielä) tue kuten matemaattiset kaavat, näkyvät vain virheilmoituksina DoX CMS:n sisäisessä editorissa. Jos joudut tallentamaan sisältöjä siellä, korvaa tämä virheilmoitus varsinaiset elementit. Tästä syystä niiden käyttöä ei voida suositella, vaikka muut julkaisuputken osat eivät ole rajattuja vain elementteihin, joita editori tukee.