Skriftlig InfoMetodikkBruk av variabler i tekstenUlemper med variabler

Ulemper med variabler

Nå er det ikke slik at variabler fikser alle utfordringer med gjenbruk. Det er også noen ulemper man må være klar over.

Det er fristende å bare kaste seg over slik funksjonalitet, for deretter å ta den mer eller mindre ukritisk i bruk. Ikke gjør det. Tro meg, jeg har prøvd.

Du må ta stilling til variablene dine hver gang du publiserer

Hvis du har brukt mange variabler i kildefilen(e) dine må du alltid gi de verdier når du publiserer. Glemmer du å gi dem en verdi får du i beste fall en feilmelding fra publikasjonssystemet ditt. Hvis ikke blir verdiene bare stående med en ukjent - eller kanskje helt feil - verdi

Det blir lett for mange variabler

Det er fort gjort å lage svært mange variabler. For mye av det gode blir da en utfordring. For hver eneste publikasjon må du da huske hvilke variabler som skal ha hvilke verdier. I mange verktøy vil disse innstillingene være en del av publikasjonens innstillinger. Det kan like fullt by på problemer med nye versjoner eller nye varianter. Andre medlemmer av skriveteamet og nye kollegaer vil muligens være ukjent med variablene og verdiene, og det kan fort bli feil.

Det er vanskelig å oppdage feil

Variabler brukes jo normalt på små tekstfragmenter som har lett for å "forsvinne" i brødtekst. Det kan være vanskelig å oppdage disse når du sitter med den ferdige PDF'en.

Variabler "varer evig"

Variabler "varer evig" i dokumentasjonssystemet ditt. Straks uheldige variabler blir tatt i bruk kan de være svært vanskelige å bli kvitt.

Variabler kan misbrukes

Jeg har sett at uerfarne forfattere bruker variabler feil. Spesielt gjøres dette når en variabel brukes for å definere navnet på en enhet i produktet. Hvis verdien er definert i entall "jukses" det når en flertallsbetegnelse trengs i teksten.

Eksempel

Du trenger kanskje trenger denne setningen:

All the computers must be protected by a password.

Ordet "computer" er en variabel, men er definert i entall. Du kan da IKKE skrive:

<p>All the &ComputerType;s must be protected by a password.</p>

Denne måten å jukse på - ved å legge en "s" etter variabelen - ser fint ut på engelsk, men det lar seg ikke oversette. I slike tilfelle må du definere en ny variabel ComputerTypePlural som kan brukes når du trenger ordet "computers".

Variabler kan medføre oversettingsproblemer

Variabler kan gi problemer når teksten skal oversettes.

Eksempel

En av de variablene jeg bruker svært mye er ProduktNavn. Når variabelen brukes i en komplett publikasjon står denne i en kontekst som også definerer hva slags produkt det er snakk om. Utfordringen dukker opp når enkelte språk tillegger ulike produkter et kjønn. Jeg skriver bare på engelsk, og da kan en setning se slik ut:

Use the Range function to specify the maximum theoretical vertical depth covered by the EK80.

På engelsk vil jeg alltid skrive "the EK80" uansett hva slags produkt det er snakk om. På spansk og fransk er derimot forskjellige produkttyper tilegnet et grammatikalsk kjønn. Produktet EK80 er på disse språkene hankjønn, og setningen må derfor inneholde "el EK80". Hva skjer da hvis dette tekstelementet oversettes til "le EK80" og den samme setningen i en annen publikasjon brukes med et produkt som er hunkjønn? Da skal det på spansk stå "la EK80"!

Denne problematikken voldte oversetterne en god del bryderi. De vil levere oversettelser som er grammatikal korrekte, og hadde liten forståelse for at mine tekstfragmenter kunne gjenbrukes i "alle slags" produkter uten at noen på forhånd kunne vite om produktet var hankjønn eller hunkjønn.

Utfordringen ble løst ved å endre teksten ved å legge til ordet "system" etter produktnavnet.

Use the Range function to specify the maximum theoretical vertical depth covered by the EK80 system.

Ved å bruke dette ordet ble produktet alltid hankjønn, slik at oversettelsen "el sistema EK80" ville være korrekt over alt.

Vi hadde en rekke diskusjoner med våre oversettere. Etter å ha hørt på deres argumenter og råd fjernet vi de fleste variablene fra våre tekster.

Tips

Hvis du jobber med DITA-publisering vet du sikkert at DITA har svært god støtte for bruk av variabler. Du finner mer om dette under overskriften DITA variabler.


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.