[docs] docinfo role

[Kirill Maslinsky]

On Mon, Feb 25, 2008 at 08:19:14PM +0200, Artem Zolochevskiy wrote:
> hi all
> 
> Господа,
> Есть ли на сегодняшний день хоть какой-то толк от наличия в пакетах 
> документации файла docinfo?

Docinfo задумывался как стандартизованный и одновременно
человекочитаемый контейнер для метаинформации о документе. 
Его необходимость обоснована тем, что внутри документа 
метаинформация может быть оформлена как угодно и вообще отсутствовать, 
поэтому документ необходимо "паспортизовать", для целей архивного
хранения, идентификации, поиска и т.п. Docinfo позволяет хотя бы минимально
контролировать наличие всей необходимой для архивирования информации 
посредством проверки docinfo при поступлении документа в архив (Кучу).

Метаинформации двух родов: 
 1) об авторе, правах, названии и т.п.
 2) классификаторы документа. Был выдуман закрытый список 
 классификаторов, предложенный к использованию.
 http://heap.altlinux.ru/Titlepage/sample.docinfo.html
 См. также http://heap.altlinux.org/adt_policy/s01s03.html

> Мне его роль кажется неопределённой. Эта идея подтверждается и тотальным 
> игнорированием cодержимого этого фала создателями пакетов документации.

Классификаторы должны были использоваться для автоматической организации модулей
в нелинейную, а более хитрую структуру при публикации online и при
установке в систему, а также для поиска. См. 
https://heap.altlinux.ru/engine/Docs/TZ/HeapCatalogue

Все эти идеи не получили пока никакой реализации, поэтому классификаторы
из docinfo используются в единственном случае: при построении таблицы
модулей по категориям при прохождении incoming Кучи:
http://heap.altlinux.org/HeapContent/categories.html
 
> Т.е. сейчас он таков, что лишь бы был хоть какой-то. Без него просто пакет не 
> собирается. Так может упразднить его вовсе?

При сборке пакетов docinfo преобразуется в docinfo.html и кладётся рядом 
с html-версией модуля в качестве "Сведений о документе", с
соответствующей ссылкой на главной странице модуля. Используется также
информация из docinfo для определения имён каталогов, куда размещается
модуль. Возможно, забыл какие-то еще тонкости, см. пакет rpm-build-docs.

Отказ от docinfo, т.е. хранение документов вообще без метаинформации представляется шагом 
назад в тёмные века. Хотя конкретные недостатки docinfo мне очевидны, 
и понятно, что метаинформацию, возможно, нужно хранить немного другую
и может быть даже в другом формате, однако просто так его выбросить нельзя. 

Из конкретных предложений -- посмотреть на тему классификаторов Debian
tags: http://debtags.alioth.debian.org/

-- 
С уважением,
Кирилл Маслинский
Альт Линукс
руководитель издательских проектов