Zadanie Ant konwersji raportu użycia konsumenta interfejsu API

Przeznaczenie

To zadanie przekształca raport XML utworzony przez zadanie Ant apitooling.apiuse w pliki HTML. W raporcie HTML odwołania są zorganizowane według pakunku konsumującego dane odwołanie (tzn. zawierającego kod odwołujący się do danej funkcji API lub danego typu).

Użycie

Opis

Nazwa zadania to apitooling.apiconsumeruse_reportconversion. Aby możliwe było jego użycie, plik JAR apitooling-ant.jar musi znajdować się w ścieżce klas narzędzia Ant.

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

Parametry

Atrybut Opis Wymagany
xmlfiles Ten atrybut określa położenie plików XML, które mają zostać przekształcone.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
htmlfiles Ten atrybut określa położenie plików HTML, które mają zostać wygenerowane.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
xsltfile Ten atrybut określa położenie pliku XSLT, który ma być używany do generowania stron szczegółów z informacjami dodatkowymi w pożądanej kolejności.

Domyślny plik XSLT jest dostępny w pliku JAR apitooling-ant.jar.

Położenie jest określane przy użyciu pełnej ścieżki.
Nie
filterpatterns Ten atrybut określa listę rozdzieloną przecinkami zawierającą wzorce wyrażeń regularnych, które są używane do czyszczenia odwołań ze zgodnych wzorców nazw z ostatecznej wersji raportu.

Wzorzec musi być poprawnie sformatowanym wyrażeniem regularnym według definicji podanej tutaj.
Nie
tofilterpatterns Ten atrybut określa listę rozdzieloną przecinkami zawierającą wzorce wyrażeń regularnych, które są używane do czyszczenia odwołań do zgodnych wzorców nazw z ostatecznej wersji raportu.

Wzorzec musi być poprawnie sformatowanym wyrażeniem regularnym według definicji podanej tutaj.
Nie
debug Ustawia wartość debugowania.

Możliwe wartości to: true i false.
Wartość domyślna to false.
Nie

Przykłady

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

 />

W powyższym przykładzie uruchamiane jest zadanie tworzenia plików *.html wewnątrz folderu /eclipse/apiuse-both/HTML odpowiadającego strukturze folderów położenia pliku XML.

Jeśli włączone jest debugowanie, część danych śledzenia debugowania będzie wyświetlana w konsoli narzędzia Ant.

Informacje pokrewne

Zadanie Ant konwersji raportu użycia interfejsu API
Zadanie Ant analizy
Zadanie Ant generowania pliku
Zadanie Ant użycia interfejsu API
Zadanie Ant blokowania interfejsu API
Zadanie Ant deaktualizowania interfejsu API
Zadanie Ant konwersji raportu deaktualizowania interfejsu API
Zadanie Ant konwersji raportu analizy