DocsSubsystem

Подсистема документации в дистрибутивах

На этой странице находится информация для разработчиков (и всех интересующихся) по текущему состоянию подсистемы документации в дистрибутивах.

Дистрибутивы с графическим меню

Доступ к документации из меню: Пункт для открытия страницы приветствия -> Страница приветствия -> Документация по дистрибутиву

• В меню создаётся пункт для запуска браузера с открытой страницей приветствия.
  • обычно пакет: branding-ДИСТРИБУТИВ-indexhtml
  • содержит: .desktop файл меню с вызовом браузера и страницы (обычно xdg-open /usr/share/doc/indexhtml/index.html)
  • содержит: саму страницу приветствия (обычно /usr/share/doc/indexhtml/index.html), имеющую ссылку на документацию (обычно в каталоге /usr/share/doc/documentation/, являющимся симлинком на /usr/share/doc/docs-ДИСТРИБУТИВ/)

• Документация
  • обычно пакет: docs-ДИСТРИБУТИВ
  • располагается: там, куда ведёт ссылка из файла приветствия (обычно /usr/share/doc/documentation/, являющийся симлинком на /usr/share/doc/docs-ДИСТРИБУТИВ/)

Дистрибутивы без графики

Доступ к документации по сети из браузера (например, с соседнего компьютера -- http://ip.дистрибутива.без.графики/alt-docs/).

Пакет alt-docs-apache2 содержит alias-ы для доступа к странице приветствия и документации:

• обычно alt-docs, ведущий к странице приветствия /usr/share/doc/indexhtml/index.html (пакет: branding-ДИСТРИБУТИВ-indexhtml)
• обычно indexhtml, ведущий туда же
• обычно documentation, ведущий в /usr/share/doc/documentation/, являющийся симлинком на /usr/share/doc/docs-ДИСТРИБУТИВ/ (пакет: docs-ДИСТРИБУТИВ)