Skriftlig InfoMetodikkBruk av variabler i tekstenPraktisk bruk av variabler

Praktisk bruk av variabler

Hvordan variabler og verdier defineres er avhengig av hvilket verktøy du bruker, og hva slags formater dette verktøyet jobber med.

La meg bruke et eksempel for å vise hvordan variabler brukes. I eksempelet bruker jeg en "kvasikode". Den er ikke reell, men vises kun for å demonstrere poenget.

Eksempel

Jeg har to forskjellige vaskemaskinmodeller; Vaskomat 550R og Vaskomat 600R. Disse modellene er ganske like, men har også en del konkrete forskjeller for å forsvare ulike prisnivå. Den største forskjellen er at 550R bruker et programmeringshjul for betjening, mens 600R er menystyrt med bare noen få knapper. De fleste andre funksjoner og egenskaper er identiske. Det er bestemt at de to produktene skal beskrives i hver sin instruksjonsmanual.

Når du skriver håndboken trenger du kanskje en setning som sier:

Under sentrifugering har Vaskomat 550R en maksimal hastighet på 1200 omdreininger i minuttet.

Hvis du har definert en variabel TypeBetegnelse og gitt denne variabelen verdi 550R kan den samme setningen brukes for alle Vaskomat-maskiner som har denne maksimale sentrifugehastigheten. Hvis du i tillegg definerer Brand og MaksHastighet som variabler kan den samme setningen brukes for alle slags vaskemaskiner - ikke bare Vaskomat - med alle forskjellige omdreiningshastigheter. Variablenes verdier definerer en gang for hver publikasjon du lager fra den samme kildefilen.

Kvasikoden for setningen ser da for eksempel slik ut:

<p>Under sentrifugering har [&Brand;] [&TypeBetegnelse;] en maksimal hastighet på [&MaksHastighet;] omdreininger i minuttet.</p>

Denne koden ser du normalt ikke i editoren, fordi forhåndsvisningen gir deg de definerte verdiene på skjermen.

Arbortext

Hvis du jobber i en arbeidsgruppe er det svært viktig at de variablene du bruker er standardisert. Alle må bruke de samme variablene slik at informasjonselementene og tekstfragmentene kan gjenbrukes av alle. Verdien for hver variabel kan velges fritt for hver publikasjon.

Denne skjermdumpen viser hvordan definisjonen av variabler skjer i XML DocBook i editoren PTC Arbortext. DocBook-standarden støtter variabler, og editoren har en egen dialog for Text entities hvor du kan definere verdier til de variablene som er etablert.

Hvordan definering og verdisetting virker er avhengig av funksjonaliteten som ligger i verktøyet ditt. Siden vi her ser på et XML-eksempel betyr det at det er innstillingene valgt document type definition (DTD), samt de tilpasningene som gjøres i publiseringsløsningen, som gjelder. Dialogen du ser her tillater tre forskjellige variabler, og hver variabel kan ha en verdi som du selv velger.

I XML DITA gjøres definisjoner av variabler og deres verdier normalt i et bibliotek (library topic). Der defineres både variabelen og verdien til denne i en egnet tag.

Keyword

Som du ser av illustrasjonen er det definert en keyword. Denne har fått navnet ProductName og verdien EK80. Slike definisjoner kan i prinsippet hver enkelt forfatter selv gjøre, men vi har innført et regime hvor dette ikke er tillatt.

Når det viste keyword skal benyttes i et tekstfragment ser det slik ut:

Keyword

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.