Skriftlig Info ➜ DITA-publisering ➜ DITA variabler ➜ Variabeldefinisjoner i en topic map

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.

Et vanlig emnekart (topic map) brukes.

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

<map>
...
<keydef keys="VARIABLE">
  <topicmeta>
    <navtitle>
      <keywords>
        <keyword>VALUE</keyword>
      </keywords>
    </navtitle>
  </topicmeta>
</keydef>
...
</map>

Du kan opprette så mange <keydef> definisjoner som du ønsker i en topic map, og hver kan ha hvilken verdi du vil.

Hvis noen av verdiene har vanlig tekst som trenger oversettelse, må topic map'en inkluderes i filene du sender til oversetteren. Hvis du trenger å gjøre dette anbefaler jeg at du dokumenterer hver eneste variabel og forklarer hvordan de brukes.

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

<p>
...
<keyword keyref="VARIABLE">
...
</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 keyref 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 keyref-attributten peker til riktig variabel.

Emnekartet med <keydef>-definisjoner må settes inn i <frontmatter>-taggen i bookmap'en din. Bruk <mapref>-taggen.