LINUX.ORG.RU

История изменений

Исправление asdpm, (текущая версия) :

что касается XML самого по себе - не слушай клоунов хомячков которые тебе будут говорить что XML это плохо. XML - это одна из множества хороших вещей случившихся случилась в индустрии.

что касается XML в документации: техничекая документация пишется в форматах несущих логическую структуру документа и наделяющих текст семантикой, это DITA и DocBook. Так делают, потому что в документе остается только содержание и структура, а представлением документ наделяется на следующем этапе, внешними относительно документа средствами. Из одного исходника автоматическим путем можно получить несколько вариантов документа или книги например HTML для потребления браузером и PDF для печати (на бумаге).

использование структурированного формата позволяет например формировать нетривиальные цепочки обработки: например документ можно формировать из нескольких входных частей, другие части наоборот делить, добавлять динамическое содержание к рукописному, подвергать линтигу (для всего этого подойдет любой ЯП с поддержкой XML, то есть любой ЯП). кроме того можно вмешаться в XSLT преобразоания механизмом расширений на хост-языке.

некоторых возможности есть штатных процессорах, например «профайлинг» - когда готовится например две вариации PDF в которых включаются/исключаются некоторые части документа.

конечно нельзя забыть и возможности проверки корректности синтаксиса документа и даже его структуры: DocBook XML документ валидируется против схемы.

семантика, набор элементов в обычном DocBook фиксирован, но его можно расшить путем расширения схемы (RelaxNG). Это даст возможность использовать в тексте свои теги. Правда их поддержку нужно будет реализовать и в XSLT, что возможно, но крайне заморочено

документация многих проектов (как минимум FreeBSD, PHP, PostgreSQL) написана в DocBook.

книги издательства O’Reilly (с животными на обложке) долгое время писались на XML, а именно DocBook XML, то есть «мастер-версия» кгиниги - это XML. Затем из нее получали уже PDF. DocBook и был (если я не путаю) разработан сотрудником O’Reilly, правда сейчас в O’Reilly от него ушли к формату на базе HTML

DocBook не лишен проблем. среди множества его проблем: стоковые XSLT не всегда устраивают, а их изменение возможный, но крайне трудоемкий процесс если вы не эксперт именно в XSLT. у проекта уже давно нет никаких ресурсов, он полузаброшен и целиком зависит от двух человек когда в свое время начавших. в целом у проекта никогда не было ресурсов чтобы разрабатываться и развиваться.

на сегодняшний день можно говорить что проект DocBook уже «всё». я бы не советовал с этим связываться, несмотря даже на недавние порывы сделать третью версию XSLT тулчейна.

что до DITA, то он используется в основном в американской промышленности.

DocBook стоит немного особняком потому что он за опенсорс и открытость, в то время как сама эта индустрия технической документации в целом о проприетарных недешевых продуктах.

еще можно упомянуть asciidoc - на мой взгляд достаточно гнилой и как язык и как проект по крайней мере в том виде что с ним стало. к слову начался он как «DocBook, в другом синтаксисе», то есть использовал примерно ту же семантику и на выходе давал DocBook XML. я не могу точно дать информацию, но когда-то проходила информация, что как минимум одна книга для орайли была написана в DocBook XML не напрямую, а через asciidoc.

то есть документация в XML на основе открытых тулчейнов - это была правильная и рабочая идея, которой не хватило итераций и ресурсов чтобы развиться

Исходная версия asdpm, :

что касается XML самого по себе - не слушай клоунов хомячков которые тебе будут говорить что XML это плохо. XML - это одна из множества хороших вещей случившихся случилась в индустрии.

что касается XML в документации: техничекая документация пишется в форматах несущих логическую структуру документа и наделяющих текст семантикой, это DITA и DocBook. Так делают, потому что в документе остается только содержание и структура, а представлением документ наделяется на следующем этапе, внешними относительно документа средствами. Из одного исходника автоматическим путем можно получить несколько вариантов документа или книги например HTML для потребления браузером и PDF для печати (на бумаге).

использование структурированного формата позволяет например формировать нетривиальные цепочки обработки: например документ можно формировать из нескольких входных частей, другие части наоборот делить, добавлять динамическое содержание к рукописному, подвергать линтигу (для всего этого подойдет любой ЯП с поддержкой XML, то есть любой ЯП). кроме того можно вмешаться в XSLT преобразоания механизмом расширений на хост-языке.

некоторых возможности есть штатных процессорах, например «профайлинг» - когда готовится например две вариации PDF в которых включаются/исключаются некоторые части документа.

конечно нельзя забыть и возможности проверки корректности синтаксиса документа и даже его структуры: DocBook XML документ валидируется против схемы.

семантика, набор элементов в обычном DocBook фиксирован, но его можно расшить путем расширения схемы (RelaxNG). Это даст возможность использовать в тексте свои теги. Правда их поддержка

документация многих проектов (как минимум FreeBSD, PHP, PostgreSQL) написана в DocBook.

книги издательства O’Reilly (с животными на обложке) долгое время писались на XML, а именно DocBook XML, то есть «мастер-версия» кгиниги - это XML. Затем из нее получали уже PDF. DocBook и был (если я не путаю) разработан сотрудником O’Reilly, правда сейчас в O’Reilly от него ушли к формату на базе HTML

DocBook не лишен проблем. среди множества его проблем: стоковые XSLT не всегда устраивают, а их изменение возможный, но крайне трудоемкий процесс если вы не эксперт именно в XSLT. у проекта уже давно нет никаких ресурсов, он полузаброшен и целиком зависит от двух человек когда в свое время начавших. в целом у проекта никогда не было ресурсов чтобы разрабатываться и развиваться.

на сегодняшний день можно говорить что проект DocBook уже «всё». я бы не советовал с этим связываться, несмотря даже на недавние порывы сделать третью версию XSLT тулчейна.

что до DITA, то он используется в основном в американской промышленности.

DocBook стоит немного особняком потому что он за опенсорс и открытость, в то время как сама эта индустрия технической документации в целом о проприетарных недешевых продуктах.

еще можно упомянуть asciidoc - на мой взгляд достаточно гнилой и как язык и как проект по крайней мере в том виде что с ним стало. к слову начался он как «DocBook, в другом синтаксисе», то есть использовал примерно ту же семантику и на выходе давал DocBook XML. я не могу точно дать информацию, но когда-то проходила информация, что как минимум одна книга для орайли была написана в DocBook XML не напрямую, а через asciidoc.

то есть документация в XML на основе открытых тулчейнов - это была правильная и рабочая идея, которой не хватило итераций и ресурсов чтобы развиться