Ρυθμίσεις εισαγωγικού τμήματος

org.eclipse.ui.intro.config

3.0

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

Οι εισαγωγές οργανώνονται σε σελίδες, οι οποίες συνήθως αντιστοιχίζονται σε μια συγκεκριμένη κατηγορία του εισαγωγικού υλικού. Για παράδειγμα, μια σελίδα με το όνομα "Νέες λειτουργίες" θα παρουσιάζει νέες έννοιες ή λειτουργίες που έχουν προστεθεί από τις προηγούμενες εκδόσεις. Υπάρχει η δυνατότητα παραπομπής στο περιεχόμενο που ορίζεται από συγκεκριμένες ρυθμίσεις εισαγωγικού τμήματος, καθώς και η δυνατότητα επέκτασής του, από άλλες πρόσθετες λειτουργίες, με τη χρήση του σημείου επέκτασης org.eclipse.ui.intro.configExtension.

<!ELEMENT extension (config+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT config (presentation)>

<!ATTLIST config

introId    CDATA #REQUIRED

id         CDATA #REQUIRED

content    CDATA #REQUIRED

configurer CDATA #IMPLIED>

Ένα στοιχείο config μπορεί να χρησιμοποιηθεί για τη ρύθμιση ενός προσαρμοζόμενου εισαγωγικού τμήματος. Ένα στοιχείο config πρέπει να προσδιορίζει ένα id, ένα introId και ένα αρχείο περιεχομένου. Το αρχείο περιεχομένου εισαγωγικού τμήματος είναι ένα αρχείο XML που περιγράφει τις σελίδες, τις ομάδες και τις διασυνδέσεις που περιέχει αυτό το εισαγωγικό τμήμα.



<!ELEMENT presentation (implementation+ , launchBar?)>>

<!ATTLIST presentation

home-page-id    CDATA #REQUIRED

standby-page-id CDATA #IMPLIED>

Το στοιχείο presentation που ορίζει όλες τις δυνατές υλοποιήσεις μιας παρουσίασης εισαγωγικού τμήματος. Μπορεί να περιέχει τον ορισμό μίας ή περισσότερων υλοποιήσεων. Μόνο μία υλοποίηση θα επιλέγεται κατά την εκκίνηση, ανάλογα με τα γνωρίσματα os/ws των υλοποιήσεων. Διαφορετικά, θα επιλέγεται η πρώτη υλοποίηση στην οποία δεν ορίζονται τα γνωρίσματα os/ws.



<!ELEMENT implementation (head?)>>

<!ATTLIST implementation

kind  (swt|html)

style CDATA #IMPLIED

os    CDATA #IMPLIED

ws    CDATA #IMPLIED>

Η μοναδική παρουσίαση της πλατφόρμας διαθέτει δύο υλοποιήσεις. Η μία από αυτές βασίζεται στο πρόγραμμα πλοήγησης SWT και η άλλη στην πρόσθετη λειτουργία "Φόρμες γραφικού περιβάλλοντος χρήστη". Το προσαρμόσιμο εισαγωγικό τμήμα μπορεί να ρυθμιστεί έτσι ώστε να διαλέγει μία από αυτές τις παρουσιάσεις, ανάλογα με το τρέχον λειτουργικό σύστημα και το σύστημα παραθύρων. Το είδος της υλοποίησης μπορεί να είναι swt ή html.



<!ELEMENT launchBar (handle? , shortcut*)>

<!ATTLIST launchBar

location (left|bottom|right|fastview) "fastview"

bg       CDATA #IMPLIED

fg       CDATA #IMPLIED

computed (true | false) "false">

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



<!ELEMENT shortcut EMPTY>

<!ATTLIST shortcut

tooltip CDATA #IMPLIED

icon    CDATA #REQUIRED

url     CDATA #REQUIRED>

για κάθε στοιχείο συντόμευσης θα δημιουργείται ένα κουμπί στη γραμμή εκκίνησης εισαγωγής. Το URL που ορίζεται στη συντόμευση θα εκτελείται με το πάτημα του κουμπιού. Από την έκδοση 3.1 και έπειτα.



Το στοιχείο handle καταργήθηκε

<!ELEMENT handle EMPTY>

<!ATTLIST handle

close (true | false) "true"

image CDATA #IMPLIED>

ένα προαιρετικό στοιχείο που ελέγχει τον τρόπο με τον οποίο αποδίδεται ο δείκτης χειρισμού της γραμμής εκκίνησης. Από την έκδοση 3.1 και έπειτα.



<!ELEMENT introContent (page+ , group* , extensionContent*)>

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



<!ELEMENT page (group* | link* | text* | head* | img* | include* | html* | title? | anchor* | contentProvider*)>

<!ATTLIST page

url          CDATA #IMPLIED

id           CDATA #REQUIRED

style        CDATA #IMPLIED

alt-style    CDATA #IMPLIED

filteredFrom (swt|html)

content      CDATA #IMPLIED

style-id     CDATA #IMPLIED

shared-style (true | false)

bgImage      CDATA #IMPLIED>

Το στοιχείο αυτό χρησιμοποιείται για την περιγραφή μιας σελίδας που θα εμφανίζεται. Η εισαγωγή μπορεί να εμφανίζει τόσο δυναμικές όσο και στατικές σελίδες.
Το περιεχόμενο των δυναμικών σελίδων δημιουργείται από υποστοιχεία της σελίδας και περιγράφεται παρακάτω. Το style ή το alt-style θα εφαρμόζονται ανάλογα με την παρουσίαση. Τα στυλ μπορούν να βελτιωθούν περαιτέρω, με παραπομπή στα γνωρίσματα id ή class-id.
Οι στατικές σελίδες επιτρέπουν την εκ νέου χρήση των υπαρχόντων εγγράφων HTML στην εισαγωγή ενός εγγράφου. Επίσης, είναι δυνατή η διασύνδεση σε αυτές από οποιαδήποτε στατική ή δυναμική σελίδα. Οι στατικές σελίδες δεν ορίζονται σε ένα στοιχείο page. Είναι απλά αρχεία html στα οποία μπορεί να πραγματοποιηθεί διασύνδεση μέσω άλλων σελίδων.
Η αρχική σελίδα, της οποίας η ταυτότητα ορίζεται στο στοιχείο presentation του σημείου επέκτασης ρυθμίσεων εισαγωγής, ενδέχεται να διαθέτει μια διεύθυνση url που υποδεικνύει ότι πρόκειται για στατική σελίδα. Εάν δεν προσδιορίζεται καμία διεύθυνση url τότε η αρχική σελίδα θεωρείται ως δυναμική. Όλες οι άλλες σελίδες που περιγράφονται με τη χρήση του στοιχείου page είναι δυναμικές.
Θα πρέπει να σημειωθεί επίσης ότι όταν χρησιμοποιείται η παρουσίαση SWT και πρόκειται να εμφανιστεί μια στατική σελίδα, τότε ξεκινά ένα εξωτερικό πρόγραμμα πλοήγησης και η τρέχουσα σελίδα παραμένει ορατή.
Τα υποστοιχεία που χρησιμοποιούνται σε μια δυναμική σελίδα είναι τα εξής: Ένα υποστοιχείο group χρησιμοποιείται για την ομαδοποίηση του σχετικού περιεχομένου και την εφαρμογή ενός στυλ στο σύνολο του ομαδοποιημένου περιεχομένου. Ένα υποστοιχείο link ορίζει μια διασύνδεση η οποία μπορεί να χρησιμοποιηθεί για τη διασύνδεση σε μια στατική ή δυναμική σελίδα και την εκτέλεση μιας εντολής / ενέργειας εισαγωγής. Μια διασύνδεση ορίζεται συνήθως στο επίπεδο σελίδας για την πλοήγηση ανάμεσα στις κύριες σελίδες σε αντίθεση με τις διασυνδέσεις στο εσωτερικό μιας σελίδας. Ένα υποστοιχείο text ορίζει το περιεχόμενο κειμένου στο επίπεδο σελίδας. Ένα υποστοιχείο head εφαρμόζεται μόνο για την παρουσίαση στο διαδίκτυο και επιτρέπει την προσθήκη επιπλέον html στην ενότητα head του HTML. Χρησιμοποιείται για την προσθήκη σεναρίων java ή επιπλέον φύλλων στυλ. Ένα υποστοιχείο img ορίζει το περιεχόμενο εικόνας για το επίπεδο σελίδας. Ένα υποστοιχείο include επιτρέπει την εκ νέου χρήση οποιουδήποτε άλλου στοιχείου εκτός από το page. Ένα υποστοιχείο html εφαρμόζεται μόνο για την παρουσίαση στο διαδίκτυο και επιτρέπει την ενσωμάτωση ή τη συμπερίληψη ενός html στο περιεχόμενο της σελίδας. Η ενσωμάτωση μπορεί να πραγματοποιηθεί για ένα πλήρως προσδιορισμένο αρχείο html μέσα σε ένα object HTML, μέσω παραπομπής στο αρχείο html. Η συμπερίληψη μπορεί να πραγματοποιηθεί για ένα τμήμα κώδικα html απευθείας από ένα αρχείο html. Ένα υποστοιχείο title ορίζει τον τίτλο της σελίδας. Ένα υποστοιχείο anchor ορίζει ένα σημείο στο οποίο μπορούν να πραγματοποιηθούν εξωτερικές συνεισφορές περιεχομένου από ένα στοιχείο <extensionContent>.



<!ELEMENT group (group* | link* | text* | img* | include* | html* | anchor* | contentProvider*)>

<!ATTLIST group

id           CDATA #REQUIRED

label        CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html)

computed     (true | false) "false"

bgImage      CDATA #IMPLIED>

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



<!ELEMENT head EMPTY>

<!ATTLIST head

src      CDATA #REQUIRED

encoding CDATA #IMPLIED>

Άμεσο HTML που θα συμπεριληφθεί στην περιοχή του περιεχομένου HEAD μιας σελίδας. Επιτρέπει την προσθήκη επιπλέον html στην ενότητα HEAD HTML. Χρησιμοποιείται για την προσθήκη σεναρίων java ή επιπλέον φύλλων στυλ. Αν στο περιεχόμενο περιέχονται τμήματα αντικατάστασης της μορφής $plugin:plugin_id$, θα αντικατασταθούν με την απόλυτη διαδρομή στην πρόσθετη λειτουργία με την ταυτότητα plugin_id. Αυτή η σήμανση χρησιμοποιείται μόνο με την υλοποίηση HTML του εισαγωγικού τμήματος. Στην περίπτωση υλοποίησης πρόσθετης λειτουργίας "Φόρμες γραφικού περιβάλλοντος χρήστη", απλά παραβλέπεται. Μια σελίδα μπορεί να περιέχει περισσότερα από ένα στοιχεία head. Μια υλοποίηση μπορεί να περιέχει ένα και μόνο ένα στοιχείο head (καθώς αυτό είναι κοινόχρηστο σε όλες τις σελίδες).



<!ELEMENT title EMPTY>

<!ATTLIST title

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

ένα τμήμα κώδικα κειμένου το οποίο μπορεί προαιρετικά να περιέχει προσδιοριστικά HTML με χαρακτήρες διαφυγής. Χρησιμοποιείται μόνο ως "Τίτλος σελίδας" κι έτσι μια δεδομένη σελίδα μπορεί να έχει το πολύ ένα στοιχείο title.



<!ELEMENT link (text? , img?)>

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Πραγματοποιεί διασύνδεση σε ένα στατικό αρχείο HTML, έναν εξωτερικό δικτυακό τόπο ή εκτελεί μια ενέργεια διεύθυνσης URL εισαγωγικού τμήματος.



<!ELEMENT text EMPTY>

<!ATTLIST text

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

ένα τμήμα κώδικα κειμένου το οποίο μπορεί προαιρετικά να περιέχει προσδιοριστικά HTML με χαρακτήρες διαφυγής. Μπορεί να συμπεριλαμβάνει προσδιοριστικά "b" και "li". Μπορεί επίσης να περιέχει σημεία αγκύρωσης για διευθύνσεις url. Εάν χρειάζονται πολλές παράγραφοι, τότε το κείμενο μπορεί να χωριστεί σε πολλές ενότητες, η καθεμία από τις οποίες θα ξεκινά και θα τελειώνει με το προσδιοριστικό "p".



<!ELEMENT img EMPTY>

<!ATTLIST img

id           CDATA #REQUIRED

src          CDATA #REQUIRED

alt          CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Μια εικόνα που αναπαριστά το περιεχόμενο του εισαγωγικού τμήματος και όχι την παρουσίαση (σε αντίθεση με τις εικόνες διακριτικών που ορίζονται στα στυλ).



<!ELEMENT html (img | text)>

<!ATTLIST html

id           CDATA #REQUIRED

src          CDATA #REQUIRED

type         (inline|embed)

style-id     CDATA #IMPLIED

filteredFrom (swt|html)

encoding     CDATA #IMPLIED>

άμεσο HTML που θα συμπεριληφθεί στη σελίδα είτε με ενσωμάτωση ολόκληρου του εγγράφου είτε με επί τόπου ενσωμάτωση ενός τμήματος κώδικα HTML. Για την απόδοση μιας εναλλακτικής παρουσίασης swt πρέπει να οριστεί μια εφεδρική εικόνα ή ένα εφεδρικό κείμενο. Αν στο περιεχόμενο περιέχονται τμήματα αντικατάστασης της μορφής $plugin:plugin_id$, θα αντικατασταθούν με την απόλυτη διαδρομή στην πρόσθετη λειτουργία με την ταυτότητα plugin_id.
Η ενσωμάτωση μπορεί να πραγματοποιηθεί για ένα πλήρως ορισμένο αρχείο html μέσα στο περιεχόμενο της δυναμικής σελίδας. Δημιουργείται ένα στοιχείο object HTML το οποίο πραγματοποιεί παραπομπή στο αρχείο html.
Η συμπερίληψη μπορεί να πραγματοποιηθεί για ένα τμήμα κώδικα html, απευθείας από ένα αρχείο μέσα στη δυναμική σελίδα html.



<!ELEMENT include EMPTY>

<!ATTLIST include

configId    CDATA #IMPLIED

path        CDATA #REQUIRED

merge-style (true | false) >

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



<!ELEMENT anchor EMPTY>

<!ATTLIST anchor

id CDATA #REQUIRED>

είναι το στοιχείο που χρησιμοποιείται για να δηλώσει τη δυνατότητα επέκτασης. Πρόκειται για μια θέση στις ρυθμίσεις, η οποία επιτρέπει εξωτερικές συνεισφορές περιεχομένου. Για το γνώρισμα path του στοιχείου extensionContent, έγκυρες τιμές προορισμού είναι μόνο τα στοιχεία anchor



<!ELEMENT extensionContent (text | group | link | html | include)>

<!ATTLIST extensionContent

style     CDATA #IMPLIED

alt-style CDATA #IMPLIED

path      CDATA #REQUIRED

content   CDATA #IMPLIED

id        CDATA #IMPLIED

name      CDATA #IMPLIED>

Το περιεχόμενο που θα προστεθεί στο σημείο αγκύρωσης προορισμού. Σε ένα δεδομένο configExtension επιτρέπεται μόνο ένα extensionContent, διότι εάν αυτή η επέκταση δεν μπορεί να αναλυθεί (εάν δεν είναι δυνατή η εύρεση των ρυθμίσεων ή του στοιχείου anchor προορισμού), τότε οι σελίδες ή/και ομάδες που περιέχονται στην επέκταση πρέπει να παραβλεφθούν.



<!ELEMENT contentProvider (text?)>>

<!ATTLIST contentProvider

id       CDATA #REQUIRED

pluginId CDATA #IMPLIED

class    CDATA #REQUIRED>

Ένας ενδιάμεσος εξυπηρετητής για ένα παροχέα περιεχομένου εισαγωγικού τμήματος, που επιτρέπει σε μια σελίδα εισαγωγής τη δυναμική έλξη δεδομένων από διάφορες προελεύσεις (π.χ. το διαδίκτυο, eclipse, κλπ) και την παροχή περιεχομένου σε περιβάλλον εκτέλεσης που βασίζεται σε αυτά τα δυναμικά δεδομένα. Εάν δεν είναι δυνατή η φόρτωση της κλάσης IIntroContentProvider που προσδιορίζεται στο γνώρισμα, τότε θα αποδίδονται τα περιεχόμενα του στοιχείου text. Αυτή είναι μια δυναμική έκδοση του προσδιοριστικού εισαγωγής html. Ενώ το προσδιοριστικό html επιτρέπει την ενσωμάτωση ή την ένθεση του περιεχομένου ενός στατικού html μέσα στη δημιουργημένη σελίδα εισαγωγής html, το προσδιοριστικό contentProvider επιτρέπει τη δυναμική δημιουργία του περιεχομένου αυτού σε περιβάλλον εκτέλεσης. Μία άλλη διαφορά μεταξύ των προσδιοριστικών είναι ότι το προσδιοριστικό html υποστηρίζεται μόνο για την παρουσίαση HTML, ενώ το προσδιοριστικό contentProvider υποστηρίζεται τόσο για την παρουσίαση HTML όσο και για την παρουσίαση SWT. Από την έκδοση 3.0.1 και έπειτα.



<!ELEMENT hr EMPTY>

<!ATTLIST hr

id           CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

a horizontal rule.



Παρακάτω δίνεται μια απλή χρήση του σημείου επέκτασης ρυθμίσεων.

<extension id=

"intro"

point=

"org.eclipse.ui.intro.config"

>

<config introId=

"com.org.xyz.intro"

id=

"com.org.xyz.introConfig"

content=

"introContent.xml"

>

<presentation home-page-id=

"root"

title=

"%intro.title"

>

<implementation ws=

"win32"

style=

"css/shared.css"

kind=

"html"

os=

"win32"

>

</implementation>

<implementation style=

"css/shared_swt.properties"

kind=

"swt"

>

</implementation>

</presentation>

</config>

</extension>

Για περισσότερες λεπτομέρειες, δείτε τις προδιαγραφές για το πακέτο org.eclipse.ui.intro.config API.

Το εισαγωγικό τμήμα που συνεισφέρεται από την πρόσθετη λειτουργία org.eclipse.platform plugin αποτελεί τη μοναδική υλοποίηση στο Eclipse.