Книга: Искусство программирования для Unix
18.4. Современный хаос и возможный выход из положения
18.4. Современный хаос и возможный выход из положения
В настоящее время Unix-документация является "неорганизованной смесью".
Главные файлы документации в современных Unix-системах разбросаны по восьми различным форматам разметки: man
, ms
, mm
, TEX, Texinfo, POD, HTML и DocBook. He существует унифицированного способа просматривать все сформированные версии. Они не доступны в Web и не снабжены перекрестными ссылками.
Многие представители Unix-сообщества осознают данную проблему. Во время написания данной книги большинство усилий, направленных на ее разрешение, исходит от разработчиков открытого исходного кода, которые более активно заинтересованы в конкуренции за предпочтения нетехнических конечных пользователей, чем разработчики частных Unix-систем. С 2000 года практика движется в направлении использования XML-DocBook как формата обмена документацией.
Ясная, но требующая больших усилий для достижения цель заключается в том, чтобы снабдить каждую Unix-систему программным обеспечением, которые будет функционировать как общесистемный реестр документации. Когда системные администраторы устанавливают пакеты, одним из этапов будет ввод в данный реестр XML-DocBook-документации для этих пакетов. Затем документация будет преобразована в общедоступное дерево HTML-документов и снабжена перекрестными ссылками с уже имеющейся документацией.
Ранние версии программ регистрации документов уже работают. Проблема преобразования других форматов в XML-DocBook является большой и запутанной, однако инструменты преобразования появляются в поле зрения. Другие политические и технические проблемы остаются нерешенными, однако их можно решить. Несмотря на то, что к середине 2003 года сообщество в целом не пришло к общему мнению о том, что более старые форматы необходимо постепенно прекратить использовать, это событие кажется самым вероятным.
Соответственно, далее формат DocBook и соответствующий инструментарий рассматривается более подробно. Данное описание следует читать как введение в XML в контексте Unix, практическое руководство для применения и как основной учебный пример. Оно является хорошим примером того, как в контексте сообщества Unix, вокруг общих стандартов развивается взаимодействие между различными проектными группами разработчиков.
- 9.3.2. Выходные операнды
- Построение модели выходов (результатов)
- Датчик расположения и другие датчики
- Ключевые положения
- Из меню Пуск пропала кнопка Выход из системы. Как ее вернуть?
- Листинг 5.8. (dup2.c) Перенаправление выходного потока канала с помощью функции dup2()
- Входные и выходные данные
- Выход на сцену
- 2.5.1. Основные положения метода структурного проектирования
- 1.3. Внесение порядка в хаос
- Досрочный выход из циклов
- 18 Документация: объяснение кода в Web-сообществе