Darwin Information Typing Architecture

Darwin Information Typing Architecture ( DITA ) este un format de document similar cu bine - cunoscut DocBook . DITA este dezvoltat de Comitetul Tehnic OASIS DITA ca o arhitectură gratuită și este disponibil gratuit ca definiție tip document (DTD). DITA se bazează pe XML : spre deosebire de DocBook, nu există o definiție a tipului de document (DTD) bazată pe SGML pentru DITA .

Conform definiției oficiale din specificația arhitecturii (în continuare în traducere germană), DITA

„... o arhitectură pentru a crea conținut orientat către subiect, tipat de informații, sub forma unei singure surse, care poate fi reutilizat într-o varietate de moduri. DITA este, de asemenea, o arhitectură pentru a crea noi tipuri de informații și pentru a descrie noi domenii de informații pe baza tipurilor și domeniilor existente. Acest lucru permite grupurilor de utilizatori să creeze definiții de tipuri de documente foarte specifice, direcționate, utilizând un proces numit specializare care păstrează în continuare transformări de ieșire comune și linii directoare de stil pentru tipuri și domenii mai generale. "

introducere

Numele Darwin Information Typing Architecture apare după cum urmează:

  • Darwin - DITA folosește specializarea și moștenirea , analog ideilor lui Charles Darwin despre originea speciilor .
  • Tastarea informațiilor - Unitățile de informații sunt tastate în DITA în funcție de conținutul lor.
  • Arhitectură - DITA este o arhitectură. Nu este doar un DTD, ci conține și reguli pentru derivarea de noi unități de informații.

DITA este o arhitectură bazată pe XML pentru crearea, distribuirea și refolosirea informațiilor tehnice. Arhitectura constă dintr-o serie de reguli de proiectare care permit crearea unor module de informații „tipizate” la nivelul așa-numitelor „subiecte”.

Scopul DITA este de a sprijini „mecanismul unic de transcludere” (vezi și „ Transcludere ”), care este specificat ca parte a unei reguli de procesare DTD: un element

„Se poate înlocui cu un alt element de același tip care se află fie în subiectul curent, fie într-un subiect separat care utilizează aceleași modele de conținut. Mecanismul de transcluziune al DITA este similar cu mecanismul SGML-conref, care folosește un element gol ca referință la un alt element ne-gol. Cu toate acestea, DITA necesită cel puțin un model de conținut minim pentru elementul de referință și efectuează verificări în timpul procesării pentru a se asigura că elementul de înlocuire este valid în noul său context. Acest mecanism depășește mecanismul standard XInclude, deoarece conținutul poate fi inserat numai dacă este echivalent: dacă tipurile elementului de reutilizare (referențiere) și reutilizat (referențiat) diferă, referința la conținut nu este rezolvată. Mecanismul de transcludere al DITA depășește, de asemenea, mecanismul standard de reutilizare a entității, deoarece conținutul reutilizat poate locui într-un fișier XML cu un DTD. Rezultatul final este că conținutul reciclat este validat mai degrabă la punctul de creare decât la punctul de reutilizare, iar problemele se găsesc la sursa lor. "

poveste

În anii 1990, compania IBM și-a creat propriile SGML -DTD complexe (inclusiv IBMIDDoc ) pentru documentarea numeroaselor sale produse. Pe parcursul dezvoltării ulterioare, a apărut sarcina de a proiecta un nou standard pentru documentația tehnică care ar trebui să susțină un grad ridicat de reutilizare. Un alt obiectiv important a fost de a oferi utilizatorilor posibilitatea de a extinde modelul informațional fără a deveni incompatibil cu alte aplicații compatibile DITA. IBMIDDoc sau alt XML -DTD cum ar fi DocBook , TEI sau XHTML au fost examinate. Ca urmare, s-a decis dezvoltarea unui nou format de document cu DITA.

La 3 mai 2005, DITA 1.0 a fost predat de IBM către OASIS și adoptat ca standard OASIS.

În august 2007, DITA 1.1 a fost adoptat ca standard OASIS. Principalele inovații includ specializarea hărții de carte și formalizarea sintaxei DITAVAL pentru filtrarea conținutului.

La 1 decembrie 2010 specificația DITA 1.2 a fost adoptată ca standard OASIS cu numeroase inovații. O inovație majoră în această versiune este adresarea indirectă utilizând o cheie unică. Hărțile schemelor de subiect permit controlul valorilor atributelor și modelarea taxonomiilor . Constrângere mecanism și noi elemente sunt menite să faciliteze adaptarea modelului de conținut. Această versiune extinde, de asemenea, standardul pentru a include noi mecanisme de reutilizare a conținutului. Versiunea 1.2 adaugă noi specializări modelului de conținut ( industria mașinilor , instruire ).

La 17 decembrie 2015, specificația DITA 1.3 a fost adoptată ca standard OASIS. Din această versiune, DITA acceptă Relax NG ca limbaj de schemă normativă . Versiunea grupează specificația în trei pachete succesive: bază , conținut tehnic și All Inclusive . Adresarea indirectă este extinsă pentru a include opțiunea de a atribui mai multe valori diferite unei chei. Această versiune introduce, de asemenea, noul tip de subiect de depanare și noi domenii pentru gestionarea lansărilor , MathML și SVG . În octombrie 2016, DITA V1.3 Errata 01 a fost adoptată de OASIS.

Caracteristici și fundaluri

DITA se caracterizează în principal prin următoarele proprietăți:

  • Focusul subiectului - Cel mai înalt nivel de abstractizare al DITA este „Topic”. Alte structuri situate deasupra unui subiect sunt mai susceptibile de a fi informații care aparțin procesului unui astfel de subiect. De exemplu, ar putea naviga pe o pagină de ajutor. Mai mult, subiectele nu mai sunt imbricate. „Secțiunile”, care oferă subiectelor conținut, sunt ideale pentru organizarea subiectelor.
  • Reutilizare - Un obiectiv al DITA este reducerea redundanței și, prin urmare, necesitatea copierii informațiilor. Informațiile pot fi utilizate în mai multe locuri, dar conținutul există o singură dată.

Definiții:

  • Subiect: un subiect este o unitate de informații care este determinată de titlu și conținut. Această unitate trebuie să fie suficient de scurtă pentru a acoperi un singur subiect sau pentru a răspunde la o singură întrebare. Cu toate acestea, trebuie să fie suficient de suficient pentru a putea sta singur cu sens și pentru a fi dezvoltat în continuare singur.
  • Harta: hărțile sunt documente în care referințele individuale la subiecte sunt colectate și organizate în mod semnificativ. Acestea formează astfel unitatea logică și paranteză asupra anumitor subiecte. Ele pot servi, de asemenea, ca schiță sau cuprins pentru rezultatele DITA și, astfel, ca „manifeste de construcție” pentru proiecte complete DITA.
  • Specializare: Specializarea permite definirea de noi „tipuri de informații” („tipuri structurale” sau „noi domenii de informații”). Cu toate acestea, majoritatea informațiilor ar trebui reutilizate, astfel încât costurile de înlocuire, migrare și întreținere să poată fi reduse la minimum.
  • Integrare: Fiecare specializare are propriul modul de proiectare. La rândul lor, aceste module pot genera alte tipuri de documente într-o formă combinată. Procesul de creare a unor noi tipuri de documente prin combinarea diferitelor module se numește „integrare”.
  • Adaptare: În cazul în care numai rezultatul lucrării („rezultatul”) este necesar în diferite forme, poate fi utilizată o adaptare a DITA. Aceasta adaptează ieșirea fără a afecta portabilitatea și schimbul.

Avantajele și comparația cu DocBook

Acest articol sau secțiune trebuie revizuit. Detalii ar trebui să fie date pe pagina de discuții . Vă rugăm să ajutați la îmbunătățirea acestuia și apoi eliminați acest semnalizator.

Comparativ cu DocBook, DITA este considerat a fi mai ușor de învățat. În timp ce DocBook este destinat mai mult ca un șablon pentru cărți complexe și documentație în format carte, DITA își propune să mapeze informațiile tehnice ca „subiecte” care pot fi utilizate în diferite contexte. DITA folosește, de asemenea, multe elemente din HTML .

Iată o comparație:

Avantajul DITA față de DocBook

  • DocBook este destinat în principal pentru crearea și livrarea de cărți, în timp ce DITA, pe de altă parte, se concentrează pe crearea și livrarea „Subiectelor”. Cu toate acestea, aceste subiecte pot fi apoi îmbinate în cărți ca o colecție sau legate și, astfel, servesc drept informații de ajutor, site-uri web sau, de exemplu, ca rezumate pentru PDA-uri .
  • DocBook este strict ierarhic și nu oferă niciun mecanism pentru a separa conținutul de context. DITA este mult mai flexibil și poate grupa informații dependente de context în diferite documente. DITA poate stoca subiecte cu orice nivel al unei structuri definite.
  • DocBook este un set de elemente și atribute. DITA este extensibil și poate fi adaptat nevoilor și cerințelor individuale: regulile de specializare definesc structura tipurilor individuale de informații care pot utiliza elementele standard existente.

Avantajul DocBook față de DITA

  • DocBook a fost extins activ și actualizat constant de mai bine de zece ani.
  • DocBook este documentat în detaliu și a fost testat cu succes în multe cazuri practice. Ajutor de la marea comunitate DocBook este disponibil peste tot.
  • DocBook sprijină deja un număr mare de formate țintă , cum ar fi Eclipse, EPUB , FO , HTML, HTMLHelp , JavaHelp, manpages , Webhelp și XHTML cu "DocBook" foile de stil .
  • Din versiunea 5 DocBook oferă un topicelement.
  • De la versiunea 5.1 (în curs de dezvoltare) va exista un assemblyelement (similar cu o hartă în DITA) care îmbunătățește reciclarea.

exemplu

<topic id="maintaining" xml:lang="en-us">
   <title>Maintaining</title>
   <shortdesc>
      You maintain your solution to ensure that all components are operating at maximum efficiency.
   </shortdesc>
   <body>
      <p>
         Maintenance is a task that you perform along with configuration to get the most from your solution.
      </p>
   </body>
</topic>

Vezi si

  • mumasy , o schemă XML standardizată VDMA pentru documentație tehnică

literatură

  • Sissi Closs : Single Source Publishing. Structurarea orientată spre subiect și DITA . Developer Press, 2007 ISBN 978-3-935042-98-7
  • Johannes Hentrich: DITA - Noul standard pentru documentația tehnică . XLcontent-Verlag, 2008, ISBN 978-3-9811430-0-3
  • Jennifer Linton, Kylene Bruski: Introducere în DITA: Ghid de utilizare a arhitecturii de tipare a informațiilor Darwin. Servicii Comtech, Colorado 2006

Link-uri web

Dovezi individuale

  1. ↑ OASIS Darwin Information Typing Architecture (DITA) TC | OAZĂ. Accesat la 1 august 2020 .
  2. ↑ a b Specificații arhitecturale DITA , Capitolul 2, Introducere în DITA.
  3. ^ Întrebări frecvente despre arhitectura de tipare a informațiilor Darwin. 28 septembrie 2005, accesat la 1 august 2020 .
  4. ↑ a b Eliot Kimber: DITA pentru practicieni Volumul 1: Arhitectură și tehnologie . Prima ediție. XML Press, 2012, ISBN 978-1-937434-06-9 .
  5. ↑ Despre specificația DITA 1.1. Adus la 4 august 2020 (engleză americană).
  6. ↑ Publicat #DITA V1.3 OASIS Standard | OAZĂ. Accesat la 1 august 2020 .
  7. ↑ Leigh W. White: DITA 1.3 Articol principal: Înțelegerea cheilor cu domeniu de aplicare în DITA 1.3. În: https://www.oasis-open.org/ . Comitetul tehnic de adopție OASIS DITA, 9 septembrie 2015, accesat la 1 august 2020 .
  8. ↑ Membrii aprobă DITA 1.3 ca standard OASIS pentru autorizare și publicare | OAZĂ. Adus pe 4 august 2020 .
  9. ↑ conform Namahn, 2001 ( Memento din 12 mai 2005 în Arhiva Internet ) (PDF)