[ Страница назад | Страница вперед | Содержание | Индекс | Библиотека | Юридическая информация | Поиск ]

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


Создание документов HTML

На текущий момент Служба поиска документации поддерживает поиск документов HTML на языках, перечисленных в Таблице поддерживаемых языков. Все документы, входящие в состав одного индекса, должны быть написаны на одном языке и в одной кодировке. Обратите внимание, что службой поиска документации должен поддерживаться не только язык, но и кодировка документа. В последнем столбце таблицы перечислены символы, которые должны применяться в качестве двухбуквенных суффиксов в имени индексов, созданных для документов на соответствующем языке. Например, если вы создаете индекс doc456 для испанского языка и кодировки 8859-1, полное имя индекса должно быть doc456es.

Дополнительная информация о кодовых наборах и локалях приведена в разделе Обзор локалей книги Руководство по управлению системой AIX 5L версии 5.1: Операционная система и устройства.

Переносимый набор символов ASCII входит в состав всех остальных кодовых наборов. В связи с этим символы из этого набора могут присутствовать в любых документах.

Если вы создаете документы с использованием кодового набора, отличного от ISO8859-1, в браузере Netscape могут возникнуть ошибки при отображении символов, закодированных с помощью амперсанда, то есть символов, не входящих в состав Переносимого набора символов ASCII. Такие символы будут выводиться неправильно. Например, тег &copy, обозначающий символ copyright, соответствует коду, не входящему в Переносимый набор символов ASCII. Этот символ будет показан неправильно в кодировке, отличной от ISO8859-1.

Для того чтобы Служба поиска документации могла работать с документами HTML, в них нужно добавить ссылку "Поиск" для вызова формы поиска. Такие ссылки могут располагаться в произвольном месте документа. Например, они могут быть в теле документа, в заголовках страниц или в левой части окна - в любом удобном месте документа. Правила создания ссылок приведены в следующем разделе.

Для работы с документацией пользователи могут применять текстовый браузер. Если есть вероятность, что документы будут просматриваться в текстовом браузере, это необходимо учесть при создании документов HTML. К особенностям поддержки текстовых браузеров относится применение атрибута ALT в теге <IMG>, а также тега <NOFRAMES> для пользователей, работающих с браузерами без поддержки фреймов. Другие рекомендации по созданию документов приведены в руководствах по языку HTML.

Добавьте тег заголовка в каждый документ. Заголовки должны однозначно идентифицировать документ и описывать его содержимое. Заголовок документа будет выводится на странице результатов в качестве названия найденного документа. Заголовок документа должен располагаться между тегами <TITLE> и </TITLE> и не должен содержать тегов. Длина заголовка не должна превосходить 256 символов.


Печать документации

В библиотеке документации книги хранятся в виде совокупности статей, или глав. Эти статьи загружаются в браузер клиента по одной. Это удобно для чтения книги в электронном виде, но значительно осложняет ее печать. Начиная с версии 5.1, в библиотеке документации AIX предусмотрена возможность печати руководств. Если вы нажмете кнопку Печать, то будет показан список книг, которые можно загрузить и напечатать одним файлом. Для того чтобы ваша книга была показана в этом списке, нужно включить в комплект поставки документации файл с книгой в формате для печати и указать специальный тег в файле определения.

Для этого нужно выполнить следующие действия:

  1. Создать единый файл, в котором будет находиться вся книга, в формате, пригодном для печати. Конкретный формат выбираете вы сами. Руководства по AIX поставляются в формате PDF.
  2. Добавить этот файл в установочный пакет. Файл должен быть установлен в каталоге, доступном web-серверу службы документации. По умолчанию каталогом документов web-сервера является /usr/share/man/info, поэтому рекомендуется устанавливать печатный вариант книги внутри дерева /usr/share/man/info. Например, если ваш продукт называется Esther, а печатный файл - userguide.pdf, то его можно установить в каталог /usr/share/man/info/esther/userguide.pdf .
    Прим.:
    Если руководство по продукту поставляется на нескольких языках, то для каждого языка нужно создать отдельный печатный файл. Например, если руководство поставляется на английском и испанском языках, то следует создать следующие файлы: /usr/share/man/info/esther/english/userguide.pdf и /usr/share/man/info/esther/spanish/userguide.pdf.
  3. Добавить в файл определения набора библиотек (VDF) тег Printfile с указанием пути к файлу с печатной версией книги. Служба библиотек автоматически создаст ссылку на этот файл в списке файлов, которые можно напечатать. При настройке служба документации создает в каталоге документов web-сервера ссылку на каталог /usr/share/man/info. Эта ссылка называется doc_link. Поэтому если вы устанавливаете файл в каталог /usr/share/man/info, то в теге Printfile вместо /usr/share/man/info должно быть указано doc_link. В предыдущем примере для документации на одном языке тег должен выглядеть следующим образом Printfile:/doc_link/esther/userguide.pdf

Для примера с руководствами на двух языках следует указать два тега Printfile - один для английского руководства, и один для испанского:

Printfile:/doc_link/esther/english/userguide.pdf
Printfile:/doc_link/esther/spanish/userguide.pdf

Дополнительные сведения о файлах VDF и тегах Printfile приведены в разделе ***.


[ Страница назад | Страница вперед | Содержание | Индекс | Библиотека | Юридическая информация | Поиск ]