Darwin Information Typing Architecture -

Darwin Information Typing Architecture

Den Darwin Information Typing Architecture ( DITA ) specifikationen definierar en uppsättning dokumenttyper för redigering och organisera ämnesinriktad information, samt en uppsättning mekanismer för att kombinera, utvidga och begränsa dokumenttyper. Det är en öppen standard som definieras och upprätthålls av OASIS DITA Technical Committee.

Namnet härrör från följande komponenter:

• Darwin: den använder principerna för specialisering och arv , som på vissa sätt är analoga med naturalisten Charles Darwins koncept av evolutionär anpassning,
• Informationstypning: vilket innebär att varje ämne har ett definierat primärt mål (procedur, ordlista, felsökningsinformation) och struktur,
• Arkitektur: DITA är en utbyggbar uppsättning strukturer.

Återanvändning av innehåll

Ämnen är grunden för återanvändning av innehåll och kan återanvändas i flera publikationer. Fragment av innehåll inom ämnen kan återanvändas genom användning av innehållsreferenser ( conref eller conkeyref ), en transklusionsmekanism .

Informationsskrivning

Den senaste versionen av DITA (DITA 1.3) innehåller fem specialiserade ämnetyper: Uppgift , Koncept , Referens , Ordlista och Felsökning . Var och en av dessa fem ämnetyper är en specialisering av en generisk ämnetyp , som innehåller ett titelelement, ett prologelement för metadata och ett kroppselement. Kroppselementet innehåller stycke-, tabell- och listelement, liknande HTML .

• Ett uppgiftsämne är avsett för ett förfarande som beskriver hur man utför en uppgift. Den listar en serie steg som användare följer för att få ett avsett resultat. Stegen finns i ett taskbody -element, som är en specialisering av det generiska kroppselementet. Stegelementet är en specialisering av ett ordnat listelement.
• Konceptinformation är mer objektiv och innehåller definitioner, regler och riktlinjer.
• Ett referensämne är för ämnen som beskriver kommandosyntax, programmeringsinstruktioner och annat referensmaterial och innehåller vanligtvis detaljerat sakligt material.
• Ett ämne i ordlistan används för att definiera en enda känsla av en given term. Förutom att identifiera termen och ge en definition, kan den här ämnetypen också ha grundläggande terminologiinformation, tillsammans med eventuella förkortningar eller förkortningar som kan gälla termen.
• I felsökningsämnet beskrivs ett tillstånd som läsaren kanske vill korrigera, följt av en eller flera beskrivningar av dess orsak och förslag på åtgärder.

Kartor

En DITA -karta är en behållare för ämnen som används för att omvandla en samling innehåll till en publikation. Det ger ämnenas sekvens och struktur. En karta kan innehålla relationstabeller (reltables) som definierar hyperlänkar mellan ämnen. Kartor kan häckas. Kartor kan referera till ämnen eller andra kartor och kan innehålla en mängd olika innehållstyper och metadata.

Metadata

Specialisering

DITA gör det möjligt att lägga till nya element och attribut genom specialisering av grundläggande DITA -element och attribut. Genom specialisering kan DITA rymma nya ämnetyper, elementtyper och attribut som behövs för specifika branscher eller företag. Specialiseringar av DITA för specifika industrier, till exempel halvledarindustrin , är standardiserade genom OASIS tekniska kommittéer eller underkommittéer. Många organisationer som använder DITA utvecklar också sina egna specialiseringar.

Utvidgningen av DITA gör det möjligt för organisationer att specialisera DITA genom att definiera specifika informationsstrukturer och fortfarande använda standardverktyg för att arbeta med dem. Möjligheten att definiera företagsspecifika informationsarkitekturer gör det möjligt för företag att använda DITA för att berika innehåll med metadata som är meningsfullt för dem och att genomdriva företagsspecifika regler för dokumentstruktur.

Ämnesorientering

DITA -innehåll skapas som ämnen, var och en en individuell XML -fil. Normalt täcker varje ämne ett specifikt ämne med ett enstaka syfte, till exempel ett konceptuellt ämne som ger en översikt eller ett förfarandeämne som förklarar hur man utför en uppgift. Innehållet bör vara strukturerat så att det liknar filstrukturen där det finns.

DITA -karta och ämnesdokument är XML -filer. Som med HTML infogas alla bilder, videofiler eller andra filer som måste visas i utdata via referens. Alla XML -redigerare eller till och med textredigerare kan användas för att skriva DITA -innehåll, beroende på vilken stödnivå som krävs vid redigeringen. Hjälpmedel för författning som finns i specialiserade redaktörer inkluderar WYSIWYG- förhandsgranskning, validering och integration med en DITA-processor, som DITA-OT eller ditac .

DITA är utformad som en end-to-end-arkitektur. Förutom att ange vilka element, attribut och regler som ingår i DITA -språket, innehåller DITA -specifikationen regler för publicering av DITA -innehåll i HTML, onlinehjälp, utskrift, Content Delivery Platform och andra format.

Till exempel, DITA specifikationen indikerar att om conref attribut av elementet A innehåller en bana till elementet B , innehållet i elementet B visas i placeringen av elementet A . DITA-kompatibla publiceringslösningar, så kallade DITA-processorer, måste hantera attributet conref enligt det angivna beteendet. Det finns också regler för bearbetning av andra rika funktioner som villkorlig text , indexmarkörer och ämnes-till-ämneslänkar. Program som omvandlar DITA -innehåll till andra format och som uppfyller DITA -specifikationens krav för tolkning av DITA -uppmärkning kallas DITA -processorer .

Lokalisering

DITA tillhandahåller stöd för översättning via lokaliseringsattributgruppen. Elementattribut kan ställas in för att indikera om elementets innehåll ska översättas. Språket för elementinnehållet kan specificeras, liksom skrivriktningen , indexfiltrering och några termer som injiceras vid publicering till det slutliga formatet. Ett DITA-projekt kan konverteras till en XLIFF- fil och tillbaka till sina ursprungliga kartor och ämnen, med hjälp av DITA-XLIFF Roundtrip Tool för DITA-OT och datorassisterade översättning (CAT) verktyg, som Swordfish Translation Editor eller Fluenta DITA Translation Manager , ett verktyg som är utformat för att implementera översättningsarbetsflödet som föreslås av artikeln "Använda XLIFF för att översätta DITA -projekt" publicerad av DITA Adoption TC på OASIS.

DITA -standarden upprätthålls av OASIS. Den senaste (nuvarande) versionen är 1.3, godkänd i december 2015. Ett felaktigt dokument för DITA 1.3 godkändes i oktober 2016.

• Mars 2001 Introduktion av IBM av de grundläggande grammatikfilerna DTD och XML Schema och introduktionsmaterial
• April 2004 bildades OASIS DITA Technical Committee
• Februari 2005 IBM bidrar med det ursprungliga DITA Open Toolkit -projektet till SourceForge; även om det regelbundet förväxlas med DITA-standarden är DITA-OT inte anslutet till OASIS DITA Technical Committee
• Juni 2005 DITA v1.0 godkänd som OASIS -standard
• Augusti 2007 DITA V1.1 är godkänd av OASIS; viktiga funktioner inkluderar:
  • Specialisering av bokkartor
  • Formell definition av DITAVAL -syntax för innehållsfiltrering
• December 2010 DITA V1.2 är godkänt av OASIS; viktiga funktioner inkluderar:
  • Indirekt länkning med nycklar
  • Nya funktioner för återanvändning av innehåll
  • Förbättrat stöd för ordlistor, inklusive akronymer
  • Nya branschspecialiseringar (utbildning, maskiner)
  • Nytt stöd för kontrollerade värden / taxonomier (ämnesinriktning)
• 17 december 2015, DITA V1.3 är godkänt av OASIS; viktiga funktioner inkluderar:
  • Specifikationen levereras nu i tre paket: Bas, tekniskt innehåll och All Inclusive (med lärande och utbildning)
  • Ny felsökningstematyp
  • Möjlighet att använda omfattande nycklar
  • Nya domäner som stöder MathML, ekvationer och SVG
  • Lägger till Relax NG XML -syntax som den normativa grammatiken för DITA
• 25 oktober 2016, DITA V1.3 Errata 01 är godkänt av OASIS

Ditamap -fil (innehållsförteckning) prov

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
<map
 
id=
"map"
 
xml:lang=
"en"
>
  
<topicref
 
format=
"dita"
 
href=
"sample.dita"
 
navtitle=
"Sample"
 
type=
"topic"
/>
</map>

Hej världen (ämne DTD)

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic
 
xml:lang=
"en"
 
id=
"sample"
>
  
<title>
Sample
</title>
  
<body>
  
<p>
Hello World!
</p>
  
</body>
</topic>

.ditaval -filprov (för villkorlig text)

<?xml version="1.0" encoding="utf-8"?>
<val>
  
<prop
 
att=
"audience"
 
val=
"novice"
 
action=
"include"
 
/>
  
<prop
 
att=
"audience"
 
val=
"expert"
 
action=
"exclude"
 
/>
</val>

Exempel på villkorad text:

<p>
  This is information useful for all audiences.
</p>
<p
 
audience=
"novice"
>
  This is information useful for a novice audience.
</p>
<p
 
audience=
"expert"
>
  This is information useful for an expert audience. 
</p>

• Jämförelse av dokumentmarkeringsspråk
• Lista över dokumentmarkeringsspråk

• OASIS Consortium officiella webbplats
• DITA 1.3 -specifikationer
• DITA Open Toolkit officiella webbplats
• DITA.XML.org forum
• DITA -demonstrationen kan laddas ner på GitHub
• Learning DITA - uppsättning självstudier för att lära sig DITA på egen hand
• DITA Self Service Portal
• GitHub -arkiv med exempel på DITA -filer
• LMS -videohandledning för att lära sig skapa DITA -innehåll