Дарвиновская архитектура ввода информации - Darwin Information Typing Architecture

DITA
Дарвиновская архитектура ввода информации
Положение делОпубликовано
Впервые опубликованоИюнь 2005 г.; 15 лет назад (2005-06)
Последняя версияDITA 1.3
Часть0: Обзор
Часть 1: Базовое издание
Часть 2: Техническое содержание
Часть 3: Все включено издание
19 июня 2018 г.; 2 года назад (2018-06-19)
ОрганизацияОАЗИС
КомитетАрхитектура типизации информации Дарвина (DITA) TC
РедакторыРоберт Д. Андерсон, Кристен Джеймс Эберлейн
Базовые стандартыXML, HTML
ДоменВвод информации
СокращениеDITA
Интернет сайтдокументы.oasis-open.org/ дита/ дита/ v1.3/

В Дарвиновская архитектура ввода информации (DITA) определяет набор типов документов для создания и организации тематической информации, а также набор механизмов для комбинирования, расширения и ограничения типов документов.[1] Это открытый стандарт[2] который определяется и поддерживается ОАЗИС Технический комитет DITA.[3]

Название происходит от следующих компонентов:

  • Дарвин: он использует принципы специализации и наследование, что в некотором роде аналогично натуралистическому Чарльз Дарвин концепция эволюционной адаптации,
  • Типизация информации, что означает, что каждая тема имеет определенную основную цель (процедура, запись в глоссарии, информация для устранения неполадок) и структура,
  • Архитектура: DITA - это расширяемый набор структур.[4]

Особенности и ограничения

Повторное использование контента

Темы являются основой для повторного использования контента,[5] и может быть повторно использован в нескольких публикациях. Фрагменты контента в темах можно повторно использовать с помощью ссылок на контент (Conref или же Conkeyref), а включение механизм.[6]

Ввод информации

Последняя версия DITA (DITA 1.3) включает пять специализированных типов тем: Задача, Концепция, Ссылка, Глоссарий, и Исправление проблем. Каждый из этих пяти типов тем представляет собой специализацию общего Тема type, который содержит элемент заголовка, элемент пролога для метаданных и элемент body. Элемент body содержит элементы абзаца, таблицы и списка, аналогично HTML.

  • А Задача Тема предназначена для процедуры, описывающей, как выполнить задачу. В нем перечислены шаги, которым следуют пользователи для достижения желаемого результата. Шаги содержатся в элементе taskbody, который является специализацией общего элемента body. Элемент steps - это специализация элемента упорядоченного списка.
  • Концепция информация более объективна, содержит определения, правила и рекомендации.
  • А Ссылка Тема предназначена для тем, которые описывают синтаксис команд, инструкции по программированию и другие справочные материалы и обычно содержат подробные фактические материалы.
  • А Глоссарий тема используется для определения единственного смысла данного термина. Помимо определения термина и определения, этот тип темы может также содержать базовую терминологическую информацию, а также любые акронимы или расширения акронимов, которые могут применяться к термину.
  • В Исправление проблем В разделе описывается состояние, которое читатель может захотеть исправить, за которым следует одно или несколько описаний его причины и предлагаемые способы устранения.

Карты

Карта DITA - это контейнер для тем, используемых для преобразования коллекции контента в публикацию. Он дает последовательность и структуру тем. Карта может включать таблицы отношений (reltables), которые определяют гиперссылки между темами.[7] Карты могут быть вложенными. Карты могут ссылаться на темы или другие карты и могут содержать различные типы контента и метаданные.

Метаданные

DITA включает обширный метаданные элементы и атрибуты как на уровне темы, так и внутри элементов.[8] Условный текст позволяет фильтровать или стилизовать контент на основе атрибутов аудитории, платформы, продукта и других свойств. Профиль условной обработки (.ditaval файл) используется, чтобы определить, какие значения должны использоваться для условной обработки.[9]

Специализация

DITA позволяет добавлять новые элементы и атрибуты за счет специализации базовых элементов и атрибутов DITA. Благодаря специализации DITA может размещать новые типы тем, типы элементов и атрибуты, необходимые для конкретных отраслей или компаний. Специализации DITA для конкретных отраслей, таких как полупроводник промышленности, стандартизированы ОАЗИС технические комитеты или подкомитеты. Многие организации, использующие DITA, также развивают свои собственные специализации.

Расширяемость DITA позволяет организациям специализировать DITA путем определения конкретных информационных структур и при этом использовать стандартные инструменты для работы с ними. Возможность определять специфические для компании информационные архитектуры позволяет компаниям использовать DITA для обогащения контента значимыми для них метаданными и для обеспечения соблюдения специфических для компании правил в отношении структуры документов.[6]

Тематическая ориентация

Основная статья: Тематическая разработка

Контент DITA создается в виде тем, каждая из которых представляет собой отдельный файл XML. Как правило, каждая тема охватывает конкретную тему с единственной целью, например концептуальную тему, которая дает обзор, или процедурную тему, которая объясняет, как выполнить задачу.[10] Контент должен быть структурирован так, чтобы напоминать файловую структуру, в которой он содержится.[11][12][13]

Создание контента в DITA

Карта DITA и тематические документы XML файлы. Как и с HTML, любые изображения, видеофайлы или другие файлы, которые должны появиться в выводе, вставляются по ссылке. Любой Редактор XML или даже Текстовый редактор может использоваться для написания контента DITA, в зависимости от уровня поддержки, необходимой при создании. Вспомогательные средства для создания, представленные в специализированных редакторах, включают: WYSIWYG предварительный рендеринг, Проверка, а также интеграция с процессором DITA, например ДИТА-ОТ или же 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 или же Fluenta DITA менеджер переводов, инструмент, предназначенный для реализации рабочего процесса перевода, предложенного в статье «Использование XLIFF для перевода проектов DITA», опубликованной TC DITA Adoption TC в OASIS.[17]

История

Стандарт DITA поддерживается OASIS. Последняя (текущая) версия - 1.3, утверждена в декабре 2015 года. В октябре 2016 года был утвержден документ об ошибках для DITA 1.3. [18]

  • Март 2001 г. IBM ядра DTD и Схема XML файлы грамматики и вводный материал[19]
  • Апрель 2004 г. Создан технический комитет OASIS DITA.[20]
  • Февраль 2005 г. IBM вносит вклад в исходный проект DITA Open Toolkit в SourceForge; хотя его часто путают со стандартом 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"?><!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd"><карта id ="карта" xml: lang ="en">   формат ="дита" href ="sample.dita" navtitle ="Образец" type ="тема"/></map>

Привет, мир (тема DTD)

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"><тема xml: lang ="en" id ="образец">  <title>Образец</title>  <body>  <p>Привет, мир!</p>  </body></topic>

Пример файла .ditaval (для условного оформления текста)

<?xml version="1.0" encoding="utf-8"?><val>  <опора att ="аудитория" val ="новичок" действие ="включают" />  <опора att ="аудитория" val ="эксперт" действие ="исключать" /></val>

Пример условного текста:

<p>  Это информация, полезная для всех.</p> аудитория ="новичок">  Это информация, полезная для начинающей аудитории.</p> аудитория ="эксперт">  Это информация, полезная для экспертной аудитории. </p>

Смотрите также

Рекомендации

  1. ^ "Дарвиновская архитектура ввода информации (DITA), версия 1.3". Получено 1 ноября 2020.
  2. ^ "Дарвиновская архитектура ввода информации (DITA), версия 1.2". Получено 10 октября 2012.
  3. ^ "Архитектура типизации информации Дарвина OASIS (DITA) TC". ОАЗИС. Получено 5 октября 2012.
  4. ^ «Часто задаваемые вопросы о Дарвиновской архитектуре типизации информации». Корпорация IBM. Получено 10 октября 2012.
  5. ^ Хакос, Джоанн (2011). Введение в DITA Second Edition: Руководство пользователя по Дарвиновской архитектуре ввода информации, включая DITA 1.2. Колорадо: Comtech Services, Inc., стр. 235–239. ISBN  978-0-9778634-3-3.
  6. ^ а б "Введение в Дарвиновскую архитектуру типизации информации". Корпорация IBM. Получено 10 октября 2012.
  7. ^ "reltable". ОАЗИС. Получено 22 октября 2012.
  8. ^ «Элементы метаданных». ОАЗИС. Получено 22 октября 2012.
  9. ^ "дитавал". ОАЗИС. Получено 22 октября 2012.
  10. ^ Священник, Михаил; Нападай, Эмбер. "Технический документ модели зрелости DITA" (PDF). IBM Corp и JustSystems. Получено 22 октября 2012.
  11. ^ «Оценка DITA как основы для реализации XML». Scriptorium Publishing Services, Inc. 2009 г.. Получено 2019-02-12.
  12. ^ «Структура, DITA и содержание, кроме технической документации…». Группа Rockley. 16 октября 2007 г.. Получено 2009-07-29.
  13. ^ «Обзор проблем DITA». WritePoint Ltd. 18 января 2010 г. Архивировано с оригинал 2014-10-23. Получено 2010-01-21.
  14. ^ "группа атрибутов localization-atts". ОАЗИС. Получено 15 октября 2012.
  15. ^ Шнабель, Брайан. "DITA-XLIFF Roundtrip для OT". Получено 15 октября 2012.
  16. ^ Статья о DITA 1.2: Использование XLIFF для перевода проектов DITA
  17. ^ Использование XLIFF для перевода проектов DITA
  18. ^ "OASIS DITA 1.3 Errata 01". ОАЗИС Открытый. 2016 г.. Получено 15 марта 2018.
  19. ^ "Оригинальная статья DITA от IBM". IBM. 2001 г.. Получено 15 марта 2018./
  20. ^ «Технический комитет OASIS DITA». ОАЗИС Открытый. 2004 г.. Получено 15 марта 2018.
  21. ^ «ДИТА против ДИТА-ОТ». Роберт Д. Андерсон, разработчик DITA-OT и редактор спецификаций DITA. 2016 г.. Получено 15 марта 2018.
  22. ^ «Базовый пакет DITA 1.3». ОАЗИС Открытый. 2015 г.. Получено 15 марта 2018.
  23. ^ «Пакет технического содержания DITA 1.3». ОАЗИС Открытый. 2015 г.. Получено 15 марта 2018.
  24. ^ «Пакет DITA 1.3 Все включено». ОАЗИС Открытый. 2015 г.. Получено 15 марта 2018.

внешняя ссылка