Skriftlig Info ➜ DITA-publisering ➜ DITA topics ➜ Om DITA emner (topics)
Her er en den "offisielle" beskrivelsen fra Oasis (i min oversettelse):
Et emne er en informasjonsenhet med tittel og innhold, kort nok til å være spesifikk for et enkelt emne eller svare på et enkelt spørsmål, men lang nok til å gi mening alene og være skrevet som en enhet.
Oasis, "DITA topics", docs.oasis-open.org, [REF]
Wikipedia har en side om emnebasert skriving. Der finner jeg denne beskrivelsen av en topic (i min oversettelse):
Et emne (topic) er et frittstående informasjonsobjekt som:
- fokuserer på ett emne
- har et identifiserbart formål
- krever ikke ekstern kontekst for å bli forstått
Emner kan skrives for å være uavhengige av hverandre og gjenbrukes der det er nødvendig.
Wikipedia, "Topic-based authoring", en.wikipedia.org, [REF]
Basert på disse forklaringene definerer jeg en DITA topic på følgende måte:
Et DITA emne (engelsk: DITA topic) er en frittstående datamodul som inneholder multimodal tekst. Modulen har en tittel og nok informasjon til å forklare en spesifikk prosedyre eller et konsept. Enhvert emne er skrevet på en slik måte at det er uavhengig av andre emner og kan gjenbrukes i ulike publikasjoner når dette er hensiktsmessig. Innholdet i emnet er presentert i en flat struktur. Struktur og kontekst etableres når emnet settes inn i et emnekart (engelsk: topic map) sammen med andre emner.
Ethvert emne (topic) inneholder et antall elementer. Hvert element har en start-tag og en stopp-tag. Elementene er satt inn i en struktur og rekkefølge som følger de grunnleggende reglene i DITA. Den multimodale teksten som elementene inneholder danner det totale budskapet som emnet formidler.
Det er noen grunnleggende egenskaper som hver topic må tilfredstille:
Fokus
Den må være fokusert og må kun beskrive ett emne.
Formål
Den må ha et formål. Dette formålet er for eksempel en forklaring, en prosedyre, en spesifikasjon eller en detaljert beskrivelse.
Gjenbrukbar
Forutsatt at informasjonen i topic'en er korrekt må du kunne ta den ut av en gitt publikasjon og bruke det omigjen i en annen.
Generisk
Den må ikke forutsette en spesifikk plassering i en definert publikasjon eller kontekst. Dette betyr at en topic i prinsippet kan plasseres hvor som helst i hvilken som helt publikasjon.
Frittstående
Den må ikke forutsette at leseren har lest annen informasjon først, eller på annen måte blitt forklart noe først. Det må være fullstendig frittstående.
Ingen referanser
Den må ikke inneholde tekst med referanser til andre topics. Den må ikke henvise direkte til noe som forklares et annet sted i publikasjonen.
Formatuavhengig
Den må ikke forutsette at den kun skal publiseres på et spesifikt format, for eksempel bare PDF.
I denne sammenhengen er det viktig å forstå hva som menes med "frittstående". Tanken er at leseren skal slå opp i boken, finne akkurat det han eller hun trenger i et frittstående avsnitt, og deretter lukke boken igjen. Det skal ikke være nødvendig å ha lest noe annet i boken først for å få full nytte av teksten.
La meg belyse det med et konkret eksempel fra virkeligheten.
Da jeg satte meg inn i bilen skumpet jeg borti rattet, og rattlåsen ble aktivert. Ingen fare, tenkte jeg, og trykket på startknappen. Hvorpå bilen gladelig meddelte at den ikke ville starte når rattlåsen var aktivert. Hva gjør man da? Bruksanvisningen lå i hanskerommet, og jeg søkte opp "rattlås" i indeksregisteret. På side 152 fant jeg en enkel prosedyre på fem step som forklarte hva jeg skulle gjøre. Alt stod på den siden, jeg trengte ikke å lese noe annet. Hvorpå jeg lukket boken og startet bilen.
En bok vil selvfølgelig inneholde mange topics. Disse må du sette i riktig rekkefølge, og du må lage en passende struktur med kapitler og avsnitt. Alt dette gjøres i ett eller flere topic maps.
I DITA versjon 1.2 brukes følgende typer topics:
Task topic
En task topic skal inneholde en prosedyre. Og bare en. Prosedyren skal forklare hvordan noe gjøres, det vil si hvordan en oppgave (task) utføres.
Concept topic
En concept topic skal inneholde en konseptuell beskrivelse, det vil si hva noe er, eller hvordan det virker. Informasjonen skal utvide leserens forståelse når en prosedyre skal utføres, eller bidra med informasjon som det er "viktig" for leseren å få.
Reference
En reference topic skal også inneholde en konseptuell beskrivelse, men emnet er forbehold informasjon av typen "referanseinformasjon". Dette er informasjon som leseren "kanskje" trenger, eller som det er "kjekt å vite". Jeg sier gjerne at det er tekster forbeholdt de leserne som ønsker å bli "eksperter".
I DITA versjon 1.2 er også følgende topics tilgjengelige, men ikke så mye brukt:
Glossary topic
En glossary topic har en spesialisert struktur for å beskrive ett ord eller et uttrykk i en ordliste.
Glossary group
En glossary group topic er en spesialisering som lar leg legge mange glossary topics inn i en gruppe.
General Task
En general task topic skal inneholde det samme som en vanlig task topic, men strukturen er friere. I mange tilfelle betegnes task topic som "strict task topic". Hensikten med general task topic er å¨gjøre det enklere å overføre informasjon fra andre kilder enn DITA hvor strukturen ikke er så streng.
Machinery Task
En machinery task topic skal også inneholde en prosedyre. Forskjellen fra de andre ligger i strukturen.
I DITA versjon 1.3 introduserte en ny type topic:
Troubleshooting
En troubleshooting topic inneholder en standardisert struktur for å forklare feilsøking.
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
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.