Εργασία Ant μετατροπής αναφορών χρήσης API

Σκοπός

Αυτή η εργασία μετατρέπει σε αρχεία HTML την αναφορά XML που δημιουργήθηκε από την εργασία Αnt apitooling.apiuse. Η αναφορά HTML οργανώνει τις παραπομπές με βάση τη δέσμη που χρησιμοποιεί την παραπομπή (δηλαδή περιέχει τον κώδικα που παραπέμπει στο api/είδος).

Χρήση

Περιγραφή

Το όνομα της εργασίας 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 Αυτό το γνώρισμα καθορίζει μια λίστα μοτίβων κανονικής έκφρασης διαχωρισμένων με κόμματα που χρησιμοποιούνται για την κατάργηση παραπομπών από αντίστοιχα μοτίβα ονομάτων στην τελική αναφορά.

Το μοτίβο πρέπει να είναι μια κανονική έκφραση με έγκυρη μορφή, όπως ορίζεται εδώ.
Όχι
tofilterpatterns Αυτό το γνώρισμα καθορίζει μια λίστα μοτίβων κανονικής έκφρασης διαχωρισμένων με κόμματα που χρησιμοποιούνται για την κατάργηση παραπομπών προς αντίστοιχα μοτίβα ονομάτων στην τελική αναφορά.

Το μοτίβο πρέπει να είναι μια κανονική έκφραση με έγκυρη μορφή, όπως ορίζεται εδώ.
Όχι
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 μετατροπής αναφορών χρήσης ΑΡΙ
Εργασία Ant ανάλυσης
Εργασία Ant δημιουργίας αρχείων
Εργασία Ant χρήσης API
Εργασία Ant αναστολής API
Εργασία Ant κατάργησης ΑΡΙ
Εργασία Ant μετατροπής αναφορών κατάργησης API
Εργασία Ant μετατροπής αναφορών ανάλυσης