Дарвиновская архитектура типизации информации
| Дарвиновская архитектура типизации информации | |
| Аббревиатура | ДИТА |
|---|---|
| Статус | Опубликовано |
| Впервые опубликовано | июнь 2005 г |
| Последняя версия | ДИТА 1.3 Часть0: Обзор Часть 1: Базовое издание Часть 2:Редакция технического контента Часть 3: Издание «Все включено» 19 июня 2018 г |
| Организация | ОАЗИС |
| комитет | ДИТА ТЦ |
| Редакторы | Роберт Д. Андерсон, Кристен Джеймс Эберлайн |
| Базовые стандарты | XML , HTML |
| Домен | Ввод информации |
| Веб-сайт | Дита-Ланг |
Спецификация Darwin Information Typing Architecture ( DITA ) определяет набор типов документов для создания и организации тематически-ориентированной информации, а также набор механизмов для объединения, расширения и ограничения типов документов. [1] Это открытый стандарт [2] это определяется и поддерживается Техническим комитетом OASIS DITA. [3]
Название происходит от следующих компонентов:
- Дарвин: он использует принципы специализации и наследования , что в некотором смысле аналогично натуралиста Чарльза Дарвина . концепции эволюционной адаптации
- Типирование информации: это означает, что каждая тема имеет определенную основную цель (процедуру, глоссарий, информацию по устранению неполадок) и структуру.
- Архитектура: DITA — это расширяемый набор структур. [4]
Особенности и ограничения
[ редактировать ]Повторное использование контента
[ редактировать ]Темы являются основой для повторного использования контента. [5] и может быть повторно использован в нескольких публикациях. Фрагменты контента внутри тем можно повторно использовать с помощью ссылок на контент ( conref или conkeyref ), механизма включения . [6]
Ввод информации
[ редактировать ]Последняя версия DITA (DITA 1.3) включает пять специализированных типов тем: Задача , Концепция , Справочник , Запись в глоссарии и Устранение неполадок . Каждый из этих пяти типов тем является специализацией общего типа темы , который содержит элемент заголовка, элемент пролога для метаданных и элемент тела. Элемент body содержит элементы абзаца, таблицы и списка, аналогично HTML .
- Тема задачи предназначена для процедуры, описывающей способ выполнения задачи. В нем перечислен ряд шагов, которым следуют пользователи для достижения желаемого результата. Шаги содержатся в элементе Taskbody, который является разновидностью универсального элемента тела. Элемент шагов — это специализация элемента упорядоченного списка.
- Информация о концепциях более объективна и содержит определения, правила и рекомендации.
- раздел Справочный предназначен для разделов, описывающих синтаксис команд, инструкции по программированию и другой справочный материал, и обычно содержит подробный фактический материал.
- Тема словарной статьи используется для определения одного значения данного термина. Помимо идентификации термина и предоставления определения, этот тип темы также может содержать базовую терминологическую информацию, а также любые сокращения или расширения акронимов, которые могут относиться к этому термину.
- В разделе «Устранение неполадок» описывается состояние, которое читатель может захотеть исправить, а затем одно или несколько описаний его причины и предлагаемых способов устранения.
Карты
[ редактировать ]Карта 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 , любые изображения, видеофайлы и другие файлы, которые должны появиться в выходных данных, вставляются по ссылке. Для написания контента DITA можно использовать любой XML-редактор или даже текстовый редактор , в зависимости от уровня поддержки, необходимой при создании. Средства авторской разработки, представленные в специализированных редакторах, включают WYSIWYG предварительный рендеринг , проверку и интеграцию с процессором DITA, например DITA-OT или ditac .
Публикация контента, написанного в DITA
[ редактировать ]DITA спроектирована как сквозная архитектура. Помимо указания того, какие элементы, атрибуты и правила являются частью языка DITA, спецификация DITA включает правила публикации контента DITA в HTML, онлайн-справке, печати, платформе доставки контента и других форматах.
Например, спецификация DITA указывает, что если атрибут conref элемента A содержит путь к элементу B , содержимое элемента B будет отображаться в местоположении A. элемента Решения для публикации, совместимые с 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», опубликованной DITA Adoption TC в OASIS. [17]
История
[ редактировать ] |
Стандарт DITA поддерживается OASIS. Последняя (текущая) версия — 1.3, утвержденная в декабре 2015 года. Документ об ошибках для DITA 1.3 был утвержден в июне 2018 года. [18]
- Март 2001 г. Представление IBM основных файлов грамматики DTD и XML Schema, а также вводных материалов. [19]
- Апрель 2004 г. Сформирован технический комитет OASIS DITA. [20]
- Февраль 2005 г. IBM представляет исходный проект DITA Open Toolkit для SourceForge; часто путают со стандартом DITA, хотя DITA-OT он не связан с Техническим комитетом OASIS DITA. [21]
- Июнь 2005 г. DITA v1.0 утверждена в качестве стандарта OASIS.
- Август 2007 г. DITA V1.1 одобрен OASIS; основные функции включают в себя:
- Специализация закладки
- Формальное определение синтаксиса DITAVAL для фильтрации контента.
- Декабрь 2010 г. DITA V1.2 одобрен OASIS; основные функции включают в себя:
- Косвенное связывание с ключами
- Новые функции повторного использования контента
- Расширенная поддержка глоссария, включая сокращения.
- Новые отраслевые специализации (Обучение, Машиностроение)
- Новая поддержка контролируемых значений/таксономий (специализация «Субъектная схема»)
- 17 декабря 2015 г. OASIS одобрил DITA V1.3; основные функции включают в себя:
- Спецификация теперь поставляется в трех пакетах: Base, [22] Технический контент, [23] и «Все включено» (с обучением и профессиональной подготовкой) [24]
- Новый тип темы устранения неполадок
- Возможность использовать ключи с ограниченной областью действия.
- Новые домены для поддержки MathML, уравнений и SVG.
- Добавляет синтаксис Relax NG XML в качестве нормативной грамматики для DITA.
- 25 октября 2016 г., DITA V1.3 Errata 01 одобрена OASIS. [25]
- 19 июня 2018 г. OASIS одобрил DITA V1.3 Errata 02. [26]
Примеры кода
[ редактировать ]Образец файла Ditamap (оглавление)
[ редактировать ]<?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>
Привет, мир (тема 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>
Образец файла .ditaval (для условного текста)
[ редактировать ]<?xml version="1.0" encoding="utf-8"?>
<val>
<prop att="audience" val="novice" action="include" />
<prop att="audience" val="expert" action="exclude" />
</val>
Пример условного текста:
<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>
Реализации
[ редактировать ]| Имя | Тип | Лицензия на программное обеспечение |
|---|---|---|
| Открытый инструментарий DITA [27] | Издательский | Лицензия Апач |
| XML-редактор Oxygen [28] | Редактор | Собственный |
| XMLmind DITA-конвертер [29] | Издательский | Публичная лицензия Mozilla |
| Имя | Тип | Лицензия на программное обеспечение |
См. также
[ редактировать ]Ссылки
[ редактировать ]- ^ «Дарвиновская архитектура типизации информации (DITA), версия 1.3» . Проверено 1 ноября 2020 г.
- ^ «Архитектура типизации информации Дарвина (DITA), версия 1.2» . Проверено 10 октября 2012 г.
- ^ «Архитектура типизации информации OASIS Darwin (DITA) TC» . ОАЗИС . Проверено 5 октября 2012 г.
- ^ «Часто задаваемые вопросы об архитектуре типизации информации Дарвина» . Корпорация IBM . Проверено 10 октября 2012 г.
- ^ Хакос, Джоанн (2011). Введение во второе издание DITA: Руководство пользователя по архитектуре типизации информации Дарвина, включая DITA 1.2 . Колорадо: Comtech Services, Inc., стр. 235–239. ISBN 978-0-9778634-3-3 .
- ^ Перейти обратно: а б «Введение в дарвиновскую архитектуру типизации информации» . Корпорация IBM . Проверено 10 октября 2012 г.
- ^ "относительный" . ОАЗИС . Проверено 22 октября 2012 г.
- ^ «Элементы метаданных» . ОАЗИС . Проверено 22 октября 2012 г.
- ^ «диктавл» . ОАЗИС . Проверено 22 октября 2012 .
- ^ Пристли, Майкл; Свип, Эмбер. «Информационный документ о модели зрелости DITA» (PDF) . IBM Corp и JustSystems . Проверено 22 октября 2012 г.
- ^ «Оценка DITA как основы для реализации XML» . Scriptorium Publishing Services, Inc., 2009 г. Проверено 12 февраля 2019 г.
- ^ «Структура, DITA и содержание, кроме технической документации…» . Группа Рокли. 16 октября 2007 г. Архивировано из оригинала 11 августа 2020 г. Проверено 29 июля 2009 г.
- ^ «Обзор проблем DITA» . WritePoint Ltd., 18 января 2010 г. Архивировано из оригинала 23 октября 2014 г. Проверено 21 января 2010 г.
- ^ «группа атрибутов localization-atts» . ОАЗИС . Проверено 15 октября 2012 г.
- ^ Шнабель, Брайан. «DITA-XLIFF Туда-обратно для ОТ» . Проверено 15 октября 2012 г.
- ^ DITA 1.2 Тематическая статья: Использование XLIFF для перевода проектов DITA
- ^ Использование XLIFF для перевода проектов DITA
- ^ «ОАЗИС ДИТА 1.3 Ошибки 02» . ОАЗИС Открыт. 2018 . Проверено 26 января 2022 г.
- ^ «Оригинальная статья DITA от IBM» . ИБМ. 2001 . Проверено 15 марта 2018 г. /
- ^ «Технический комитет ОАЗИС ДИТА» . ОАЗИС Открыт. 2004 . Проверено 15 марта 2018 г.
- ^ «ДИТА против ДИТА-ОТ» . Роберт Д. Андерсон, разработчик DITA-OT и редактор спецификаций DITA. 2016 . Проверено 15 марта 2018 г.
- ^ «Базовый пакет DITA 1.3» . ОАЗИС Открыт. 2015 . Проверено 15 марта 2018 г.
- ^ «Пакет технического контента DITA 1.3» . ОАЗИС Открыт. 2015 . Проверено 15 марта 2018 г.
- ^ «Пакет DITA 1.3 «Все включено»» . ОАЗИС Открыт. 2015 . Проверено 15 марта 2018 г.
- ^ «История голосования за одобренную опечатку 01» . Проверено 26 января 2022 г.
- ^ «История голосования за одобренную опечатку 02» . Проверено 26 января 2022 г.
- ^ Открытый набор инструментов DITA
- ^ XML-редактор Oxygen
- ^ «Что такое XMLmind DITA Converter?» . Программное обеспечение XMLmind . Проверено 26 января 2022 г.
Внешние ссылки
[ редактировать ]- Официальный сайт Консорциума ОАЗИС
- Технические характеристики ДИТА 1.3
- Официальный сайт DITA Open Toolkit
- Форум DITA.XML.org
- Демонстрационный набор DITA для загрузки на GitHub
- Изучение DITA - набор учебных пособий для самостоятельного изучения DITA
- Портал самообслуживания DITA
- Репозиторий GitHub с примерами файлов DITA.
| Базы данных органов управления : Национальные |
|---|
