Definere en variabel i en topic map

Du kan bruke et emnekart (topic map) til å definere variabler og gi dem de nødvendige verdiene.

(Denne prosedyren er basert på Tridion Docs database og Oxygen XML redigeringsprogram. Andre verktøy har tilsvarende funksjonalitet.)

På denne siden

Forutsetninger
Kontekst
Prosedyre
Merknad

Forutsetninger

Du har alle verktøy tilgjengelig, og rettigheter til å utvikle nytt innhold. En passende mappe er tilgjengelig i databasestrukturen.

Kontekst

Emnekartet (topic map) du skal lage nå kan bare brukes til å definere variabler. Du kan ikke bruke det samme biblioteket for både variabler og tekstfragmenter.

Du kan lage en ny topic map på en av følgende måter:

Du kan duplisere en eksisterende topic map og endre variabeldefinisjonene og/eller verdiene.

Denne eksisterende topic map'en inneholder allerede de riktige variablene, men de har feil verdier.
Du kan definere variablene ved hjelp av en egnet mal.
Malen inneholder forhåndsdefinerte variabler, men ikke nødvendigvis de variablene du trenger. Du må også tilordne de riktige verdiene.
Du kan lage en ny topic map fra bunnen av og manuelt legge inn de nødvendige elementene og attributtene.

Denne topic map'en er i utgangspunktet tom.

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.

Tips

For å identifisere emnekartet jeg bruker til å definere variabler, og gjøre det lettere å finne, omtaler jeg det som et "keymap". Dette er ikke en standard DITA-betegnelse. I databasesystemet ditt foreslår jeg at du oppretter "Keymap" som en map-type i metadataene dine. Unik identifisering gjør at emnekartene med variabeldefinisjoner er enklere å finne.

Prosedyre

Fra editorens hovedmeny, velg Tridion Docs ➜ Browse repository.
I databasestrukturen, naviger til den folderen hvor du ønsker å etablere en ny topic map.
For å duplisere en eksisterende topic map:
1. Høyreklikk på en av de eksisterende topic map'ene og velg Duplicate.
  En kopi av den eksisterende topic map'en blir etablert.
2. Høyreklikk på den nye topic map'en, og velg Properties.
  Pass på at du gjør dette med den nye topic map'en! Du må ikke endre den gamle!
3. I dialogboksen som åpnes, fyll ut alle relevante felt med metadata.
  
  Følg reglene for metadata. Identifiserer den nye topic map'en slik at det tydelig fremgår at den brukes til å definere variabler.
4. Klikk OK.
5. Velg den nye topic map'en, høyreklikk og velg Check out.
6. Angi nye verdier.
  
  Taggene ser slik ut:
```
<keydef keys="VARIABLE">
  <topicmeta>
    <navtitle>
      <keywords>
        <keyword>VALUE</keyword>
      </keywords>
    </navtitle>
  </topicmeta>
</keydef>
```
7. Velg Tridion Docs ➜ Check in når du er ferdig.
For å definere variablene ved hjelp av en mal:
1. På høyre verktøylinje, klikk det grønne +-symbolet for å hente frem relevante maler.
2. Velg ønsket mal.
3. I dialogboksen som åpnes, fyll ut alle relevante felt med metadata.
  
  Følg reglene for metadata. Identifiserer den nye topic map'en slik at det tydelig fremgår at den brukes til å definere variabler.
4. Klikk OK.
5. Velg den nye topic map'en, høyreklikk og velg Check out.
6. Definer de nødvendige variablene ved å endre keydef-attributtene og angi nye verdier i <keyword>-elementet.
  
  Taggene ser slik ut:
```
<keydef keys="VARIABLE">
  <topicmeta>
    <navtitle>
      <keywords>
        <keyword>VALUE</keyword>
      </keywords>
    </navtitle>
  </topicmeta>
</keydef>
```
7. Velg Tridion Docs ➜ Check in når du er ferdig.
For å lage en nytt topic map fra bunnen av:
1. På høyre verktøylinje, klikk det grønne +-symbolet for å hente frem relevante maler.
2. Velg en mal for en tom topic map.
3. I dialogboksen som åpnes, fyll ut alle relevante felt med metadata.
  
  Følg reglene for metadata. Identifiserer den nye topic map'en slik at det tydelig fremgår at den brukes til å definere variabler.
4. Klikk OK.
5. Velg den nye topic map'en, høyreklikk og velg Check out.
6. Legg inn et <keydef>-element.
7. Bygg strukturen som er vist under.
8. Definer de nødvendige variablene ved å sette keydef-attributtene og angi nye verdier i <keyword>-elementet.
  
  Taggene ser slik ut:
```
<keydef keys="VARIABLE">
  <topicmeta>
    <navtitle>
      <keywords>
        <keyword>VALUE</keyword>
      </keywords>
    </navtitle>
  </topicmeta>
</keydef>
```
9. Gjenta (f), (g) og (h) for å definere flere variabler.
10. Velg Tridion Docs ➜ Check in når du er ferdig.

Tips

Vurder å bygge et modulært system med variabeldefinisjoner. Dette tillater gjenbruk av definisjoner og verdier, og gir en høy grad av konsistens.

På disse sidene forklares bare hvordan variabler brukes i DITA-publisering. Hvis du ønsker utfyllende forklaringer rundt prinsippet med variabler, se under Metodikk og spesielt Bruk av variabler i teksten.

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.