Программирование: Разработка и отладка программ

Поставка документации приложения

Добавление индекса поиска
Регистрация документации
Создание пакета установки

Добавление индекса поиска

Для добавления индекса поиска в пакет installp приложения необходимо выполнить следующие действия:

Примечание: Вы должны выполнить описанные действия для каждого отдельно устанавливаемого набора файлов, содержащего индексы.

Создание сценария установки
Для создания сценария регистрации необходимо выполнить описанные ниже действия. Сценарий позволит автоматически зарегистрировать индексы в Службе поиска документации при установке пакета installp приложения. Вы сможете использовать пример сценария как основу для создания собственного сценария.
1. Создайте копию образца сценария /usr/docsearch/tools/index_config.sh. Вы можете присвоить ей любое имя.
2. Измените сценарий:
  Примечание: Сценарий предназначен для установки индексов. В приведенных ниже примерах замените символ X на номер текущего индекса.
  1. index_type на DBCS, если вы регистрируете индексы с набором двухбайтовых символов.
  2. indexdir_name_X на имя индекса (для всех индексов).
  3. index_title_X на название индекса.
  4. index_loc_X на /usr/docsearch/indexes. В этот каталог installp поместит индекс при установке приложения.
  5. document_loc_X на временную часть пути документа. Эта часть пути должна начинаться и заканчиваться косой чертой (/).
  Пример:
  Для установки индексов Book1Sen и Book2Sen, с названиями Book #1 и Book #2 в каталогах /usr/docsearch/indexes/Book1Sen и /usr/docsearch/indexes/Book2Sen, при условии, что документы расположены в каталоге /usr/share/man/info/en_US/calculator/..., создайте следующий сценарий:
```
indexdir_name_1="Book1Sen"
indexdir_name_2="Book2Sen"
 
index_title_1="<A HREF="/doc_link/en_US/calculator/Book1S.html">Book #1</A>"
index_title_2="<A HREF="/doc_link/en_US/calculator/Book2S.html">Book #2</A>"
 
index_loc_1="/usr/docsearch/indexes/Book1Sen"
index_loc_2="/usr/docsearch/indexes/Book2Sen"
 
document_loc_1="/doc_link/en_US/"
document_loc_2="/doc_link/en_US/"
```
3. Удалите все остальные переменные indexXXX из сценария. Число строк вида indexdir_name_X="..." должно соответствовать количеству индексов, которые вы хотите установить. Это правило должно соблюдаться и для параметров index_title_X, index_loc_X и document_loc_X.
Создание сценария удаления индекса
Создайте сценарий удаления сценария, предназначенный для аннулирования регистрации индекса при удалении приложения из системы.
1. Создайте копию образца сценария удаления индекса /usr/docsearch/tools/index_unconfig.sh.
2. Отредактируйте сценарий, заменив index_type на DBCS для двухбайтового индекса.
3. Замените indexdir_name_X на имя индекса (повторить для каждого индекса).
4. Удалите все остальные переменные indexdir_name_X. Число строк вида indexdir_name_X="..." должно соответствовать количеству индексов, которые вы хотите удалить.
Создание сценария pre_rm
Создайте сценарий pre_rm, который позволит аннулировать регистрацию индекса при повторной установке приложения в режиме принудительной установки или его обновлении для установки новых версий индексов.
1. Скопируйте сценарий pre_rm в файл /usr/docsearch/tools/index_pre_rm.sh
2. Отредактируйте сценарий и замените index_type на DBCS при удалении двухбайтового индекса.
3. Замените в копии сценария indexdir_name_X на имя индекса (для всех индексов).
  Пример: Если установлено два индекса - cal413en и cal567en, сценарий сценария pre_rm должен содержать следующие строки:
```
indexdir_name_1="cal413en"
indexdir_name_2="cal567en"
```
4. Удалите все остальные переменные indexdir_name_X из сценария. Число строк вида indexdir_name_X="..." должно соответствовать количеству индексов в наборе.

Регистрация документации

Для того чтобы пакет installp приложения автоматически зарегистрировал документацию в библиотеке документов, нужно выполнить следующие действия:

Установите файл настройки в каталог /usr/docsearch/views
См. раздел Создание файла настройки набора библиотек.
Создайте файл определения для каждой библиотеки.
См. раздел Создание файла определения набора библиотек.
Измените сценарий установки После вызова /usr/sbin/index_config.sh добавьте строки регистрации файлов определений библиотек для всех библиотек, в которых нужно зарегистрировать документацию.
См. раздел Регистрация всех файлов определения библиотек.
Измените сценарий удаления индекса и сценарий pre_rm После вызова /usr/sbin/index_config.sh добавьте строки для аннулирования регистрации файлов определений всех библиотек, в которых зарегистрирована документация.
См. раздел Регистрация всех файлов определения библиотек.

Создание пакета установки

Создайте обычный пакет установки для документации или приложения. Инструкции по созданию такого пакета приведены в разделе Глава 20, Создание пакетов программного обеспечения для установки.

В дополнение к стандартным действиям выполните следующее:

Добавьте сценарий install в пакет installp для того, чтобы он запускался после установки набора файлов, содержащего индексы.
Добавьте сценарий uninstall в пакет installp для того, чтобы он запускался при удаления набора файлов, содержащего индексы.
Добавьте сценарий pre_pm в пакет installp для того, чтобы он запускался при удаления набора файлов, содержащего индексы.
Если вы применяете файлы настройки, настройте пакет таким образом, чтобы при установке приложения создавался каталог config, в него копировались файлы настройки и устанавливались права доступа к каталогам и файлам.
Настройте пакет таким образом, чтобы вместе с ним устанавливалась документация и индексы.

Программирование: Разработка и отладка программ

Поставка документации приложения

Добавление индекса поиска

Регистрация документации

Создание пакета установки

Рекомендации по формату поставки документации