Параметры справочной системы

Для предварительной настройки справочной системы Eclipse в соответствии со свойствами и торговыми знаками продукта вы можете указать собственные значения по умолчанию для ряда параметров.

Справочная система состоит из четырех независимых модулей. В следующих таблицах перечислены доступные параметры, а также определяющие их модули. Инструкции по переопределению некоторых из этих параметров приведены в разделе Настройка продукта.
 

Модуль org.eclipse.help:

Ключ параметра Формат
Значение по умолчанию
baseTOCS Структура оглавлений. Упорядоченный список оглавлений (книг) соответствующий их порядку на книжной полке. Остальные оглавления указываются после этих книг. Оглавления, отсутствующие в списке, игнорируются. Расположение каждого оглавления следует указывать в формате /pluginId/путь/toc.xml. /org.eclipse.platform.doc.user/toc.xml,
/org.eclipse.jdt.doc.user/toc.xml,
/org.eclipse.platform.doc.isv/toc.xml,
/org.eclipse.jdt.doc.isv/toc.xml,
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS Выключение оглавлений.  Упорядоченный список оглавлений (книг), которые не будут обрабатываться системой справки. Выключенные оглавления не выводятся в списке книг, на них нельзя ссылаться. Темы, указанные в них, не отображаются в результатах поиска. Оглавления, отсутствующие в списке, игнорируются. Расположение каждого оглавления следует указывать в формате /pluginId/путь/toc.xml.

Модуль org.eclipse.help.base:

Ключ параметра Формат
Значение по умолчанию
banner Расположение титульной страницы, отображаемой в верхней части фрейма
Пример: banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height Высота фрейма титульной страницы
Пример: banner_height=60

help_home Страница, отображаемая в области содержимого, при открытии справки. Укажите расположение в следующем формате /pluginId/path/to/home.html. /org.eclipse.help.base/doc/help_home.html
linksView Позволяет показать или скрыть панель ссылок. Допустимые значения: true и false.
Примечание: эта опция игнорируется в справочной системе Infocenter.
true
bookmarksView Позволяет показать или скрыть панель закладок. Допустимые значения: true и false.
Примечание: эта опция игнорируется в справочной системе Infocenter.
true
windowTitlePrefix Позволяет настроить формат заголовка окна браузера. Допустимые значения: true и false. Если указано значение true, применяется следующий формат заголовка: "Справка - <PRODUCT_NAME>". В противном случае, применяется формат "<PRODUCT_NAME>", где <PRODUCT_NAME> - это имя продукта Eclipse, указанное основным комплектом. true
loadBookAtOnceLimit Максимальное число разделов в книге, допускающее загрузку структуры навигации в качестве одного документа. Структура навигации больших книг загружается динамически (по несколько уровней). Дополнительные разделы загружаются по мере развертывания отдельных ветвей. 1000
dynamicLoadDepthsHint Предполагаемое число уровней структуры разделов, загружаемое браузером при работе с большими книгами. Значение должно быть больше 0. Фактическое число уровней может отличаться от указанного, если в предполагаемых уровнях содержится большое число разделов.
3
imagesDirectory Каталог изображений, применяемых на панели справки. Имена изображений должны совпадать с именами из модуля org.eclipse.help.webapp. Применяется следующий формат: /pluginID/каталог. images
advanced.toolbarBackground Фон CSS для панелей инструментов. Применяется для браузеров, поддерживающих расширенный пользовательский интерфейс справки. ButtonFace
advanced.viewBackground Фон CSS для панелей навигации. Применяется для браузеров, поддерживающих расширенный пользовательский интерфейс справки. Window
advanced.toolbarFont Шрифт CSS для панелей инструментов. Применяется для браузеров, поддерживающих расширенный пользовательский интерфейс справки. icon
advanced.viewFont Шрифт CSS для панелей навигации. Применяется для браузеров, поддерживающих расширенный пользовательский интерфейс справки. icon
basic.toolbarBackground Цвет фона для панелей инструментов. Применяется для браузеров, поддерживающих базовый пользовательский интерфейс справки. #D4D0C8
basic.viewBackground Цвет фона для панелей навигации. Применяется для браузеров, поддерживающих базовый пользовательский интерфейс справки. #FFFFFF
locales Список локалей, поддерживаемых справочной системой Infocenter. Если в этом списке отсутствуют локали (языки), поддерживаемые браузером клиента, для обработки содержимого применяется локаль по умолчанию (локаль сервера, указанная с помощью опции командной строки -nl). Если список не указан, применяется предпочитаемая локаль браузера. Примечание: отсутствие этой опции может привести к повышенному расходу оперативной и дисковой памяти, поскольку для каждой предпочитаемой локали браузеров, обращающихся к справочной системе Infocenter, создаются структура навигации и индекс.
Пример: locales=en ja zh_CN zh_TW

productIndex Задает ИД модуля, содержащего для каждого продукта предопределенный индекс документации, если он есть.
always_external_browser
При возможности рекомендуется использовать встроенный браузер (Windows и Linux), либо всегда внешний. Значение true позволяет принудительно применить внешний браузер. Данная опция игнорируется, если в платформе не предусмотрен встроенный браузер.
false
default_browser

Внешний браузер по умолчанию.  ИД одного из внешних браузеров, настроенных в точке расширения org.eclipse.help.base.browser для справочной системы. Метод available() адаптера браузера в текущей системе должен вернуть значение true.

Этот параметр управляет внешними браузерами в автономном режиме справки. В режиме рабочей среды справка использует браузеры, предоставляемые поддержкой браузеров рабочей среды.

значение по умолчанию указывается динамически в зависимости от браузера, доступного в конкретной системе
custom_browser_path

Путь к исполняемому файлу внешнего браузера

Этот параметр управляет внешними браузерами в автономном режиме справки. В режиме рабочей среды справка использует браузеры, предоставляемые поддержкой браузеров рабочей среды.

В операционной системе Windows - C:\Program Files\Internet Explorer\IEXPLORE.EXE" %1,
"konqueror %1" - в системе Linux
"mozilla %1" - на других платформах
showDisabledActivityTopics Справочная система позволяет скрывать разделы, связанные с выключенными функциями. С помощью этой опции можно настроить свойства кнопки Показать все разделы.
Допустимые значения: never, off, on, always
 never - разделы, связанные с выключенными функциями, не отображаются
 off - при необходимости пользователь может просмотреть полный список разделов; по умолчанию выключенные разделы скрыты
 on - при необходимости пользователь может просмотреть полный список разделов; по умолчанию выключенные разделы показаны
 always - разделы, связанные с выключенными функциями, отображаются всегда (фильтрация не применяется)
off
activeHelp Позволяет разрешить или запретить активную справку. Эта опция игнорируется, если активная справка выключена в конфигурации справочной системы Infocenter.
Допустимые значения:
 true - значение по умолчанию, разрешающее действия активной справки
 false - активная справка запрещена
true
window_infopop Если указано значение true, при щелчке на кнопке справки в окне рабочей среды будут выводиться всплывающие окна справки. Иначе будет открыто окно активной справки. false
dialog_infopop
Если указано значение true, при щелчке на кнопке справки в диалоге будут выводится всплывающие окна справки. Иначе будет открыто окно активной справки.
false

org.eclipse.help.appserver plug-in:

Ключ параметра Формат
Значение по умолчанию
port Номер порта, на который поступают запросы HTTP. Если порт не указан, система может выбрать произвольный порт.  
host

Адрес или имя хоста для подключения к серверу. По умолчанию значение не указано, т.е. Eclipse выбирает доступный локальный адрес.

Продукты, использующие справку в локальном режиме (в автономном режиме или в режиме рабочей среды, но не Infocenter), могут присваивать этому параметру значение "127.0.0.1" для того, чтобы доступ к серверу справки был наверняка закрыт для других пользователей сети.


Модуль org.eclipse.tomcat:

Ключ параметра Формат
Значение по умолчанию
acceptCount Максимальная длина очереди входящих запросов на установку соединения в случае применения всех активированных нитей обработки запросов. Если очередь переполнена, поступающие запросы отклоняются. 100
maxProcessors
Максимальное допустимое число нитей обработки запросов (максимальное число запросов, обрабатываемых одновременно).
75
minProcessors
Число нитей обработки запросов, создаваемых при запуске. Значение этого атрибута должно быть меньше значения maxProcessors.
5