Структура документации инструмента
На рисунке ниже показана система справки desktop с таблицей содержания, раскрытой в группе инструментов Близость набора инструментов Анализ. На следующем рисунке показана структура таблицы содержания, общая для всех наборов инструментов.
- Для каждого набора инструментов имеется обзорный раздел, описывающий назначение этого набора инструментов. В обзоре также содержится таблица всех групп инструментов в наборе инструментов со ссылками на обзорный раздел каждой из групп инструментов. В дополнение к этому имеется секция, содержащая ссылки на связанные разделы, которые могут представлять интерес.
- Для каждого набора инструментов имеется раздел лицензий, который содержит информацию о лицензиях для каждого инструмента в этом наборе инструментов.
- Для каждой группы инструментов также существует обзорная страница, структурированная аналогично обзорной странице набора инструментов. Принцип организации группы инструментов описан на обзорной странице этой группы инструментов.
- За обзором группы инструментов следуют справочные страницы для отдельных инструментов из данной группы инструментов. См. ниже более подробно о справочной странице инструмента.
- Наконец, может иметься книга по особенностям работы группы инструментов. Разделы книг по особенностям работы содержат подробную информацию об инструментах из группы инструментов.
Документация и лицензии
- Установленная документация desktop содержит разделы для всех инструментов независимо от имеющихся лицензий. Например, набор инструментов Network Analyst установлен всегда, даже при том, что он требует лицензию дополнительного модуля ArcGIS Network Analyst extension. Другой пример – инструмент Идентичность, расположенный в наборе инструментов Анализ. Для него необходима лицензия ArcGIS Desktop Advanced, но документация устанавливается, если у вас есть лицензия ArcGIS Desktop Basic.
- Лицензии для инструментов приведены внизу каждой справочной страницы инструмента. Кроме того, каждый набор инструментов содержит раздел лицензий, в котором приведены лицензионные требования для каждого из инструментов.
- Документация инструмента не устанавливается для отдельных продуктов. Например, документация набора инструментов Покрытие не устанавливается, если не установлена ArcInfo Workstation.
Справочная страница инструмента
На всех справочных страницах инструментов используется одинаковая компоновка, описанная ниже.
| Секция | Содержание |
|---|---|
Краткая информация | Краткое изложение функций инструмента. Может содержать ссылку на другой раздел, содержащий подробный обзор функций инструмента. |
Рисунок | Дополнительная иллюстрация, разъясняющая функции инструмента. |
Использование | Примечания и разъяснения об использовании инструмента. Когда примечания ссылаются на определенный параметр, используется надпись параметра (отображается в диалоговом окне инструмента), а не имя параметра (отображается в синтаксисе). Соответствие между надписью и именем параметра обычно очевидно, но в некоторых случаях во избежание путаницы может быть приведено имя параметра. |
Синтаксис | Точный синтаксис для выполнения инструмента в скрипте. Затем следует таблица с перечислением всех параметров с их именами, разъяснениями и типами данных (значений). Более подробную информацию см. в разделе Понимание синтаксиса инструментов. |
Пример кода | Содержит один или более примеров кода на Python с использованием данного инструмента. |
Параметры среды | Это список параметров среды, которые наследует инструмент. Каждая среда связана со справочной страницей параметров среды. Если среда особенно важна для инструмента, может быть приведена более подробная информация о среде. |
Связанные разделы | Список связанных разделов, всегда включающий обзорную страницу группы инструментов. |
Информация о лицензиях | Лицензии, необходимые для использования инструмента. |