Skriftlig Info ➜ DITA-publisering ➜ DITA variabler ➜ Om variabler i DITA

I mange tilfelle er det kun spesifikke egennavn (for eksempel navnet på produktet) som gjør at et fragment ikke kan brukes flere steder.

Dette gir oss et dilemma.

• På den ene siden er det ofte hensiktsmessig å kunne identifisere produktnavnet, produsenten eller andre unike karakteristika i tekstfragmentene for å unngå "overgeneralisering".
• På den andre siden er det nettopp slike karakteristika som gjør at tekstfragmenter ikke kan gjenbrukes.

For å kunne bruke et gitt tekstfragmenter i mange forskjellige kontekster brukes derfor variabler i teksten.

Variabler i en tekst kan sammenliknes med de variabler som defineres når man skriver programvare. Normalt vil variablene der defineres tidlig i kildekoden.

Til å begynne med: Hva er en variabel?

Deretter: Hva er forskjell på en variabel og en verdi?

DITA har faktisk ikke noe eget element for å definere variabler. Ikke desto mindre kan vi bruke attributtet keyref for å oppnå ønsket funksjonalitet. Avhengig av hvilket publiseringssystem du bruker er det et annet alternativ, nemlig varref-attributtet. Derfor pleier jeg å si at det er to måter å definere en variabel på og gi den en verdi.

1. Du kan opprette en topic map og bruke <keydef>-elementet.

   Dette er den vanlige måten å definere variabler på. I topic'en din bruker du da for eksempel <keyword>-elementet med attributten keyref.

2. Du kan opprette en library topic og bruke <keyword>-elementet.

   Andre elementer kan også brukes. For å definere variabler på¨denne måten kreves det at DITA-systemet ditt støtter bruken av varref-attributtet. Dette attributtet er ikke definert i DITA-standarden, men er et mye brukt proprietært attributt. Bruken av varref-attributtet, <keyword>-elementet, og eventuelt andre elementer, bestemmes av den DTD'en (Document Type Definition) som du bruker.

Både library topic og topic map kan inneholde flere definisjoner, og hver variabel kan ha hvilken som helst verdi du ønsker.

Følgende forslag til grunnleggende regler er basert på flere års erfaring:

1. Alle variablene du bruker må være standardiserte.

   Det kan ikke være mulig for individuelle arbeidsgruppemedlemmer å definere variabler selv. Å definere variabler må være en administratoroppgave. Uten et standardisert system er det umulig å etablere effektiv gjenbruk.

2. Alle variabler må kommuniseres til alle medlemmer av arbeidsgruppen.

   Hver forfatter må tydelig forstå hvordan de skal bruke variablene, og deres formål.

3. Alle variabler må dokumenteres.

   Det må utarbeides en skriftlig beskrivelse av hver variabel. Denne beskrivelsen skal forklare formålet med variabelen, hva den brukes til, hvordan den brukes, og hva slags verdier den kan ha. Slik dokumentasjon er viktig for intern bruk, men enda viktigere for de som skal oversette.

4. Vær forsiktig når du velger hvilke variabler du skal etablere.

   Det er lurt å være restriktiv. Å bruke variabler er en veldig effektiv funksjon, men det blir vanskelig hvis en forfatter må forholde seg til ukjente variabler. Det samme er tilfellet hvis du må hente inn mange ukjente variabler for å publisere ditt dokument.

5. Vær oppmerksom på komplikasjoner med oversettelser.

   Hvis du oversetter publikasjonene dine utgjør variabler en stor utfordring for oversetterne. Du kan ikke anta at oversetterne er kjent med funksjonaliteten. Oversetteren må også forholde seg til ukjente variabler, inkludert verdier som er vanskelige å oversette når de tas ut av kontekst. Vi har også erfart at verdiene definert i ulike kombinasjoner kan være vanskelige å oversette fordi ulike språk opererer med ulike grammatiske kjønn. Vi hadde flere diskusjoner med våre oversettere. Etter å ha lyttet til deres argumenter og råd, fjernet vi de fleste variablene fra tekstene våre.