การกิจ Ant สำหรับการแปลงรายงานการใช้ API

วัตถุประสงค์

งานนี้จะแปลงรายงาน XML ที่สร้างโดยงาน apitooling.apiuse Ant เป็นไฟล์ HTML รายงาน HTML จะจัดระเบียบการอ้างอิงโดยบันเดิลที่สร้างมัน (เช่น บันเดิลที่มี api/ชนิด ที่ถูกอ้างถึง)

Usage

รายละเอียด

ชื่อของภารกิจ Ant คือ: apitooling.apiuse_reportconversion เมื่อต้องการใช้ ไฟล์ jar apitooling-ant.jar จะต้องอยู่บน Ant classpath

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

พารามิเตอร์

แอ็ตทริบิวต์ คำอธิบาย ต้องการ
xmlfiles แอ็ตทริบิวต์นี้ระบุตำแหน่งของไฟล์ xml ที่ต้องการแปลง

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
Yes
htmlfiles แอ็ตทริบิวต์นี้ระบุตำแหน่งของไฟล์ html ที่ต้องการสร้าง

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
Yes
xsltfile แอ็ตทริบิวต์นี้ระบุตำแหน่งของไฟล์ XSLT ที่ต้องถูกใช้เพื่อสร้างหน้ารายละเอียดการอ้างถึงในลำดับที่ต้องการ

ไฟล์ XSLT ดีฟอลต์จะมีให้ใช้งานในไฟล์ JAR apitooling-ant.jar

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
No
filterpatterns แอ็ตทริบิวต์นี้จะระบุการแสดงรายการที่คั่นด้วยเครื่องหมายคอมมาของรูปแบบนิพจน์ทั่วไปที่ใช้เพื่อตัดการอ้างถึง จาก การเปรียบเทียบรูปแบบชื่อจากรายการสุดท้าย

รูปแบบต้องอยู่ในนิพจน์ปกติที่จัดรูปแบบแล้วตามที่กำหนดไว้ ที่นี่
No
tofilterpatterns แอ็ตทริบิวต์นี้จะระบุการแสดงรายการที่คั่นด้วยเครื่องหมายคอมมาของรูปแบบนิพจน์ทั่วไปที่ใช้เพื่อตัดการอ้างอิง ไปยัง การเปรียบเทียบรูปแบบชื่อจากรายการสุดท้าย

รูปแบบต้องอยู่ในนิพจน์ปกติที่จัดรูปแบบแล้วตามที่กำหนดไว้ ที่นี่
No
ดีบัก ตั้งค่าดีบัก

ค่าที่เป็นไปได้ คือ: true, false
ค่าดีฟอลต์คือ false
No

ตัวอย่าง

 <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 Freeze
ภารกิจ Ant สำหรับการไม่ยอมรับ API
ภารกิจ Ant สำหรับการแปลงรายงานการไม่ยอมรับ API
ภารกิจ Ant สำหรับการแปลงรายงานการวิเคราะห์