Αν δημιουργείτε μια εφαρμογή που δεν βασίζεται στο πλαίσιο Eclipse, εξακολουθείτε να μπορείτε να χρησιμοποιείτε το σύστημα βοήθειας του Eclipse. Η εφαρμογή σας μπορεί να συσκευάσει και να εγκαταστήσει το σύστημα ανεξάρτητης βοήθειας, μια πολύ μικρή εκδοχή του Eclipse που δεν περιλαμβάνει τίποτα, εκτός από το σύστημα βοήθειας. Στη συνέχεια, η εφαρμογή σας μπορεί να πραγματοποιεί κλήσεις API από το μενού της Βοήθειας ή από αντικείμενα του περιβάλλοντος χρήστη, ώστε να εκκινήσει το πρόγραμμα πλοήγησης της βοήθειας. Το σύστημα ανεξάρτητης βοήθειας περιλαμβάνει όλες τις λειτουργίες του ενσωματωμένου συστήματος βοήθειας, εκτός από τη συμφραστική βοήθεια ενσωματωμένη σε πάγκο εργασίας, την προβολή βοήθειας και την άμεση βοήθεια. Όταν μια εφαρμογή δεν βασίζεται στη Java ή χρειάζεστε τη βοήθεια όταν δεν εκτελείται η εφαρμογή, μπορείτε να χρησιμοποιήσετε την ανεξάρτητη βοήθεια από ένα κέλυφος συστήματος, ένα σενάριο κελύφους ή μια συντόμευση της επιφάνειας εργασίας και να καταχωρήσετε επιλογές γραμμής εντολών αντί να καλέσετε το API Java.
Στο σύστημα ανεξάρτητης βοήθειας μπορείτε να μεταβιβάσετε έναν αριθμό επιλογών για την προσαρμογή διάφορων όψεων του συστήματος βοήθειας. Υποστηρίζονται οι ακόλουθες επιλογές:
-nl fr_FR
θα ξεκινήσει το σύστημα βοήθειας στα Γαλλικά και όχι στη γλώσσα που καθορίστηκε από τις τοπικές ρυθμίσεις του υπολογιστή.d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar
βρίσκεται στη διαδρομή κλάσεων της εφαρμογής σας, όπου [version]
είναι η εκδοχή της πρόσθετης λειτουργίας που χρησιμοποιείτε (π.χ. org.eclipse.help.base_3.2.0.jar
).
Η κλάση που χρησιμοποιείται για την εκκίνηση και τον τερματισμό του συστήματος
βοήθειας είναι η org.eclipse.help.standalone.Help
.String
με τις
επιλογές που θέλετε να μεταβιβάσετε στην υποστήριξη του συστήματος βοήθειας. Συνήθως,
απαιτείται η επιλογή eclipsehome
.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Help
μεταβιβάζοντας τις επιλογές.Αυτό το αντικείμενο πρέπει να το διατηρήσετε έως το
τέλος της εφαρμογής σας.Help helpSystem = new Help(options);
helpSystem.start();
helpSystem.displayHelp();
Μπορείτε επίσης να καλείτε συγκεκριμένα κύρια αρχεία ή θέματα του πίνακα περιεχομένων:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
Στο τέλος της εφαρμογής σας, για να τερματίσετε τη λειτουργία του συστήματος βοήθειας:
helpSystem.shutdown();
Η κλάση org.eclipse.help.standalone.Help
έχει μια κύρια μέθοδο που μπορείτε να
χρησιμοποιήσετε για την εκκίνηση της ανεξάρτητης βοήθειας από μια γραμμή
εντολών. Η σύνταξη των ορισμάτων της γραμμής εντολών είναι η εξής:
-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]
Ένας απλός τρόπος για να εμφανίζεται η βοήθεια είναι να καλείτε:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp
μέσα από τον κατάλογο d:\myApp\eclipse, όπου version
είναι η
εκδοχή της πρόσθετης λειτουργίας. Για να εμφανιστεί ένα συγκεκριμένο αρχείο
πίνακα περιεχομένων ή θέμα, χρησιμοποιήστε το εξής:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm
Οι παραπάνω κλήσεις για την εμφάνιση της βοήθειας θα έχουν ως αποτέλεσμα να εκκινηθεί το σύστημα βοήθειας, να εμφανιστεί η βοήθεια και να συνεχιστεί η λειτουργία, ώστε ο χρήστης να μπορεί να εξακολουθήσει να εκτελεί αναζήτηση στη βοήθεια μετά την εκτέλεση της εντολής. Για να ελέγξετε τον κύκλο ζωής του συστήματος βοήθειας, χρησιμοποιήστε τις εντολές έναρξης και τερματισμού, μαζί με την εντολή displayHelp. Για παράδειγμα, μπορείτε να καλέσετε:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command start
Η ανεξάρτητη βοήθεια δεν απαιτεί ολόκληρο το πακέτο της πλατφόρμας
Eclipse. Η ανεξάρτητη βοήθεια μπορεί να εκτελεστεί με το δυαδικό αρχείο του
περιβάλλοντος εκτέλεσης RCP, αφού προστεθούν οι πρόσθετες λειτουργίες στον
κατάλογο eclipse/plugins
:
org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms
Σημείωση: πρέπει να βεβαιωθείτε ότι η γραμμή που ακολουθεί βρίσκεται στο
αρχείο eclipse/configuration/config.ini
:
osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start
Ορισμένες πρόσθετες λειτουργίες τεκμηρίωσης ενδέχεται να εξαρτώνται από άλλες
πρόσθετες λειτουργίες, συνήθως καθορίζοντας τις απαιτούμενες πρόσθετες
λειτουργίες στη δήλωση.Οι εξαρτώμενες πρόσθετες λειτουργίες πρέπει επίσης να
είναι εγκατεστημένες. Επιπλέον, οι πρόσθετες λειτουργίες που σχεδιάστηκαν για
εκδοχές του Eclipse προγενέστερες από την 3.0, απαιτούν σιωπηρά, προκειμένου να
λειτουργήσουν, μια πρόσθετη λειτουργία
org.eclipse.core.runtime.compatibility
.
Για περισσότερες πληροφορίες σχετικά με την προσαρμογή του συστήματος βοήθειας, ανατρέξτε στο θέμα Προσαρμογή προϊόντος.