Et stem topic er en frittstående datamodul (normalt en concept topic) som bare inneholder en tittel (<title>) og eventuell en kort introduksjon (<shortdesc>). Denne modulen brukes for å etablere en frittstående overskrift i begynnelsen av et kapittel eller avsnitt. Modulen hentes inn i emnekartet ved hjelp av <chapter> eller <topicref>, og de strukturelt underliggende modulene nestes inn i modulen. Uttrykket "stem topic" er ikke definert i den offisielle DITA-standardene.

Uttrykket "stem topic" er heller ikke noe standard betegnelse som du finner på http://docs.oasis-open.org. Ikke desto mindre er det en topic som i mange tilfelle er nødvendig. Ulike DITA-brukere har forskjellige navn på den.

Grunnleggende egenskaper

En stem topic inneholder en <title>, kanskje en <shortdesc>, og muligens indekstermer. En stem topic brukes for å plassere en overskrift foran et antall topics på et underliggende nivå.

Hensikt og bruk

For å forstå hensikten med en stem topic må vi se på den strukturen vi bygger opp i en map. Her brukes en bookmap:

Det første kapittelet inneholder fem topics i en flat struktur, slik:

Kapittel 1
1. Avsnitt 1
2. Avsnitt 2
3. Avsnitt 3
4. Avsnitt 4
5. Avsnitt 5

De fem avsnittene har hver sin tittel og inneholder mer eller mindre tekst. Disse er plassert inn under kapittel 1. Dette kapittelet skal også ha en tittel, men ingen tekst. Siden <chapter> nødvendigvis må være en topic lager vi en stem topic som bare inneholder den ønskede tittelen. På den måten får vi en struktur som for eksempel ser slik ut:

Introduksjon
1. Om denne publikasjonen
2. Produktbeskrivelse
3. Systemttegning
4. Hovedbestanddeler
5. Hjelp og støtte

For å lage en stem med tittelen "Introduksjon" brukes slike DITA-elementer:

<concept>
...
   <title>Introduksjon</title>
   <shortdesc>(Eventuelt)</shortdesc>
   <conceptbody>(Tom)</conceptbody>
...
</concept>

Eksempel

Eksempelet i illustrasjonen viser hvordan en stem topic kun inneholder tittelen Operating procedures.

Naturligvis kan en stem topic inneholder mer enn bare tittelen. Hvor mye informasjon en slik stem skal inneholde før det blir en "vanlig topic" må det lages en regel for i skriveteamet. I mitt team har vi bestemt at en stem topic bare skal inneholde en tittel (<title>), men at der er lov å legge til en generisk introduksjon (<shortdesc>). Hvorvidt det er lov å legge inn indekser må dere bli enige om i skriveteamet. Her må dere lage regler.

Fordelen med å lage regler rundt dette er at svært mange titler brukes i svært mange bøker. Det betyr at en stem topic som for eksempel inneholder tittelen Introduksjon kan brukes om igjen i utallige publikasjoner. Slik gjenbruk gjør at titler (og helst også struktur) blir konsekvent i alle publikasjoner hvor stem topic'en gjenbrukes. Det er også bare nødvendig å oversette den en gang. Ved å gjenbruke stem topics er det også enklere å etablere linker mellom de ulike delene av publikasjonen.

Relaterte prosedyrer

Lage en ny DITA topic fra en mal

Lage en ny DITA topic ved å duplisere en eksisterende topic

Sette en topic inn i en topic map

Sette en topic inn i en bookmap