ВУЗ: Томский государственный университет систем управления и радиоэлектроники
Категория: Методичка
Дисциплина: Проектирование информационных систем
Добавлен: 21.10.2018
Просмотров: 6255
Скачиваний: 6
66
5.1.2 Содержание разделов
2.1. В разделе «Общие сведения о программе» должны быть
указаны назначение и функции программы и сведения о техни-
ческих и программных средствах, обеспечивающих выполнение
данной программы.
2.2. В разделе «Структура программы» должны быть при-
ведены сведения о структуре программы, ее составных частях, о
связях между составными частями и о связях с другими про-
граммами.
2.3. В разделе «Настройка программы» должно быть приве-
дено описание действий по настройке программы на условиях
конкретного применения (настройка на состав технических
средств, выбор функций и др.). При необходимости приводят
поясняющие примеры.
2.4. В разделе «Проверка программы» должно быть приве-
дено описание способов проверки, позволяющих дать общее
заключение о работоспособности программы (контрольные
примеры, методы прогона, результаты).
2.5. В разделе «Дополнительные возможности» должно
быть приведено описание дополнительных разделов функцио-
нальных возможностей программы и способов их выбора.
2.6. В разделе «Сообщения системному программисту»
должны быть указаны тексты сообщений, выдаваемых в ходе
выполнения настройки, проверки программы, а также в ходе
выполнения программы, описание их содержания и действий,
которые необходимо предпринять по этим сообщениям.
2.7. В приложении к руководству системного программиста
могут быть приведены дополнительные материалы (примеры,
иллюстрации, таблицы, графики и т.п.).
5.2
Пример
5.2.1 Общие сведения о программе
Программа «Автоматизированное рабочее место читателя»
предназначена для обеспечения простого и удобного доступа
удаленных пользователей к ресурсам различных информацион-
ных служб. Удаленными пользователями могут являться любые
67
пользователи HTTP-сервера, на базе которого функционирует
программа. Ресурсами информационных служб могут являться
различные удаленные базы данных (библиографические, полно-
текстовые, базы данных запросов на доставку документов, те-
заурусы), доступные по протоколу ISO 23950. Таким образом,
программа является промежуточным звеном многозвенной ин-
формационной системы, обеспечивающим пользователей сле-
дующими возможностями:
−
поиск библиографической, полнотекстовой информации,
информации о заказах, сведений о местонахождении и доступ-
ности документа в удаленных базах данных с возможностями
устранения дублетности, навигации по поисковым индексам и
автоматического расширения запроса с использованием тезау-
русов и авторитетных файлов;
−
заказ документа (копии) по найденному библиографиче-
скому описанию;
−
проверка статуса заказа;
−
вывод списка документов, полученных во временное
пользование.
Другими словами, программа является Z39.50-клиентом с
Web-интерфейсом пользователя. Поэтому для работы с про-
граммой пользователю необходимы лишь Web-агент (Netscape
Navigator, MS Internet Explorer, Lynx и т.п.) и надежная связь с
HTTP-сервером, на котором выполняется программа.
Программа может функционировать на любых технических
средствах под управлением любой операционной системы, от-
вечающей стандарту ISO/IEC 9945-1 (POSIX) и спецификациям
X/Open CAE specifications, Issue 4, July 1992 (XPG4). Обязатель-
ными требованиями для выполнения программы являются под-
держка стека протоколов TCP/IP и наличие HTTP-сервера, под-
держивающего CGI.
5.2.2 Структура программы
Программа «Автоматизированное рабочее место читателя»
состоит из следующих компонентов:
1) zcon — приложение, реализующее функции Z39.50-кли
-
ента;
68
2) zgate — CGI-приложение, обеспечивающее передачу дан-
ных от HTTP-сервера Z39.50-клиенту и обратно;
3) zgate.cat — каталог сообщений, используемый двумя вы-
шеуказанными приложениями для формирования выходных дан-
ных. Количество таких каталогов равняется количеству поддержи-
ваемых программой языков сообщений (как минимум, два — рус-
ский и английский);
4) zgate.xsl — основная XSLT-программа визуального пред-
ставления выходных данных. Может редактироваться админи-
стратором в целях изменения содержания и формы представле-
ния выходных данных;
5) usmarc.xsl — подпрограмма визуального представления
записей в формате MARC21 (USMARC). Может редактировать-
ся администратором в целях изменения содержания и формы
представления выходных данных.
6)
…
Примечание. Для правильного функционирования про-
граммы необходима установка следующих библиотек, поддер-
живающих операции над XML-документами и XSLT:
−
xml2 — библиотека поддержки операций над XML-доку
-
ментами;
−
xslt — библиотека поддержки XSLT;
−
exslt — библиотека поддержки расширений XSLT.
В версию программы для операционных систем, не под-
держивающих спецификации X/Open CAE specifications, Issue 4,
July 1992 для интерфейсов catgets и iconv (например, Microsoft
Windows), дополнительно включаются следующие библиотеки:
−
catgets — интерфейс поддержки каталогов сообщений;
−
iconv — интерфейс конвертора данных из одного коди-
рованного набора символов в другой.
5.2.3 Настройка программы
5.2.3.1
У
СТАНОВКА ПРОГРАММЫ
В настоящем документе для именования файлов использу-
ется синтаксис, определенный ISO/IEC 9945-1. В тех операци-
онных системах, которые не поддерживают указанный способ
69
именования файлов в приложениях, используемых при установ-
ке и настройке программы, следует использовать способ имено-
вания файлов, определяемый используемой операционной сис-
темой. Если, например, используется операционная система Mi-
crosoft Windows, то указанное в настоящем документе имя фай-
ла вида /a/b/c/f следует заменить на X:
\
a
\
b
\
c
\
f, где X: — название
диска, на котором размещаются приложения zcon и zgate.
1. Разместить исполняемые файлы zcon и zgate в каталоге
CGI-приложений HTTP-сервера.
2. Разместить файлы zgate.cat и ru_RU.UTF-8/zgate.cat в од-
ном из системных каталогов сообщений, определяемых пере-
менной окружения NLSPATH. Если, например,
NLSPATH=/usr/lib/nls/msg/%L/%N:/usr/dt/lib/nls/msg/%L/%N.cat,
то необходимо поместить файл C/zgate.cat в каталог
/usr/lib/nls/msg/С, а файл ru_RU.UTF-8/zgate.cat в каталог
/usr/lib/nls/msg/ru_RU.UTF-8. Если определить местонахождение
системного каталога сообщений невозможно, то следует размес-
тить указанные файлы в каталоге /usr/lib/nls/msg и присвоить
переменной окружения NLSPATH значение /usr/lib/nls/msg/%L/%N.
3.
…
Примечание. Пользователь, устанавливающий программу,
должен иметь полномочия, достаточные для записи указанных
файлов в требуемые каталоги. В указанных каталогах должно
быть достаточно свободного пространства для размещения фай-
лов, в т.ч. и временных, размер которых зависит от размеров
записей, извлекаемых пользователем.
5.2.3.2
Н
АСТРОЙКА ПРОГРАММЫ
Обычно в данном подразделе приводятся несколько
скриншотов рабочего окна программы с описанием (куда надо
нажать и что ввести, чтобы получить результат) и описывается
процедура настройки (если присутствует).
5.2.4 Проверка программы
Проверка программы осуществляется методом ее выполне-
ния. В связи с тем, что конкретные условия применения про-
70
граммы (адреса Z39.50-серверов, названия баз данных, поддер-
живаемые точки доступа, форматы записей и т.п.) не могут быть
известны заранее, можно ограничиться следующими рекомен-
дациями:
1. При проверке программы следует использовать все воз-
можные элементы управления — списки с точками доступа,
операторами, форматами записей, выключатели и т.п. Напри-
мер, можно последовательно осуществлять поиск по каждой из
возможных точек доступа, затем получать записи в каждом из
возможных форматов и т.д.
2. При получении диагностических и иных сообщений в хо-
де проверки программы следует обращаться к разделу «Сооб-
щения системному программисту» данного руководства.
5.2.5 Дополнительные возможности
Дополнительной возможностью программы является воз-
можность динамического управления формой представления
записей при просмотре их в полном формате («Детальная ин-
формация») при помощи Web-агента, поддерживающего редак-
тирование текущего URL. В этом случае URL имеет вид:
"http://"<адрес_сервера>":"<порт>"/"
<каталог_с_CGI-приложениями>"zgate?present+"
<идентификатор_соединения>"+"
<наименование_результирующего_множества>"+"
<номер_первой_записи_в_выдаваемой_порции>"+"
<количество_записей>"+"
<наименования_набора_элементов>"+"
<формат_записи>"+"
<код_языка_интерфейса_пользователя>".
5.2.6 Сообщения системному программисту
В таблице 5.1 представлены сообщения, которые могут по-
лучить системный программист в ходе выполнения настройки,
проверки программы, а также пользователь в ходе выполнения
программы. Описано содержание этих сообщений и действия