Skriftlig Info ➜ Metodikk ➜ Modulære skriving ➜ Innhold i et informasjonselement
Modulær skriving
---
Spar tid og penger med gjenbruk
Innhold i et informasjonselement
Hensikten med slike tekstmoduler er blant annet å spare tid. Faktasetningen(e) som brukes gjør at spesifikk informasjon kan gjentas uten å risikere feil ved eventuelle oppdateringer. De kan også brukes for å gjenbruke struktur, gjenta lister over emner og/eller relaterte emner. De er spesielt nyttige hvis teksten din skal oversettes til et eller flere andre språk.
Det er du som bestemmer hva hvert informasjonselement skal inneholde. Det kan tenkes at verktøyet ditt setter noen begrensninger.
Et typisk informasjonselement kan ofte inneholde:
Hvis du lager en rekke tekniske manualer vil sikkert flere av dem inneholde forskjellige type merknader, og noen av dem må du sikkert bruke mange ganger. Du kan da etablere et informasjonselement for hver merknad, og dette elementet kan du hente inn så ofte som nødvendig.
Bruken av slike generiske tekstmoduler avhenger svært mye av hva slags verktøy du bruker, og hvilken funksjonalitet den tilbyr. Ofte vil disse modulene lagres som separate filer, og da kan du ofte få en liten utfordring med å holde styr på disse filene. I DITA brukes en egen funksjon som kalles <conref>. Denne funksjonen lar deg hente informasjon ut av et "bibliotek". Dette betyr at du i prinsippet kan samle en mengde generiske teksmoduler i ett og samme XML-dokument. Erfaringer viser at dette ikke er lurt, små filer som inneholder lite informasjon er å foretrekke.
Hvis du skal bruke et bilde av døren på en vaskemaskin kan dette bildet etableres som et separat informasjonselement. Hver gang du trenger bildet kan du hente inn filen. Hvis du bruker flere forskjellige dører kan hvert bilde i filen profileres. Da kan du hente inn den samme filen uansett hvilken vaskemaskin du beskriver.
Hvis du beskriver et produkt som bruker elektroniske kretskort har du sikkert med en merknad som advarer mot statisk elektrisitet. Har du 35 forskjellige kretskort er jo ganske dumt å kopiere denne merkanden like mange ganger. Hva da hvis du vil endre den, for eksempel ved å legge inn en illustrasjon eller en hyperlink til utfyllende informasjon?
Profilering av tekstfragmenter
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.