Задача Ant преобразования отчета об использовании API клиентом

Назначение

Эта задача преобразовывает отчет XML, созданный задачей Ant apitooling.apiuse, в файлы HTML. Отчет HTML упорядочивает ссылки по комплектам, принимающим ссылку (например, комплект содержит код со ссылкой на api/type).

Использование

Description

Имя задачи Ant: apitooling.apiconsumeruse_reportconversion. Для использования файла jar apitooling-ant.jar он должен быть указан в пути к классам Ant.

 <apitooling.apiconsumeruse_reportconversion
	xmlfiles="..."
	htmlfiles="..."
	xsltfile="..."
	filterpatterns="..."
	tofilterpatterns="..."
	debug="..."
 />

Параметры

Атрибут Описание Обязательный
xmlfiles Этот атрибут задает расположение преобразуемых файлов XML.

Расположение задается с помощью абсолютного пути.
Да
htmlfiles Этот атрибут задает расположение генерируемых файлов HTML.

Расположение задается с помощью абсолютного пути.
Да
xsltfile Этот атрибут задает расположение файла XSLT, используемого для генерации справочных страниц сведений в желаемом порядке.

В файле JAR apitooling-ant.jar имеется файл по умолчанию XSLT.

Расположение задается с помощью абсолютного пути.
Нет
filterpatterns Задает список шаблонов регулярных выражений, применяемых для удаления ссылок from, соответствующих шаблонам имен, из конечного отчета.

Шаблон должен быть указан в формате регулярных выражений, описание которого приведено здесь.
Нет
tofilterpatterns Задает список шаблонов регулярных выражений, применяемых для удаления ссылок to, соответствующих шаблонам имен, из конечного отчета.

Шаблон должен быть указан в формате регулярных выражений, описание которого приведено здесь.
Нет
debug Установите значение отладки.

Возможные значения: true, false
Значение по умолчанию - false.
Нет

Примеры

 <apitooling.apiuse_reportconversion
  xmlfiles="/eclipse/apiuse-both/XML"
  htmlfiles="/eclipse/apiuse-both/HTML"
  xsltfile="/eclipse/references.xsl"
  debug="true"

 />

Выполнится задача, создающая файлы *.html в папке /eclipse/apiuse-both/HTML, в соответствии со структурой папки расположения файла XML.

После включения отладки некоторая информация трассировки будет показана на консоли Ant.

Связанные справочники

Задача Ant преобразования отчета об использовании API
Задача Ant анализа
Задача Ant генерации файла
Использование API - Задача Ant
Задача Ant фиксации состояния API
Задача Ant об устаревшем API
Задача Ant преобразования отчета об устаревшем API
Задача Ant преобразования отчета об анализе