Skriftlig Info ➜ Metodikk ➜ Modulære skriving ➜ Informasjonselementer

Informasjonselementer

Modulær og emnebasert skriving dreier seg om hvordan informasjon kan deles opp i små moduler, såkalte informasjonselementer. Disse elementene kan deretter settes sammen igjen for gjenbrukes i ulike diskurser.

Jeg liker å bruke LEGO-klosser som en metafor her. Ulike klosser kan brukes omigjen og omigjen i forskjellige byggverk. Helt presis er ikke denne metaforen. Hver kloss kan brukes ett sted av gangen. Et informasjonselement kan gjenbrukes i flere publikasjoner samtidig.

Informasjonselement

Et informasjonselement (i andre sammenhenger også kalt datakapsler eller moduler) er en frittstående datamodul i egnet format. Modulen inneholder multimodal tekst organisert som tekstfragmenter. Det er ingen begrensninger på informasjonselementets innhold eller omfang. Elementet kan gjenbrukes i ulike kontekster. Bruken av informasjonselementer forutsetter at gjenbruk skjer ved elektronisk linking i et verktøy som støtter slik funksjonalitet.

Som det fremgår av definisjonen vil ethvert informasjonselement bestå av en eller flere multimodale tekstfragmenter.

Tekstfragment

Et tekstfragment betegner hver enkeltstående bestanddel i et informasjonselement. Tekstfragmentet består av en mulitmodal tekst, og kan for eksempel inneholde et ord, en setning eller en illustrasjon. Som en del av informasjonselementet kan fragmentet gjenbrukes i ulike kontekster. Gjenbruk skjer ved elektronisk linking i et verktøy som støtter slik funksjonalitet.

For å jobbe med informasjonselementer settes det krav til funksjonalitet i det verktøyet du brukes. I første rekke må verktøyet støtte bruk av elektroniske referanser til separate datafiler. Dette er nødvendig for å hente disse datafilene sømløst inn i et hoveddokument. Mange editorer har denne funksjonaliteten, men ikke alle støtter den like bra. Funksjonaliteten finnes også i HTML, hvor <iframe>-elementet kan brukes. Dette elementet har dog en del begrensninger, og kan for eksempel ikke brukes på websider som skal være dynamiske.

I utgangspunktet kan all informasjon i en gitt publikasjon deles opp i små enkeltstående elementer. Det vil desverre resultere i en mengde filer, og uten en database til å holde orden på disse blir det en ganske umulig oppgave. Uten en database betyr det at du bør prioritere hvilke elementer som skal modulariseres. Det er da naturlig å velge de elementene som skal gjenbrukes flere steder.

I Microsoft Word finner du funksjoner de kaller "Quick parts" og "Auto text", mens Adobe InDesign har noe de kaller "Snippets" og "Object libraries". Et søk på Google vil sikkert skaffe deg mer informasjon om disse verktøyene og deres muligheter. Brukere av XML DocBook er utvilsomt kjent med <xref> og <xinclude> mens DITA blant annet bruker conref-funksjonaliteten. Mekanismene i XML er generelt sett langt bedre enn de som brukes i kontorstøtteverktøy.

I DITA kan jobber du med emner (topics). Dette er informasjonselementer som kan gjenbrukes i mange publikasjoner. Du kan også etablere biblioteker (topic library) for å lage elementer med enda større oppløsning. Innholdet i disse biblioteken kan du da gjenbruke i mange emner.

Hvis du ønsker å utvide funksjonaliteten i verktøyet bør du se på mulighete til å bruke variabler og profilering.

Størrelsen på hvert informasjonselement er det du som skal bestemme. Noen ganger kan det være ønskelig å gjenbruke en setning, andre ganger et avsnitt eller en illustrasjon. Min erfaring er at det ofte er hensiktsmessig å gjenbruke informasjon som er viktig, spesielt hvis det dreier seg om helse, miljø og sikkerhet. Ofte kan en viktig merknad med stor suksess gjenbrukes flere ganger i en og samme manual, rett og slett for å påkalle leserens oppmerksomhet så mange steder som mulig.

Eksempel

I noen av mine publikasjoner må vi ofte gjenta grunnleggende forutsetninger for at produktet skal virke tilfredsstillende. Det hjelper ikke å installere en enhet korrekt hvis for eksempel Ethernet-kablene som kunden kommer med er for dårlige. Det samme gjelder støy. Hvis et følsomt måleinstrument plasseres ved siden av en svær motor er det ikke gitt at målingene som gjøres er korrekte. Dette løser jeg ved å lage et informasjonselement som inneholder en merknad. I dette elementet kan jeg spesifisere minimumskravene som gjelder. Hvis disse kravene endres kan jeg rette alle stedene i boken ved kun å editere informasjonselementet. Jeg trenger da ikke bekymre meg om hvor mange steder informasjonen er brukt, for det blir automatisk rettet over alt. Sluttjobben slipper jeg desverre ikke, alle bøker som inneholder informasjonen må jo publiseres på nytt for at endringene skal gjøres gjeldende.

I XML DITA benevnes informasjonselementer som biblioteker, disse omtales normalt som library topics. Hvert bibliotek er en selvstendig fil som kan inneholde en eller flere tekstfragmenter. I DITA kan et slik tekstfragment være et ord, en setning, en samling av setninger eller et fullstendig avsnitt. Funksjonaliteten i DITA lar deg gjenbruke all informasjonen på en gang eller utvalgte deler av den, helt avhengig av hvordan du har organisert tekstfragmentene i biblioteket.

I DITA er det forøvrig vanlig å bruke en database for å holde orden på informasjonselementene.

Relaterte tekster

Introduksjon til XML og DITA

Bruk av variabler i teksten

Profilering av tekstfragmenter


Alle eksterne linker åpner i et nytt vindu. Jeg tar ikke ansvar for informasjon på eksterne nettsteder, selv om jeg har linket til dem. Vennligst rapporter linker som ikke virker.

Informasjonen på denne siden representerer mine personlige meninger, og min egen forståelse av temaet som beskrives. Du kan gjerne linke til siden, men ikke kopiere større deler av innholdet uten tillatelse. Jeg tar ingen ansvar for eventuelle feil, misforståelser eller manglende informasjon om omfattende temaer. Jeg tar heller intet ansvar for feil du måtte gjøre eller forårsake som et resultat av feilaktig eller manglende informasjon. Du kan gjerne bidra med kommentarer, egner erfaringer eller utfyllende informasjon. Se Kontaktinformasjonen.