Architektura psaní informací od Darwina - Darwin Information Typing Architecture

DITA
Architektura psaní informací od Darwina
PostaveníPublikováno
Nejprve publikovánoČerven 2005; před 15 lety (2005-06)
Nejnovější verzeDITA 1.3
Část0: Přehled
Část 1: Základní vydání
Část 2: Vydání technického obsahu
Část 3: All-Inclusive Edition
19. června 2018; Před 2 roky (2018-06-19)
OrganizaceOÁZA
VýborArchitektura psaní podle Darwina (DITA) TC
RedaktořiRobert D. Anderson, Kristen James Eberlein
Základní standardyXML, HTML
DoménaPsaní informací
ZkratkaDITA
webová stránkadokumenty.oasis-open.org/ dita/ dita/ v1.3/

The Architektura psaní informací od Darwina (DITA) specifikace definuje sadu typů dokumentů pro vytváření a organizování tématicky orientovaných informací a také sadu mechanismů pro kombinování, rozšiřování a omezování typů dokumentů.[1] Je to otevřený standard[2] který je definován a udržován OÁZA Technická komise DITA.[3]

Název je odvozen z následujících komponent:

  • Darwin: využívá principy specializace a dědictví, což je v některých ohledech analogické s přírodovědcem Charles Darwin koncept evoluční adaptace,
  • Zadávání informací, což znamená, že každé téma má definovaný primární cíl (postup, vstup do glosáře, informace o řešení problémů) a strukturu,
  • Architektura: DITA je rozšiřitelná sada struktur.[4]

Funkce a omezení

Opakované použití obsahu

Témata jsou základem pro opětovné použití obsahu,[5] a lze je znovu použít v několika publikacích. Fragmenty obsahu v rámci témat lze znovu použít pomocí odkazů na obsah (souhlas nebo conkeyref), a transluce mechanismus.[6]

Psaní informací

Nejnovější verze DITA (DITA 1.3) zahrnuje pět specializovaných typů témat: Úkol, Pojem, Odkaz, Glosář Vstup, a Odstraňování problémů. Každý z těchto pěti typů témat je specializací obecného Téma typ, který obsahuje prvek názvu, prvek prologu pro metadata a prvek těla. Element body obsahuje podobné odstavce, tabulky a seznamy HTML.

  • A Úkol topic je určen pro postup, který popisuje, jak splnit úkol. Uvádí řadu kroků, které uživatelé používají k dosažení zamýšleného výsledku. Kroky jsou obsaženy v prvku taskbody, což je specializace obecného prvku těla. Prvek kroky je specializací prvku uspořádaného seznamu.
  • Pojem informace jsou objektivnější a obsahují definice, pravidla a pokyny.
  • A Odkaz topic je pro témata, která popisují syntaxi příkazů, programovací pokyny a další referenční materiály a obvykle obsahují podrobný věcný materiál.
  • A Glosář Vstup téma se používá k definování jediného smyslu pro daný termín. Kromě identifikace termínu a poskytnutí definice může mít tento typ tématu také základní informace o terminologii spolu s jakýmikoli zkratkami nebo rozšířením zkratek, které se na tento výraz mohou vztahovat.
  • The Odstraňování problémů téma popisuje stav, který může čtenář chtít napravit, následovaný jedním nebo více popisy jeho příčiny a navrhovanými nápravnými opatřeními.

Mapy

Mapa DITA je kontejner pro témata sloužící k transformaci kolekce obsahu do publikace. Poskytuje posloupnost a strukturu témat. Mapa může obsahovat relační tabulky (reltables), které definují hypertextové odkazy mezi tématy.[7] Mapy mohou být vnořeny. Mapy mohou odkazovat na témata nebo jiné mapy a mohou obsahovat různé typy obsahu a metadata.

Metadata

DITA zahrnuje rozsáhlé metadata prvky a atributy, a to jak na úrovni tématu, tak v rámci prvků.[8] Podmíněný text umožňuje filtrování nebo styling obsahu na základě atributů pro publikum, platformu, produkt a další vlastnosti. Profil podmíněného zpracování (.ditaval soubor) se používá k identifikaci hodnot, které se mají použít pro podmíněné zpracování.[9]

Specializace

DITA umožňuje přidávání nových prvků a atributů prostřednictvím specializace základních prvků a atributů DITA. Prostřednictvím specializace může DITA přizpůsobit nové typy témat, typy prvků a atributy podle potřeby pro konkrétní průmyslová odvětví nebo společnosti. Specializace DITA pro konkrétní průmyslová odvětví, jako je polovodič jsou standardizovány prostřednictvím OÁZA technické výbory nebo podvýbory. Mnoho organizací využívajících DITA také vyvíjí své vlastní specializace.

Rozšiřitelnost DITA umožňuje organizacím specializovat DITA definováním konkrétních informačních struktur a při práci s nimi stále používat standardní nástroje. Schopnost definovat informační architektury specifické pro společnost umožňuje společnostem používat DITA k obohacení obsahu o metadata, která pro ně mají smysl, a k prosazování pravidel specifických pro společnost týkající se struktury dokumentů.[6]

Orientace tématu

Hlavní článek: Tématická tvorba

Obsah DITA je vytvářen jako témata, každé jako samostatný soubor XML. Každé téma obvykle pokrývá konkrétní předmět se zvláštním účelem, například koncepční téma, které poskytuje přehled, nebo procedurální téma, které vysvětluje, jak splnit úkol.[10] Obsah by měl být strukturován tak, aby se podobal struktuře souborů, ve kterých je obsažen.[11][12][13]

Vytváření obsahu v DITA

Mapové a tematické dokumenty DITA jsou XML soubory. Stejně jako u HTML, jakékoli obrázky, video soubory nebo jiné soubory, které se musí na výstupu objevit, jsou vloženy pomocí odkazu. Žádný Editor XML nebo dokonce textový editor lze použít k psaní obsahu DITA, v závislosti na úrovni podpory požadované při vytváření. Mezi pomůcky pro tvorbu, které jsou součástí specializovaných editorů, patří WYSIWYG náhled vykreslování, validace a integrace s procesorem DITA DITA-OT nebo ditac.

Publikování obsahu napsaného v DITA

DITA je navržena jako end-to-end architektura. Kromě označení, které prvky, atributy a pravidla jsou součástí jazyka DITA, obsahuje specifikace DITA pravidla pro publikování obsahu DITA v HTML, online nápovědu, tisk, Platforma pro doručování obsahu a další formáty.

Například specifikace DITA naznačuje, že pokud souhlas atribut prvku A obsahuje cestu k prvku B, obsah prvku B se zobrazí v umístění prvku A. Vydavatelská řešení kompatibilní s DITA, známá jako procesory DITA, musí zvládnout souhlas atribut podle zadaného chování. Pravidla existují také pro zpracování dalších bohatých funkcí, jako jsou podmíněný text, indexové značky a odkazy od tématu k tématu. Aplikace, které transformují obsah DITA do jiných formátů a splňují požadavky specifikace DITA pro interpretaci značek DITA, jsou známé jako Procesory DITA.

Lokalizace

DITA poskytuje podporu pro překlad prostřednictvím skupiny atributů lokalizace. Atributy prvku lze nastavit, aby určovaly, zda má být přeložen obsah prvku. Lze určit jazyk obsahu prvku, stejně jako směr psaní, filtrování indexu a některé výrazy, které jsou vloženy při publikování do finálního formátu.[14] Projekt DITA lze převést na XLIFF soubor a zpět do původních map a témat pomocí nástroje DITA-XLIFF Roundtrip Tool pro DITA-OT[15][16] a počítačem podporovaný překlad (CAT) nástroje, jako Editor překladu mečouna nebo Manažer překladu Fluenta DITA, nástroj určený k implementaci pracovního postupu překladu navrženého v článku „Použití XLIFF k překladu projektů DITA“ publikovaného TC DITA Adoption na OASIS.[17]

Dějiny

Standard DITA udržuje OASIS. Nejnovější (aktuální) verze je 1.3, schválená v prosinci 2015. Errata dokument pro DITA 1.3 byl schválen v říjnu 2016. [18]

  • Březen 2001 Úvod do IBM jádra DTD a Schéma XML gramatické soubory a úvodní materiál[19]
  • Duben 2004 Vznikla technická komise OASIS DITA[20]
  • Únor 2005 IBM přispívá do projektu SourceForge původním projektem DITA Open Toolkit; i když je pravidelně zaměňován se standardem DITA, DITA-OT není přidružen k technické komisi OASIS DITA[21]
  • Červen 2005 DITA v1.0 schválen jako standard OASIS
  • Srpen 2007 DITA V1.1 je schválen OASIS; Mezi hlavní funkce patří:
    • Specializace bookmap
    • Formální definice syntaxe DITAVAL pro filtrování obsahu
  • Prosinec 2010 DITA V1.2 je schválen OASIS; Mezi hlavní funkce patří:
    • Nepřímé propojení s klíči
    • Nové funkce opětovného použití obsahu
    • Vylepšená podpora glosáře, včetně zkratek
    • Nové oborové specializace (školení, stroje)
    • Nová podpora pro kontrolované hodnoty / taxonomie (specializace předmětového schématu)
  • 17. prosince 2015 je agentura OASIS schválena pro DITA V1.3; Mezi hlavní funkce patří:
    • Specifikace se nyní dodává ve třech baleních: Base,[22] Technický obsah,[23] a all inclusive (s výukou a tréninkem)[24]
    • Nový typ tématu řešení potíží
    • Schopnost používat klíče s rozsahem
    • Nové domény pro podporu MathML, rovnic a SVG
    • Přidá syntaxi Relax NG XML jako normativní gramatiku pro DITA
  • 25. října 2016 společnost DASA V1.3 Errata 01 schválila společnost OASIS

Ukázky kódu

Ukázka souboru Ditamap (obsah)

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd"> id ="mapa" xml: lang =„cs“>   formát ="dita" href ="sample.dita" navtitle ="Vzorek" zadejte ="téma"/></map>

Hello World (téma DTD)

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> xml: lang =„cs“ id ="vzorek">  <title>Vzorek</title>  <body>  <p>Ahoj světe!</p>  </body></topic>

Ukázka souboru .ditaval (pro kondicionování textu)

<?xml version="1.0" encoding="utf-8"?><val>   att ="publikum" val ="nováček" akce ="zahrnout" />   att ="publikum" val ="expert" akce ="vyloučit" /></val>

Příklad podmíněného textu:

<p>  Jedná se o informace užitečné pro všechny diváky.</p> publikum ="nováček">  Toto jsou informace užitečné pro začínající publikum.</p> publikum ="expert">  Toto jsou informace užitečné pro odborné publikum. </p>

Viz také

Reference

  1. ^ „Architektura Darwin Information Typing Architecture (DITA) verze 1.3“. Citováno 1. listopadu 2020.
  2. ^ „Darwin Information Typing Architecture (DITA) verze 1.2“. Citováno 10. října 2012.
  3. ^ „OASIS Darwin Information Typing Architecture (DITA) TC“. OÁZA. Citováno 5. října 2012.
  4. ^ „Často kladené otázky o architektuře psaní informací Darwinem“. IBM Corporation. Citováno 10. října 2012.
  5. ^ Hackos, JoAnn (2011). Úvod k DITA Druhé vydání: Uživatelská příručka k architektuře psaní informací Darwin, včetně DITA 1.2. Colorado: Comtech Services, Inc. str. 235–239. ISBN  978-0-9778634-3-3.
  6. ^ A b „Úvod do architektury psaní informací Darwinem“. IBM Corporation. Citováno 10. října 2012.
  7. ^ "reltable". OÁZA. Citováno 22. října 2012.
  8. ^ „Prvky metadat“. OÁZA. Citováno 22. října 2012.
  9. ^ "ditaval". OÁZA. Citováno 22. října 2012.
  10. ^ Priestly, Michael; Swope, Amber. „Whitepaper modelu zralosti DITA“ (PDF). IBM Corp a JustSystems. Citováno 22. října 2012.
  11. ^ „Hodnocení DITA jako základu pro implementaci XML“. Scriptorium Publishing Services, Inc. 2009. Citováno 2019-02-12.
  12. ^ „Struktura, DITA a jiný obsah než technická dokumentace…“. Rockley Group. 16. října 2007. Citováno 2009-07-29.
  13. ^ „Průzkum výzev DITA“. WritePoint Ltd. 18. ledna 2010. Archivováno od originál dne 2014-10-23. Citováno 2010-01-21.
  14. ^ „localisation-atts attribute group“. OÁZA. Citováno 15. října 2012.
  15. ^ Schnabel, Bryan. „Zpáteční let DITA-XLIFF pro OT“. Citováno 15. října 2012.
  16. ^ Článek o funkci DITA 1.2: Použití XLIFF k překladu projektů DITA
  17. ^ Použití XLIFF k překladu projektů DITA
  18. ^ „OASIS DITA 1.3 Errata 01“. OASIS Otevřeno. 2016. Citováno 15. března 2018.
  19. ^ „Původní článek DITA od IBM“. IBM. 2001. Citováno 15. března 2018./
  20. ^ „Technická komise OASIS DITA“. OASIS Otevřeno. 2004. Citováno 15. března 2018.
  21. ^ „DITA versus DITA-OT“. Robert D. Anderson, vývojář DITA-OT a editor specifikací DITA. 2016. Citováno 15. března 2018.
  22. ^ „Základní balíček DITA 1.3“. OASIS Otevřeno. 2015. Citováno 15. března 2018.
  23. ^ „Balíček technického obsahu DITA 1.3“. OASIS Otevřeno. 2015. Citováno 15. března 2018.
  24. ^ „All Inclusive balíček DITA 1.3“. OASIS Otevřeno. 2015. Citováno 15. března 2018.

externí odkazy