Спецификация Darwin Information Typing Architecture ( DITA ) определяет набор типов документов для создания и организации тематической информации, а также набор механизмов для комбинирования, расширения и ограничения типов документов. [1] Это открытый стандарт [2], который определен и поддерживается Техническим комитетом OASIS DITA. [3]
Дарвиновская архитектура ввода информации | |
Статус | Опубликовано |
---|---|
Впервые опубликовано | Июнь 2005 г . |
Последняя версия | DITA 1.3, часть0: обзор, часть1: базовая версия, часть2: техническая версия, часть3: всеохватывающая версия, 19 июня 2018 г . |
Организация | ОАЗИС |
Комитет | DITA TC |
Редакторы | Роберт Д. Андерсон, Кристен Джеймс Эберлейн |
Базовые стандарты | XML , HTML |
Домен | Ввод информации |
Сокращение | ДИТА |
Веб-сайт | документы |
Название происходит от следующих компонентов:
- Дарвин: он использует принципы специализации и наследования , которые в некотором смысле аналогичны концепции эволюционной адаптации естествоиспытателя Чарльза Дарвина ,
- Ввод информации: это означает, что каждая тема имеет определенную основную цель (процедура, запись в глоссарии, информация для устранения неполадок) и структуру.
- Архитектура: DITA - это расширяемый набор структур. [4]
Особенности и ограничения
Повторное использование контента
Темы являются основой для повторного использования контента [5], и их можно повторно использовать в нескольких публикациях. Фрагменты контента в рамках темы могут быть повторно использованы посредством использования ссылок контента ( conref или conkeyref ), в включение механизма. [6]
Ввод информации
Последняя версия DITA (DITA 1.3) включает пять специализированных типов тем: задача , концепция , справочник , запись в глоссарии и устранение неполадок . Каждый из этих пяти типов тем является специализацией общего типа темы , который содержит элемент заголовка, элемент пролога для метаданных и элемент тела. Элемент body содержит элементы абзаца, таблицы и списка, аналогично HTML .
- Раздел « Задача» предназначен для процедуры, описывающей, как выполнить задачу. В нем перечислен ряд шагов, которым следуют пользователи для достижения желаемого результата. Шаги содержатся в элементе taskbody, который является специализацией общего элемента body. Элемент steps - это специализация элемента упорядоченного списка.
- Информация о концепциях более объективна и содержит определения, правила и рекомендации.
- Ссылка тема по темам , которые описывают синтаксис команды, инструкции по программированию, а также другие справочные материалы, и , как правило , содержит подробные, фактический материал.
- Глоссаяся тема используется для определения единого смысла данного термина. Помимо определения термина и определения, этот тип темы может также содержать базовую терминологическую информацию, а также любые акронимы или расширения акронимов, которые могут относиться к этому термину.
- В разделе « Устранение неполадок» описывается состояние, которое читатель может захотеть исправить, а также одно или несколько описаний его причины и предлагаемые способы устранения.
Карты
Карта DITA - это контейнер для тем, используемых для преобразования коллекции контента в публикацию. Он дает последовательность и структуру тем. Карта может включать таблицы отношений (reltables), которые определяют гиперссылки между темами. [7] Карты могут быть вложенными. Карты могут ссылаться на темы или другие карты и могут содержать различные типы контента и метаданные.
Метаданные
DITA включает в себя обширные элементы и атрибуты метаданных как на уровне темы, так и внутри элементов. [8] Условный текст позволяет фильтровать или стилизовать контент на основе атрибутов аудитории, платформы, продукта и других свойств. Профиль условной обработки ( файл .ditaval ) используется для определения, какие значения должны использоваться для условной обработки. [9]
Специализация
DITA позволяет добавлять новые элементы и атрибуты за счет специализации базовых элементов и атрибутов DITA. Благодаря специализации DITA может размещать новые типы тем, типы элементов и атрибуты по мере необходимости для конкретных отраслей или компаний. Специализации DITA для конкретных отраслей, таких как полупроводниковая промышленность, стандартизированы через технические комитеты или подкомитеты OASIS . Многие организации, использующие DITA, также развивают свои собственные специализации.
Расширяемость DITA позволяет организациям специализировать DITA путем определения конкретных информационных структур и при этом использовать стандартные инструменты для работы с ними. Возможность определять специфические для компании информационные архитектуры позволяет компаниям использовать DITA для обогащения контента значимыми для них метаданными и для обеспечения соблюдения специфических для компании правил в отношении структуры документов. [6]
Тематическая ориентация
Контент DITA создается в виде тем, каждая из которых представляет собой отдельный файл XML. Как правило, каждая тема охватывает конкретную тему с единственной целью, например концептуальную тему, которая предоставляет обзор, или процедурную тему, которая объясняет, как выполнить задачу. [10] Контент должен быть структурирован так, чтобы напоминать файловую структуру, в которой он содержится. [11] [12] [13]
Создание контента в DITA
Карта DITA и тематические документы представляют собой файлы XML . Как и в случае с HTML , любые изображения, видеофайлы или другие файлы, которые должны появиться в выводе, вставляются через ссылку. Любой редактор XML или даже текстовый редактор может использоваться для написания содержимого DITA, в зависимости от уровня поддержки, требуемого при создании. Средства разработки, представленные в специализированных редакторах, включают предварительный рендеринг WYSIWYG , проверку и интеграцию с процессором DITA, таким как DITA-OT или ditac .
Публикация контента, написанного на DITA
DITA разработана как сквозная архитектура. В дополнение к указанию того, какие элементы, атрибуты и правила являются частью языка DITA, спецификация DITA включает правила публикации контента DITA в HTML, онлайн-справке, печати, платформе доставки контента и других форматах.
Например, спецификация DITA указывает на то, что если conref атрибут элемента А содержит путь к элементу B , содержание элемента B будут отображаться в местоположении элемента А . Совместимые с DITA решения для публикации, известные как процессоры DITA, должны обрабатывать атрибут conref в соответствии с указанным поведением. Также существуют правила для обработки других расширенных функций, таких как условный текст , маркеры указателя и ссылки между темами. Приложения, которые преобразуют контент DITA в другие форматы и соответствуют требованиям спецификации DITA для интерпретации разметки DITA, известны как процессоры DITA .
Локализация
DITA обеспечивает поддержку перевода через группу атрибутов локализации. Атрибуты элемента могут быть установлены, чтобы указать, следует ли переводить содержимое элемента. Можно указать язык содержимого элемента, а также направление написания , фильтрацию индекса и некоторые термины, которые вводятся при публикации в окончательном формате. [14] Проект DITA может быть преобразован в файл XLIFF и обратно в исходные карты и темы с помощью инструмента DITA-XLIFF Roundtrip Tool для DITA-OT [15] [16] и инструментов компьютерного перевода (CAT), таких как Swordfish Translation Editor или Fluenta DITA Translation Manager , инструмент, разработанный для реализации рабочего процесса перевода, предложенного в статье «Использование XLIFF для перевода проектов DITA», опубликованной TC DITA Adoption TC в OASIS. [17]
История
Стандарт DITA поддерживается OASIS. Последняя (текущая) версия - 1.3, утверждена в декабре 2015 года. В октябре 2016 года был утвержден документ об ошибках для DITA 1.3. [18]
- Март 2001 г. Представление IBM основных файлов грамматики DTD и XML Schema и вводных материалов [19]
- Апрель 2004 г. Создан технический комитет OASIS DITA [20]
- Февраль 2005 г. IBM вносит в SourceForge исходный проект DITA Open Toolkit; хотя DITA-OT часто путают со стандартом DITA, он не связан с Техническим комитетом OASIS DITA [21]
- Июнь 2005 г. DITA v1.0 утвержден в качестве стандарта OASIS.
- Август 2007 г. DITA V1.1 одобрен OASIS; основные функции включают в себя:
- Специализация Bookmap
- Формальное определение синтаксиса DITAVAL для фильтрации содержимого
- Декабрь 2010 г. DITA V1.2 одобрен OASIS; основные функции включают в себя:
- Косвенное связывание с ключами
- Новые функции повторного использования контента
- Расширенная поддержка глоссария, включая сокращения
- Новые отраслевые специализации (Обучение, Машиностроение)
- Новая поддержка контролируемых значений / таксономий (специализация Subject Scheme)
- 17 декабря 2015 г. DITA V1.3 одобрен OASIS; основные функции включают в себя:
- Спецификация теперь представлена в трех пакетах: Базовый, [22] Технический контент, [23] и Все включено (с обучением и обучением) [24]
- Новый тип темы для устранения неполадок
- Возможность использовать ключи с ограниченной областью действия
- Новые домены для поддержки MathML, уравнений и SVG
- Добавляет синтаксис Relax NG XML в качестве нормативной грамматики для DITA.
- 25 октября 2016 г., DITA V1.3 Errata 01 одобрена OASIS
Примеры кода
Пример файла Ditamap (оглавление)
xml version = "1.0" encoding = "utf-8"?> id = "map" xml : lang = "ru" > format = "dita" href = "sample.dita" navtitle = "Sample" type = "topic" />
Привет, мир (тема DTD)
xml version = "1.0" encoding = "utf-8"?> xml: lang = "ru " id = " sample " > Sample Hello World!