Краткий обзор документирования инструментов и наборов инструментов
Для документирования инструмента или набора инструментов вы должны редактировать страницу Описание (Description), как показано ниже.
Примечание:Группы инструментов не имеют описания элементов, и вы не можете вносить документацию для групп инструментов.
Редактирование страницы Описание
Существуют разные способы для доступа к странице Описание (Description) инструмента или набора инструментов.
В окне Каталог (Catalog)
- Щелкните правой кнопкой на созданном вами инструменте или наборе инструментов, а затем нажмите Описание элемента (Item Description). Откроется окно Описание элемента , в котором вы увидите страницу Описание (Description).
- Нажмите кнопку Редактировать
.
При помощи ArcCatalog
- В режиме Дерева каталога выберите созданный инструмент или набор инструментов.
- На панели содержания щелкните закладку Описание (Description).
- Нажмите кнопку Редактировать .
В окне Поиск (Search)
Когда инструмент или набор инструментов будет найден в окне Поиск (Search), как описано в разделе Краткий обзор по поиску инструментов, доступ к странице Описание (Description) может быть получен таким образом:
- Наведите курсор на имя инструмента или набора инструментов; появится всплывающее окно со ссылкой в нижней части на Описание элемента (Item Description). Щелкните на этой ссылке, чтобы открылось окно Описание элемента (Item Description) , затем нажмите кнопку Редактировать (Edit). .
- Щелкните строку, расположенную под именем инструмента или набора инструментов, открыв этим окно Описание элемента (Item Description), а затем нажмите кнопку Редактировать (Edit). .
Ввод описания инструмента
Страница Описание (Description) инструмента также использует стандартный шаблон ArcGIS, структурированный так же, как и страница системного инструмента. В исходном состоянии эта страница пустая и содержит только содержимое по умолчанию, такое как название инструмента, имена параметров и типы данных параметров. Вам необходимо внести соответствующую информацию, следуя подсказкам в нижней части редактора, в следующие области:
- Название (Title): Вы можете вписать другое название для вашего набора инструментов, которое, возможно, будет более описательным. Это альтернативное название появится на странице Описание элемента (Item Description)
- Образец (Thumbnail): Вы можете перейти к файлу изображения (например .jpg или .png), иллюстрирующему, что делает данный инструмент. Рекомендуется, чтобы ширина графического элемента не превышала 600 пикселов — в противном случае при печати может произойти его обрезка.Примечание:
Изображение будет отображаться только в окне Описания Элемента, не в справке на боковой панели инструмента.
- Теги (Tags): Вы можете ввести слова, которые используются для идентификации субъекта вашего инструмента в этой системе.
- Краткая информация (Summary): Вы можете вписать краткую информацию о том, что делает ваш инструмент.
- Применение (Usage): Вы можете ввести одну или более подсказок, которые могут быть важными и полезными для ваших пользователей.
- Синтаксис (Syntax): Синтаксис инструмента определяет параметры этого инструмента и то, как эти параметры влияют на результаты применения этого инструмента. Хотя названия и типы параметров появляются в таблице автоматически, вам необходимо внести пояснения к этим параметрам:
- Описание диалога (Dialog explanation) - это справочная информация для параметра в диалоговом окне инструмента. Данная информация отображается на боковой панели в окне инструмента, если нажать кнопку Показать справку (Show Help).
- Описание скрипта (Scripting explanation) — это справочная информация для соответствующего параметра, используемого в скрипте. Данная информация отображается на странице Описания элемента и в секции Справки (Help) в окне Python.
- Примеры кода (Code Samples): есть возможность предоставить один или несколько примеров кода на Python, иллюстрирующих применение инструмента на этом языке. Каждому примеру может быть присвоено название, дано описание и присвоен код Python.
- Изображение для справки на боковой панели инструмента: изображение, появляющееся на справочной боковой панели инструмента. Рекомендуется, чтобы ширина графического элемента не превышала 400 пикселов.
- Информация об авторах (Credits): Вы можете выразить признательность людям и организациям, внесшим свой вклад в реализацию и дизайн данного инструмента.
Ввод описания набора инструментов
На странице описания набора инструментов используется стандартный шаблон ArcGIS. Исходно эта страница пустая и содержит только данные по умолчанию, такие как имя набора инструментов и группы инструментов в этом наборе. Вам необходимо внести соответствующую информацию, следуя подсказкам в нижней части редактора, в следующие области:
- Название (Title): Вы можете вписать другое название для вашего набора инструментов, которое, возможно, будет более описательным. Это альтернативное название появится на странице Описание (Description).
- Образец (Thumbnail): укажите файл изображения (например, формата .jpg или .png), иллюстрирующий содержимое этого набора инструментов.
- Теги (Tags): Вы можете использовать слова, которые используются для идентификации субъекта или содержимого вашего набора инструментов в этой системе.
- Краткая информация (Summary): Вы можете вписать краткую информацию о том, что содержит данный набор инструментов.
- Описание (Description): Вы можете написать более детальное описание вашего набора инструментов.
- Информация об авторах (Credits): есть возможность выразить признательность людям и организациям, внесшим свой вклад в данный проект.
Описание элемента применяется в поиске
Документация, представленная вами в Описании элемента, используется окном Поиск (Search) для поиска вашего инструмента. При последующем индексировании при Поиске ваших инструментов, отчет и ключевые слова будут обработаны и добавлены в поисковый индекс.