[docs] новые пакеты с документацией

Kirill Maslinsky kirill на altlinux.ru
Ср Май 12 13:37:29 MSD 2004


Всем привет!

Я выложил в incoming/Sisyphus (хотя, кажется, не совсем в правильный
каталог, но найти там можно) первые пакеты с новой документацией:
alt-docs-main и alt-docs-junior.

Логика разбиения на пакеты следующая: 

alt-docs-main: 

Нужен для организации удобного для пользователя единого выхода на 
документацию, а также для интеграции всей документации 
(возможность перейти ко всей установленной доке со стартовой страницы). 
Собственно документации не содержит. Сюда вынесены зависимости на 
webclient и menu (чтобы не вешать их в каждый пакет с документацией). 

Содержит главную страницу документации (вступительный текст) и две ссылки: 
	1. Документация по установленному дистрибутиву 
	(/usr/share/doc/alt-docs/distrib.html)
	2. Дополнительная документация, поставляемая с ALT Linux. 
	(/usr/share/doc/alt-docs/extras.html)
	Количество ссылок (сиречь разделов документации) скорее всего 
	увеличится в будущем.
	
В пакете: файл для ссылки на десктопе KDE
	  меню-файл ($BROWSER /usr/share/doc/alt-docs/index.html)
	  "Страницы-затычки", которые отображаются, если не установлены
	  соответствующие пакеты с документацией. Там написано, как установить 
	  документацию по дистрибутиву и дополнительную. 

	 Затычки -- это символические ссылки, которые управляются
	 системой альтернатив (пакеты alternatives,
	 update-alternatives). В этом пакете они с низким приоритетом, 
	 в пакетах с настоящей документацией -- с высоким,
	 соответственно, при установке настоящей документацией,
	 символические ссылки будут автоматически передвинуты с "затычек"
	 на стартовые страницы док.

alt-docs-junior (общий вид alt-docs-<distro-name>)

Это основная документация по ALT, к дистрибутиву Junior, в данном
случае, за соответствие которой дистрибутиву мы в ответе. 
Файлы устанавливаются в /usr/share/doc/%name-%version/. 

Символическая ссылка alt-docs/distrib.html при установке этого пакета 
будет указывать на /usr/share/alt-docs-junior-0.1/index.html.
Это сделано специально, чтобы можно было одновременно устанавливать 
документацию к разным дистрибутивам (мне первому это понадобится). 

HELP NEEDED: пока у меня есть проблема, состоящая в том, что при вызове 
distrib.html (переходе с главной страницы документации из alt-docs-main)
броузер считает текущим каталогом /usr/share/alt-docs/, где находится 
символическая ссылка distrib.html, а указывает-то она на 
/usr/share/alt-docs-junior-0.1/index.html, где собственно документация 
и лежит, поэтому все ссылки оказываются битыми. 
Кто может посоветовать что-то конкретное, чтобы броузер считал 
текущим каталог, куда указывает ссылка, пожалуйста, отзовитесь как можно
скорей, а то пакеты рискуют опоздать в Junior.

alt-docs-extras-* 

Пакеты с дополнительной документацией. Каждый предоставляет
alt-docs-extra и зависит от скрипта alt-docs-genextras, который 
генерирует страницу со вводным текстом к дополнениям и списком ссылок на 
стартовые страницы дополнительной документации. 
Дополнительная документация устанавливается в подкаталоги:
/usr/share/doc/alt-docs-extras/<extra-name>/

Эти пакеты буду выкладывать в Сизиф сегодня, когда протестирую немного.
Чтобы страница со ссылками генерировалась правильно, в пакете должны 
быть файлы abstract.txt priority и index.html (главная страница, на
которую ссылка). 

Стандарт подключения таких модулей пока приблизительный и очевидно
поменяется. Однако стратегическая идея состоит в том, чтобы все
возможные дополнения интегрировать в одну структуру и предоставить 
пользователю удобный (и легко находимый) интерфейс к работе со всей
такой документацией. За эту документацию мы отвечаем не так сильно, 
как за дистрибутивную. Здесь могут быть книги, сборники статей, 
HOWTO и пр. полезные всем и избранным документы.

Ко всем заинтересованным участникам проекта docs: подумайте пока, 
какие тексты Вы могли бы таким образом упаковать и отправить в Сизиф, 
и напишите мне лично или сюда о своих намерениях. 

Предложения, замечания, комментарии и сообщения об ошибках принимаются
и приветствуются.

-- 
Kirill Maslinsky
ALT Linux Team * Documentation Project   



Подробная информация о списке рассылки docs