Darwin Information Typing Architecture

Darwin Information Typing Architecture
Rozszerzenia pliku

.xml,.html

Producent

OASIS

Data opracowania

czerwiec 2005

Ostatnia wersja

DITA 1.3

Otwarty format?

tak

Strona internetowa

Darwin Information Typing Architecture (DITA) – otwarty standard określający zestaw typów dokumentów wykorzystywanych do tworzenia i porządkowania informacji w podejściu topic-based authoring, a także narzędzia do łączenia, rozszerzania i ograniczania typów dokumentów. Jest to otwarty standard definiowany i utrzymywany przez OASIS DITA Technical Committee.

Nazwa standardu została utworzona poprzez połączenie następujących komponentów:

Funkcje i ograniczenia

Ponowne wykorzystanie treści

Podstawą do ponownego wykorzystywania utworzonych treści są topiki, które mogą być używane wielokrotnie w obszarze wielu publikacji. Fragmenty treści zawarte w topikach mogą być ponownie używane dzięki użyciu odniesień (ang. content references) z wykorzystaniem transkluzji.

Typowanie informacji

Najnowsza wersja DITA (DITA 1.3) obejmuje następujące rodzaje topików: Task (pol. zadanie), Concept (pol. pojęcie), Reference (pol. odniesienie), Glossary Entry (pol. wpis do słownika) i Troubleshooting (pol. rozwiązywanie problemów). Każdy z tych pięciu typów jest bardziej wyspecjalizowanym rodzajem bardziej ogólnego topiku, który zawiera elementy tytułu, prologu do metadanych i treści. Element treści zawiera elementy akapitu, tabeli i listy, podobnie jak w HTML.

Mapy

Mapa DITA to kontener na topiki wykorzystywane do przekształcenia zbioru treści w publikację. Określa kolejność i strukturę topików. Mapa może zawierać tabele relacji (ang. relationship tables, reltables), które definiują hiperłącza między topikami. Mapy mogą być zagnieżdżane, mogą również odwoływać się do innych map, topików i zawierać różne typy treści oraz metadane.

Metadane

DITA zawiera obszerne elementy i atrybuty metadanych na poziomie tematu i elementów. Tekst warunkowy umożliwia filtrowanie lub stylizowanie treści w zależności atrybutów odbiorców, platformy, produktu i innych właściwości. Profil przetwarzania warunkowego (.ditaval) służy do identyfikowania wartości, które mają być używane do przetwarzania warunkowego.

Specjalizacja

DITA umożliwia dodawanie nowych elementów i atrybutów poprzez specjalizację podstawowych elementów i atrybutów DITA. Dzięki specjalizacji DITA może dostosowywać nowe typy tematów, typy elementów i atrybuty zgodnie z potrzebami określonych branż lub firm. Specjalizacje DITA dla określonych branż, takich jak przemysł półprzewodników, są standaryzowane przez komitety techniczne lub podkomitety OASIS. Część organizacji korzystających z DITA tworzy własne specjalizacje.

Możliwość rozszerzania DITA pozwala organizacjom na specjalizację DITA poprzez zdefiniowanie określonych struktur informacji przy zachowaniu możliwości używania standardowych narzędzi do pracy z nimi. Możliwość zdefiniowania architektury informacji charakterystycznej dla danej firmy umożliwia używanie DITA do wzbogacania treści o istotne dla firmy metadane oraz do egzekwowania określonych wewnętrznie zasad dotyczących struktury dokumentów.

Topic orientation

Treść DITA jest tworzona jako topiki, z których każdy jest osobnym plikiem XML. Na ogół każdy topik opisuje określony temat w jednym celu, na przykład topik typu Concept zawierający omówienie lub topik typu Procedure wyjaśniający sposób wykonania zadania. Treść powinna mieć strukturę przypominającą strukturę pliku, w którym jest zawarta.

Tworzenie treści w DITA

Mapy DITA oraz dokumenty topików są plikami XML. Podobnie jak w przypadku HTML, wszystkie obrazy, pliki wideo lub inne pliki, które muszą pojawić się w pliku wynikowym, są umieszczane przez odniesienie. Do tworzenia treści DITA można użyć dowolnego edytora XML lub edytora tekstu w zależności od poziomu wsparcia wymaganego podczas tworzenia. Narzędzia wspierające tworzenie treści dostępne w wyspecjalizowanych edytorach obejmują renderowanie podglądu WYSIWYG, sprawdzanie poprawności i integrację z procesorem DITA, takim jak DITA-OT lub ditac.

Publikowanie treści stworzonych w DITA

DITA została zaprojektowana jako architektura end-to-end. Oprócz wskazania, które elementy, atrybuty i reguły są częścią języka DITA, specyfikacja DITA zawiera zasady publikowania treści w formacie HTML, pomocy online, druku, content delivery platform i innych formatach.

Przykładowo specyfikacja DITA wskazuje, że jeśli atrybut conref elementu A zawiera ścieżkę do elementu B, zawartość elementu B zostanie wyświetlona w lokalizacji elementu A. Narzędzia do publikowania zgodne ze standardem DITA, znane jako procesory DITA, muszą obsługiwać atrybut conref zgodnie z określonym zachowaniem. Istnieją również reguły przetwarzania innych zaawansowanych funkcji, takich jak tekst warunkowy, znaczniki indeksu i linki między topikami. Aplikacje, które przekształcają treści DITA na inne formaty i spełniają wymagania specyfikacji DITA dotyczące interpretacji znaczników DITA, są znane jako procesory DITA.

Lokalizacja

DITA zapewnia obsługę tłumaczenia za pośrednictwem grupy atrybutów lokalizacji. Atrybuty elementu można ustawić tak, aby wskazać, czy zawartość elementu powinna zostać przetłumaczona. Istnieje możliwość określenia języka danego elementu, kierunku pisania, filtrowanie indeksu i niektóre terminy wstrzykiwane podczas publikowania do docelowego formatu. Projekt DITA można przekonwertować do pliku XLIFF i z powrotem do oryginalnych map i topików za pomocą narzędzia DITA-XLIFF Roundtrip Tool dla DITA-OT i narzędzi do tłumaczenia wspomaganego komputerowo, np. Fluenta DITA Translation Manager implementującego workflow tłumaczenia sugerowany w artykule „Using XLIFF to Translate DITA Projects” opublikowanym przez DITA Adoption TC w OASIS.

Historia

Standard DITA jest utrzymywany przez OASIS. Najnowsza (aktualna) wersja to 1.3, zatwierdzona w grudniu 2015. Dokument z erratą dla DITA 1.3 został zatwierdzony w czerwcu 2018.

Próbki kodu

Przykładowy plik Ditamap (spis treści)

<?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>

Witaj świecie (topik 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>

Przykładowy plik.ditaval (do warunkowania tekstu)

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

Przykład tekstu warunkowego:

<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>

Realizacje

Nazwa Zastosow Licencja oprogramowania
DITA Open Toolkit Publikowanie Apache License
Oxygen XML Editor Edytor Prawnie zastrzeżony
DITA XMLmind Converter Publikowanie Licencja publiczna Mozilli
Nazwa Rodzaj Licencja oprogramowania

Przypisy

  1. ↑ OASIS DITA Technical Committee, 1 Introduction to DITA 1.3 [online], docs.oasis-open.org [dostęp 2022-08-01] (ang.).
  2. ↑ DITA Version 1.2 Specification [online], docs.oasis-open.org [dostęp 2022-08-01].
  3. 1 2 OASIS Darwin Information Typing Architecture (DITA) TC | OASIS [online], www.oasis-open.org [dostęp 2022-08-01].
  4. ↑ Agnieszka Cierpich, Zapożyczenia angielskie w polszczyźnie korporacyjnej, Katarzyna Stokłosa (red.), Wydawnictwo Naukowe Akademii Ignatianum w Krakowie, 2019, ISBN 978-83-7614-389-7.
  5. ↑ JoAnn T. Hackos, Introduction to DITA. A user guide to the Darwin Information Typing Architecture including DITA 1.2, wyd. 2nd ed, Denver: Comtech Services, 2011, ISBN 978-0-9778634-3-3, OCLC 777187317 [dostęp 2022-08-01].
  6. ↑ reltable [online], docs.oasis-open.org [dostęp 2022-08-01] (ang.).
  7. ↑ Metadata elements [online], docs.oasis-open.org [dostęp 2022-08-01] (ang.).
  8. ↑ DITAVAL elements [online], docs.oasis-open.org [dostęp 2022-08-01] (ang.).
  9. ↑ Michael Priestley, Amber Swope, DITA Maturity Model [online].
  10. 1 2 Assessing DITA as a foundation for XML implementation [online], Scriptorium, 31 grudnia 2009 [dostęp 2022-08-01] (ang.).
  11. ↑ localization-atts attribute group [online], docs.oasis-open.org [dostęp 2022-08-01] (ang.).
  12. ↑ DITA-XLIFF Roundtrip for OT – Browse Files at SourceForge.net [online], sourceforge.net [dostęp 2022-08-01].
  13. ↑ DITA 1.2 Feature Article: Using XLIFF to Translate DITA Projects.
  14. ↑ Using XLIFF to Translate DITA Projects.
  15. ↑ DITA Version 1.3 Specification Errata 02 [online], docs.oasis-open.org [dostęp 2022-08-01].
  16. ↑ DITA vs. DITA-OT? [online], metadita.org [dostęp 2022-08-01].
  17. ↑ DITA Version 1.3 Specification [online], docs.oasis-open.org [dostęp 2022-08-01].
  18. ↑ DITA Version 1.3 Specification [online], docs.oasis-open.org [dostęp 2022-08-01].
  19. ↑ DITA Version 1.3 Specification [online], docs.oasis-open.org [dostęp 2022-08-01].
  20. ↑ Groups – DITA TC Meeting Minutes 29 March 2016 uploaded [online], lists.oasis-open.org [dostęp 2022-08-01].
  21. ↑ Groups – DITA TC Meeting Minutes 19 June 2018 uploaded [online], lists.oasis-open.org [dostęp 2022-08-01].
  22. ↑ DITA Open Toolkit.
  23. ↑ Oxygen XML Editor.
  24. ↑ XMLmind DITA Converter: XMLmind DITA Converter [online], www.xmlmind.com [dostęp 2022-08-01].