Skriftlig Info ➜ DITA-publisering ➜ DITA variabler ➜ Variabeldefinisjoner i et bibliotek (library topic)

Beskrivelsen på denne siden inkluderer en metode som bruker varref-attributtet. Dette attributtet er ikke en del av DITA-standarden. Det er et proprietært attributt som flere DITA-systemleverandører støtter.

I beskrivelsene, prosedyrene og eksemplene bruker jeg <keyword>-elementet. I mange DITA-systemer kan du også bruke andre elementer. Elementene må være definert i systemfilene som styrer publiseringssystemets funksjonalitet. Ta kontakt med systemleverandøren din for mer informasjon om dette.

Jeg vil anbefale at dere standardiserer på bruken av <keyword>-elementet for variabler. Selv om det er tillatt på bruke andre elementer er det lettere å være konsekvent. Dette øker forståelsen i teamet, og letter vedlikeholdet. Spesielt nye brukere vil lettere kunne identifisere hva som er variabler og hva som ikke er.

Dette er nødvendig kode for å definere en variabel kalt "VARIABLE" med en verdi satt til "VERDI". Koden vil ikke se slik ut i editoren din, da de fleste editorer foretrekker en mer brukervennlig presentasjon.

Åpne et bibliotek. Skriv inn følgende kode. Sett gjerne koden i en <p>-element. Det er ofte lettere å få oversikt over definisjonene når de vises på egne tekstlinjer.

<p>
<keyword varid="VARIABEL">
      VERDI
</keyword>
</p>

Du kan opprette så mange <keyword>-definisjoner som du vil i et bibliotek, og hver kan ha hvilken verdi du ønsker.

Hvis noen av verdiene har ren tekst som trenger oversettelse må du inkludere biblioteket blant filene du sender til oversetteren. Hvis du trenger å gjøre dette anbefaler jeg å dokumentere hver variabel og forklare hvordan de brukes.

Variabelen "VARIABLE" kan brukes i en topic eller bibliotek (topic library) på denne måten:

<p>
....
<keyword varref="VARIABLE">
    VALUE
</keyword>
....
</p>

<keyword>-taggen kan plasseres hvor som helst det er bruk for den. I dette eksempelet har jeg brukt den i et <p>-element, men du kan like gjerne plassere det i for eksempel et <title> eller <cmd>-element. Bruk attributten varref for å hente inn riktig variabel.

Når du bruker <keyword>-taggen i en topic eller et bibliotek kan innholdet i VALUE være hvilken som helst tilfeldig tekst. Du kan også skrive inn hva du vil i <keyword>-taggen. Når dokumentet publiseres vil publiseringsprosessen automatisk hente den riktige verdien fra definisjonen og sette den inn. Dette betyr at du kan sette inn <keyword>-taggen fra hvilket som helst bibliotek, eller kopiere det fra en annen topic. Sørg bare for at varref-attributten peker til riktig variabel.

Biblioteket med <keyword>-definisjonene må settes inn i publikasjonen som en ressurs-fil. Dette gjøres i publiseringsprogrammet.