Κέντρο πληροφοριών

Μπορείτε να επιτρέψετε στους χρήστες την πρόσβαση στο σύστημα βοήθειας μέσω του διαδικτύου ή ενός τοπικού δικτύου εγκαθιστώντας τις πρόσθετες λειτουργίες του κέντρου πληροφοριών και της τεκμηρίωσης σε έναν εξυπηρετητή. Οι πελάτες μπορούν να δουν τη βοήθεια μεταβαίνοντας σε ένα URL και το σύστημα βοήθειας εμφανίζεται στο πρόγραμμα πλοήγησης. Το σύστημα βοήθειας ως κέντρο πληροφοριών μπορεί να χρησιμοποιηθεί τόσο για εφαρμογές πελάτη όσο και για εφαρμογές διαδικτύου, όπου και στις δύο περιπτώσεις η πρόσβαση στη βοήθεια μπορεί να γίνεται από μακριά. Υποστηρίζονται όλες οι λειτουργίες του συστήματος βοήθειας, εκτός από τη συμφραστική βοήθεια, την ενεργή βοήθεια, την υποστήριξη εντολών και την προβολή βοήθειας.

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

Εγκατάσταση/συσκευασία

Τα παρακάτω βήματα προορίζονται για τη λειτουργία ενοποίησης του συστήματος βοήθειας και σκοπός δεν είναι να εξεταστούν όλα τα πιθανά σενάρια. Θεωρείται ότι το σύνολο της τεκμηρίωσης παρέχεται ως πρόσθετες λειτουργίες του Eclpise και ότι γενικά έχετε εξοικειωθεί με το σύστημα βοήθειας του Eclipse.

  1. Μεταφορτώστε το πρόγραμμα οδήγησης του δυαδικού αρχείου του περιβάλλοντος εκτέλεσης της πλατφόρμας Eclipse από τη διεύθυνση www.eclipse.org.
  2. Εγκαταστήστε (αποσυμπιέστε) το πρόγραμμα οδήγησης σε έναν κατάλογο, π.χ. d:\myApp. Έτσι, θα δημιουργηθεί ένας υποκατάλογος του Eclipse, ο d:\myApp\eclipse, ο οποίος θα περιέχει τον κώδικα που απαιτείται για την πλατφόρμα του Eclipse (που περιλαμβάνει το σύστημα βοήθειας).

Εκκίνηση ή διακοπή της λειτουργίας του κέντρου πληροφοριών από τη γραμμή εντολών

Η κλάση org.eclipse.help.standalone.Infocenter έχει μια κύρια() μέθοδο που μπορείτε να χρησιμοποιήσετε για την εκκίνηση του κέντρου πληροφοριών από μια γραμμή εντολών. Η σύνταξη των ορισμάτων της γραμμής εντολών είναι η εξής:

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

Για να εκκινήσετε ένα κέντρο πληροφοριών στη θύρα 8081, δώστε εντολή start εκτελώντας

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

Για να διακόψετε τη λειτουργία του κέντρου πληροφοριών, δώστε εντολή shutdown εκτελώντας

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Χρήση του κέντρου πληροφοριών

Εκκινήστε το κέντρο πληροφοριών χρησιμοποιώντας τις παραπάνω οδηγίες. Υποδείξτε σε ένα πρόγραμμα πλοήγησης τη διαδικτυακή εφαρμογή "/help" που εκτελείται στη θύρα και καθορίστηκε κατά την εκκίνηση του κέντρου πληροφοριών (π.χ. 8081). Για παράδειγμα, στον υπολογιστή που έχει εγκατασταθεί το κέντρο πληροφοριών, αυτή θα ήταν η εξής: http://localhost:8081/help/.

Εκκίνηση και διακοπή της λειτουργίας του κέντρου πληροφοριών από τη Java

Όταν συμπεριλαμβάνετε το κέντρο πληροφοριών ως τμήμα μιας άλλης εφαρμογής, μπορεί να σας διευκολύνει να το εκκινήσετε και να το τερματίσετε χρησιμοποιώντας κλήσεις API Java αντί για εντολές συστήματος. Σε αυτή την περίπτωση, ακολουθήστε τα εξής βήματα:

  1. Βεβαιωθείτε ότι στη διαδρομή κλάσεων της εφαρμογής σας έχετε καταχωρήσει τη διαδρομή d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar . Η κλάση που χρησιμοποιείται για την εκκίνηση και τον τερματισμό του κέντρου πληροφοριών είναι org.eclipse.help.standalone.Infocenter .
  2. Δημιουργήστε έναν πίνακα αντικειμένων String με τις επιλογές που θέλετε να μεταβιβάσετε στο κέντρο πληροφοριών. Συνήθως, απαιτούνται οι επιλογές eclipsehome και port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. Στην εφαρμογή σας, δημιουργήστε μια χρήση της κλάσης Help μεταβιβάζοντας τις επιλογές.
    Infocenter infocenter = new Help(options);
  4. Για να εκκινήσετε το σύστημα βοήθειας:
    helpSystem.start();
  5. Για να τερματίσετε το κέντρο πληροφοριών:
    helpSystem.shutdown();

Διάθεση του κέντρου πληροφοριών στο διαδίκτυο

Το Eclipse περιέχει ένα πλήρες κέντρο πληροφοριών και δεν απαιτεί την εκτέλεση άλλων λογισμικών εξυπηρετητή. Ωστόσο, σε ένα αβέβαιο περιβάλλον όπως είναι το διαδίκτυο, το κέντρο πληροφοριών συνιστάται να μην είναι άμεσα προσβάσιμο από τους πελάτες, αλλά να γίνεται διαθέσιμο μέσω ενός εξυπηρετητή HTTP ή εφαρμογών. Οι περισσότεροι εξυπηρετητές περιλαμβάνουν λειτουργικές μονάδες ή μικροεφαρμογές εξυπηρετητή για να αναθέσουν συγκεκριμένες αιτήσεις σε άλλους πόρους διαδικτύου. Κάποιος, για παράδειγμα, μπορεί να ρυθμίσει μια λειτουργική μονάδα ενδιάμεσου εξυπηρετητή του Apache HTTP Server ώστε να ανακατευθύνει τις αιτήσεις που υποβάλλονται στο http://mycompany.com/myproduct/infocenter προς το http://internalserver:8081/help, όπου λειτουργεί ένα κέντρο πληροφοριών. Αυτό επιτυγχάνεται με την προσθήκη των γραμμών

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

στο αρχείο conf/httpd.conf του εξυπηρετητή Apache, όπου λειτουργεί ο δικτυακός τόπος mycompany.

Ορισμένες εκδοχές του Apache HTTP server, μπορεί να περιέχουν ενεργοποιημένη την οδηγία AddDefaultCharset στο αρχείο ρυθμίσεων. Αφαιρέστε την οδηγία ή αντικαταστήστε την με τη γραμμή

AddDefaultCharset Off

ώστε τα προγράμματα πλοήγησης να χρησιμοποιούν το σωστό σύνολο χαρακτήρων.

Εκτέλεση πολλαπλών χρήσεων ενός κέντρου πληροφοριών

Η εκτέλεση πολλαπλών χρήσεων ενός κέντρου πληροφοριών μπορεί να γίνει σε έναν υπολογιστή από μία εγκατάσταση. Κάθε χρήση που ξεκινά πρέπει να χρησιμοποιεί τη δική της θύρα και να παρέχεται με έναν χώρο εργασίας, επομένως πρέπει να καθοριστούν οι επιλογές -port και -data. Οι χρήσεις μπορούν να εξυπηρετούν τεκμηρίωση από διαφορετικά σύνολα πρόσθετων λειτουργιών παρέχοντας μια έγκυρη ρύθμιση πλατφόρμας με την επιλογή -configuration.

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

Φιλτράρισμα

Η υποστήριξη Φιλτράρισμα είναι απενεργοποιημένη όταν εκτελείται βοήθεια σε κατάσταση κέντρου πληροφοριών, με αποτέλεσμα να είναι ορατό όλο το περιεχόμενο, συμπεριλαμβανομένου του φιλτραρισμένου. Εάν σκοπεύετε να έχετε την τεκμηρίωσή σας τόσο σε κατάσταση πάγκου εργασίας όσο και σε κατάσταση κέντρου πληροφοριών, πρέπει να χρησιμοποιείτε φίλτρα ώστε να βγαίνει νόημα ακόμη και όταν το φιλτράρισμα είναι απενεργοποιημένο.

[Προαιρετικό] Εγκατάσταση ελάχιστου συνόλου πρόσθετων λειτουργιών

Το κέντρο πληροφοριών δεν απαιτεί ολόκληρο το πακέτο της πλατφόρμας Eclipse. Η λειτουργία του κέντρου πληροφοριών είναι δυνατή με τις ακόλουθες πρόσθετες λειτουργίες (που βρίσκονται στον κατάλογο eclipse\plugins):

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

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

Οι πρόσθετες λειτουργίες του κέντρου πληροφοριών μπορούν να ενημερώνονται χωρίς να εκτελείται επανεκκίνηση του κέντρου πληροφοριών, με τις εντολές που περιγράφηκαν στο θέμα Ενημέρωση ενός εκτελούμενου κέντρου πληροφοριών από τη γραμμή εντολών. Για να χρησιμοποιήσετε αυτή τη λειτουργία, το ελάχιστο σύνολο πρόσθετων λειτουργιών πρέπει επίσης να περιλαμβάνει την πρόσθετη λειτουργία org.eclipse.update.core .

Για περισσότερες πληροφορίες σχετικά με την προσαρμογή του συστήματος βοήθειας, ανατρέξτε στο θέμα Προσαρμογή προϊόντος.