Μορφή αρχείου XML περιεχομένου εισαγωγικού τμήματος

Έκδοση 3.1.0

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

introContent


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

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



page


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

<!ATTLIST page

url          CDATA #IMPLIED

id           CDATA #REQUIRED

style        CDATA #IMPLIED

alt-style    CDATA #IMPLIED

filteredFrom (swt|html)
bgImage      CDATA #IMPLIED

content      CDATA #IMPLIED

style-id 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>.


group


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

<!ATTLIST group

id           CDATA #REQUIRED

label        CDATA #IMPLIED

style-id     CDATA #IMPLIED

computed     CDATA (true|false) "false"
bgImage      CDATA #IMPLIED

filteredFrom (swt|html) >

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


link


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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

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




Οι προκαθορισμένες ενέργειες θα περιγράφονται με τη χρήση της μορφής:

action name - περιγραφή ενέργειας
action parameter1 - περιγραφή παραμέτρου
action parameter2 (optional) - περιγραφή παραμέτρου
action parameter3 (optional) = ("true" | "false") "false" - περιγραφή παραμέτρου, επιλογή της τιμής true ή false, η προεπιλογή είναι η τιμή "false"


Οι ακόλουθες προκαθορισμένες ενέργειες συμπεριλαμβάνονται στο πλαίσιο εισαγωγής:

close - κλείνει το εισαγωγικό τμήμα
δεν απαιτούνται παράμετροι

execute - εκτελεί την καθορισμένη εντολή. Ανατρέξτε στη μέθοδο serialize() στο org.eclipse.core.command.ParameterizedCommand για λεπτομέρειες σχετικά με τη μορφή σειριοποίησης της εντολής. Από την εκδοχή 3.2.
command - μια σειριοποιημένη ParameterizedCommand
standby (optional) = ("true" | "false") "false" - υποδεικνύει εάν θα τεθεί το εισαγωγικό τμήμα σε κατάσταση αναμονής μετά την εκτέλεση της εντολής

navigate - πλοήγηση στις σελίδες εισαγωγής προς μια δεδομένη κατεύθυνση ή επιστροφή στην αρχική σελίδα
direction = ("backward" | "forward" | "home") - προσδιορίζει την κατεύθυνση πλοήγησης

openBrowser - ανοίγει τη διεύθυνση url σε ένα εξωτερικό πρόγραμμα πλοήγησης. Από την έκδοση 3.1 και έπειτα, η ενέργεια αυτή βασίζεται στην υποστήριξη του προγράμματος πλοήγησης στον πάγκο εργασίας. Αυτό σημαίνει ότι όλες οι προτιμήσεις χρήστη που έχουν οριστεί για το πρόγραμμα πλοήγησης θα ακολουθούνται.
url - ένα έγκυρο URL σε έναν εξωτερικό δικτυακό τόπο ή ένα στατικό αρχείο HTML
pluginId (optional) - απαιτείται μόνο αν προσδιορίζεται ένα στατικό αρχείο HTML. Αυτή είναι η ταυτότητα της πρόσθετης λειτουργίας στην οποία περιέχεται το αρχείο.

openURL - ανοίγει τη διεύθυνση url που είναι ενσωματωμένη στη σελίδα υποδοχής. Στην περίπτωση της παρουσίασης SWT, η διεύθυνση url εμφανίζεται σε ένα εξωτερικό πρόγραμμα πλοήγησης (παρόμοιο με την ενέργεια openBrowser που περιγράφεται παραπάνω). Από την έκδοση 3.1 και έπειτα.
url - μια έγκυρη διεύθυνση URL προς έναν εξωτερικό δικτυακό τόπο ή προς ένα τοπικό αρχείο HTML
pluginId (optional) - αν η διεύθυνση url είναι σχετική, τότε αυτή προσδιορίζει την ταυτότητα της πρόσθετης λειτουργίας στην οποία περιέχεται το αρχείο.

runAction - εκτελεί μια συγκεκριμένη ενέργεια
class - το πλήρες όνομα κλάσης που υλοποιεί μία από τις org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction ή org.eclipse.ui.IActionDelegate
pluginId - Η ταυτότητα της πρόσθετης λειτουργίας στην οποία περιέχεται η κλάση.
standby (optional) = ("true" | "false") "false" - υποδεικνύει εάν θα τεθεί το εισαγωγικό τμήμα σε κατάσταση αναμονής μετά την εκτέλεση της ενέργειας
πρόσθετες παράμετροι - τυχόν πρόσθετες παράμετροι μεταβιβάζονται σε ενέργειες που υλοποιούν την org.eclipse.ui.intro.config.IIntroAction

setStandbyMode - ρυθμίζει την κατάσταση του εισαγωγικού τμήματος
standby = ("true" | "false") - τιμή true για τη ρύθμιση του εισαγωγικού τμήματος στη μερικώς ορατή κατάσταση αναμονής και τιμή false για να καταστεί πλήρως ορατό

showHelp - Ανοίγει το σύστημα βοήθειας.
δεν απαιτούνται παράμετροι

showHelpTopic - Ανοίγει ένα θέμα βοήθειας.
id - το URL του πόρου βοήθειας. (Δείτε Javadoc για org.eclipse.ui.help.WorkbenchHelp.displayHelpResource
embed (optional) = ("true" | "false") "true" - υποδεικνύει ότι ο πόρος βοήθειας πρέπει να εμφανιστεί ενσωματωμένος στις σελίδες υποδοχής. Η προεπιλεγμένη τιμή είναι false. Αυτός ο ενδείκτης μπορεί απλά να παραβλεφθεί στην περίπτωση της παρουσίασης SWT. Από την έκδοση 3.1 και έπειτα.
embedTarget (optional) - η διαδρομή σε ένα στοιχείο div στην τρέχουσα σελίδα υποδοχής στην οποία θα βρίσκεται το περιεχόμενο του θέματος της βοήθειας. Εάν προσδιορίζεται, τότε το embed έχει την τιμή true ως προεπιλογή και η ενσωματωμένη διεύθυνση URL εισάγεται στο στοιχείο div με τη συγκεκριμένη διαδρομή. Η διαδρομή είναι σχετική με τη σελίδα και επομένως, δεν θα πρέπει να ξεκινά με την ταυτότητα της σελίδας. Τα θυγατρικά στοιχεία του στοιχείου div αντικαθίστανται από το περιεχόμενο της URL. Μόνο ένα στοιχείο div ανά σελίδα μπορεί να χρησιμοποιηθεί ως προορισμός ενσωμάτωσης. Αυτός ο ενδείκτης μπορεί απλά να παραβλεφθεί στην περίπτωση της παρουσίασης SWT. Επίσης δεν υποστηρίζεται όταν χρησιμοποιείται το XHTML ως περιεχόμενο εισαγωγικού τμήματος. Από την έκδοση 3.1 και έπειτα.


showMessage - Εμφανίζει ένα μήνυμα στον χρήστη, χρησιμοποιώντας ένα τυπικό πλαίσιο διαλόγου πληροφοριών.
message - το μήνυμα που θα εμφανιστεί στον χρήστη

showStandby - Θέτει το εισαγωγικό τμήμα σε κατάσταση αναμονής και εμφανίζει το standbyContentPart με τα συγκεκριμένα δεδομένα εισόδου
partId - η ταυτότητα του standbyContentPart που θα εμφανιστεί
input - τα δεδομένα εισόδου που ορίζονται στο standbyContentPart

showPage - εμφανίζει τη σελίδα εισαγωγής με τη δεδομένη ταυτότητα
id - η ταυτότητα της σελίδας εισαγωγής που θα εμφανιστεί
standby (optional) = ("true" | "false") "false" - υποδεικνύει εάν η εισαγωγή θα τεθεί σε κατάσταση αναμονής μετά την εμφάνιση της σελίδας

Εάν κάποια από τις παραμέτρους που μεταβιβάζονται στις ενέργειες αυτές περιέχει ειδικούς χαρακτήρες (δηλ: χαρακτήρες που δεν είναι έγκυροι σε μια διεύθυνση URL), τότε θα πρέπει να κωδικοποιηθούν με την εφαρμογή της κωδικοποίησης UTF-8 url. Για τη λήψη των παραμέτρων αυτών στην αποκωδικοποιημένη κατάστασή τους, μπορεί να χρησιμοποιηθεί μια ειδική παράμετρος,decode = ("true" "false") η οποία θα ενεργοποιήσει την αποκωδικοποίηση των παραμέτρων αυτών, κατά την επεξεργασία τους από το πλαίσιο εισαγωγής.
Για παράδειγμα, την παρακάτω διεύθυνση url εισαγωγικού τμήματος:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
θα επεξεργάζεται την παράμετρο του μηνύματος ως "This+is+a+message"
ενώ το
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&decode=true
θα επεξεργάζεται την παράμετρο του μηνύματος ως "This is a message".


  • style-id - Ένα μέσο για την κατάταξη της διασύνδεσης αυτής σε μια δεδομένη κατηγορία, έτσι ώστε να είναι δυνατή η εφαρμογή ενός κοινού στυλ.
  • filteredFrom - ένα προαιρετικό γνώρισμα που επιτρέπει την εξαγωγή με φιλτράρισμα ενός δεδομένου στοιχείου από μια συγκεκριμένη υλοποίηση. Για παράδειγμα, αν η ομάδα διαθέτει filteredFrom = swt, αυτό σημαίνει ότι η ομάδα αυτή δε θα εμφανίζεται ως περιεχόμενο στην υλοποίηση 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.


    hr


    <!ELEMENT hr EMPTY>

    <!ATTLIST hr

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    a horizontal rule.


    title


    <!ELEMENT title EMPTY>

    <!ATTLIST title

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

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


    text


    <!ELEMENT text EMPTY>

    <!ATTLIST text

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

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


    include


    <!ELEMENT include EMPTY>

    <!ATTLIST include

    configId    CDATA #IMPLIED

    path        CDATA #REQUIRED

    merge-style (true | false) >

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


    head


    <!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 (καθώς αυτό είναι κοινόχρηστο σε όλες τις σελίδες).


    img


    <!ELEMENT img EMPTY>

    <!ATTLIST img

    id           CDATA #REQUIRED

    src          CDATA #REQUIRED

    alt          CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

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


    extensionContent


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

    <!ATTLIST extensionContent

    style     CDATA #IMPLIED

    alt-style CDATA #IMPLIED
    id        CDATA #IMPLIED

    name     CDATA #IMPLIED

    path      CDATA #REQUIRED>

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


    anchor


    <!ELEMENT anchor EMPTY>

    <!ATTLIST anchor

    id CDATA #REQUIRED>

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


    contentProvider

     

    <!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 και έπειτα.