XML-indeling van inleidingscontentbestanden

Versie 3.1.0

In dit document vindt u een beschrijving van de structuur van een inleidingsbestand als een reeks DTD-fragmenten.

introContent


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

Met het element introContent definieert u de tekst van het inleidingscontentbestand. Het contentbestand bestaat uit pagina's, gedeelde groepen die in meerdere pagina's kunnen worden opgenomen, en extensies voor ankerpunten die in andere configuraties gedefinieerd zijn.



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>

Dit element wordt gebruikt om een beschrijving op te geven voor een pagina die moet worden weergegeven. Met het inleidingsbestand kunnen zowel dynamische als statische pagina's worden weergegeven.

De content voor dynamische pagina's wordt gegenereerd met de subelementen van de pagina, zoals hieronder wordt beschreven. Al naar gelang de presentatie, wordt een stijl (style) of een Alt-stijl (alt-style) toegepast. De stijlen kunnen worden uitgebreid met een verwijzing naar het ID (id) of het klassen-ID (class-id).

Bij statische pagina's kunnen bestaande HTML-documenten worden hergebruikt in de inleiding, en aan links op statische of dynamische pagina's worden gekoppeld. Statische pagina's worden niet gedefinieerd via een pagina-element: het zijn HTML-bestanden waarnaar kan worden verwezen op andere pagina's.

De homepage, waarvan het ID wordt opgegeven in het presentatie-element van het introconfiguratie-extensiepunt, kan een URL hebben die aangeeft dat het een statische pagina is. Als er geen URL is opgegeven, wordt verondersteld dat het een dynamische pagina is. Alle andere beschreven pagina's met een pagina-element zijn dynamische pagina's.
Opmerking: als de SWT-presentatie is gebruikt en u wilt een statische pagina weergeven, wordt een externe browser gestart en blijft de huidige pagina zichtbaar.

Bij een dynamische pagina worden de volgende subelementen gebruikt. Het subelement group wordt gebruikt om bij elkaar behorende content te groeperen en hier een stijl op toe te passen. Met het subelement link kunt u een link definiëren om naar een statische of dynamische pagina te navigeren en om een inleidingsactie of -opdracht uit te voeren. Een link wordt gewoonlijk op paginaniveau gedefinieerd om tussen hoofdpagina's te navigeren, in tegenstelling tot links voor navigatie binnen een pagina. Met het subelement text definieert u tekstuele content op paginaniveau. Het subelement head is alleen toepasbaar op een webpresentatie en wordt gebruikt om aanvullende HTML toe te voegen aan de HTML-sectie head. Dit is nuttig als u Java-scripts of extra stijlbladen wilt toevoegen. Met het subelement img definieert u afbeeldingsinhoud op paginaniveau. Het subelement include kan worden gebruikt om elk ander element op te nemen, behalve een pagina. Het subelement html is alleen toepasbaar op een webpresentatie en wordt gebruikt voor het inbedden of insluiten van HTML in de paginacontent. U kunt een volledig gedefinieerd HTML-bestand inbedden in een HTML-object door middel van een verwijzing naar het HTML-bestand. U kunt ook rechtstreeks een stuk HTML-code uit een HTML-bestand insluiten. Het subelement title omvat de titel van de pagina. In het subelement anchor (anker) kunt u een punt definiëren voor het aanleveren van externe bijdragen via het element <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) >

Dit wordt gebruikt voor groepsgerelateerde content, content waarop dezelfde stijl moet worden toegepast of content die ook wordt opgenomen op andere pagina's.


link


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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Hiermee kunt u een link maken naar een statisch HTML-bestand, een externe website of u kunt de actie van een inleidings-URL uitvoeren.




De vooraf gedefinieerde acties hebben de volgende indeling:

action name - beschrijving van actie
action parameter1 - beschrijving van parameter.
action parameter2 (optioneel) - beschrijving van parameter.
action parameter3 (optioneel) = ("true" | "false") "false" - beschrijving van parameter. U kunt kiezen tussen true of false (waar of onwaar). "false" is de standaardwaarde.


In het inleidingsframework zijn de volgende vooraf gedefinieerde acties opgenomen:

close - hiermee wordt het inleidingsgedeelte afgesloten.
geen parameters vereist

execute - de opgegeven opdracht uitvoeren. Zie de methode serialize() van org.eclipse.core.command.ParameterizedCommand voor details over de indeling van de opdrachtserialisering. Vanaf 3.2.
command - een geserialiseerd ParameterizedCommand-item.
standby (optional) = ("true" | "false") "false" - of de inleiding in standby moet gaan nadat de opdracht is uitgevoerd.

navigate - navigeren door de inleidingspagina's in een opgegeven richting of teruggaan naar de homepage
direction = ("backward" | "forward" | "home") - de navigatierichting (vorige pagina, volgende pagina of terug naar de homepage)

openBrowser - URL openen in een externe browser. Sinds versie 3.1 is deze actie gekoppeld aan de workbenchbrowserondersteuning. Dit betekent dat alle ingestelde gebruikersvoorkeuren voor de browser worden gehonoreerd.
url - een geldige URL van een externe website of een statisch HTML-bestand.
pluginId (optioneel) - alleen vereist als u een statisch HTML-bestand hebt opgegeven. Dit is het ID van de plugin die het bestand bevat.

openURL - URL ingebed openen in de welkomstpagina. Bij een SWT-presentatie wordt de URL weergegeven in een externe browser (zoals bij de eerder beschreven actie openBrowser). Sinds versie 3.1
url - een geldige URL van een externe website of een lokaal HTML-bestand
pluginId (optioneel) - als u een relatief URL-adres gebruikt, moet u hier het ID opgeven van de plugin die het bestand bevat.

runAction - voert de opgegeven actie uit.
class - de volledig gekwalificeerde naam van een klasse waarmee org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction of org.eclipse.ui.IActionDelegate wordt geïmplementeerd.
pluginId - het ID van de plugin met de klasse.
standby (optioneel) = ("true" | "false") "false" - geeft aan of de werkstand standby moet worden geactiveerd nadat de inleidingsactie is uitgevoerd.
additional parameters - eventuele aanvullende parameters worden doorgegeven aan acties waarmee org.eclipse.ui.intro.config.IIntroAction wordt geïmplementeerd.

setStandbyMode - hiermee stelt u de status van het inleidingsgedeelte in.
standby = ("true" | "false") - kies true om over te schakelen naar de standby-werkstand en het inleidingsgedeelte gedeeltelijk zichtbaar te maken. Kies false om het volledig zichtbaar te maken.

showHelp - Help-systeem openen.
geen parameters vereist

showHelpTopic - Help-onderwerp openen.
id - URL van de Help-bron. (Zie Javadoc voor org.eclipse.ui.help.WorkbenchHelp.displayHelpResource voor meer informatie.)
embed (optioneel) = ("true" | "false") "true" - geeft aan dat de Help-bron ingebed moet worden weergegeven als onderdeel van de welkomstpagina's. De standaardinstelling is 'false' (onwaar). Bij een SWT-presentatie wordt deze vlag genegeerd. Sinds versie 3.1
embedTarget (optioneel) - het pad naar een DIV in de huidige welkomstpagina met de inhoud van het Help-onderwerp. Als u dit opgeeft, wordt embed automatisch true en wordt de ingebedde URL ingevoegd in de DIV op het opgegeven adres. Het pad is relatief ten opzichte van de pagina en mag dus niet beginnen met het pagina-ID. De onderliggende items van de DIV worden vervangen door de inhoud van de URL. Per pagina kan slechts één DIV worden ingebed. Bij een SWT-presentatie wordt deze vlag genegeerd. Deze functie wordt ook niet ondersteund wanneer u XHTML gebruikt als inleidingscontent. Sinds versie 3.1


showMessage - geeft een bericht voor de gebruiker weer in een standaardinformatievenster.
message - het bericht dat moet worden weergegeven.

showStandby - stelt het inleidingsgedeelte in op de standby-werkstand en beeldt het standbyContentPart (standbycontentgedeelte) af met de opgegeven invoer.
partId - het ID van het standbyContentPart dat moet worden afgebeeld.
input - de invoer die voor het standbyContentPart moet worden ingesteld.

showPage - de inleidingspagina met het opgegeven ID afbeelden.
id - het ID van de inleidingspagina die moet worden afgebeeld.
standby (optioneel) = ("true" | "false") "false" - met deze parameter kunt u aangeven of de standby-werkstand moet worden geactiveerd nadat de inleidingspagina is afgebeeld.

Als een van de doorgegeven parameters voor deze acties speciale tekens bevatten (tekens die niet zijn toegestaan in een URL), moeten deze URL's worden gecodeerd in de UTF-8-indeling. Als deze parameters moeten worden ontvangen in ongecodeerde vorm, gebruikt u de speciale parameter decode = ("true" "false") om de parameters geforceerd te decoderen voor verwerking in het inleidingsframework.
Stel, u hebt de volgende inleidings-URL:
http://org.eclipse.ui.intro/showMessage?message=Dit+is+een+bericht
Hierbij wordt de berichtparameter verwerkt als "Dit+is+een+bericht".
Bij
http://org.eclipse.ui.intro/showMessage?message=Dit+is+een+bericht&amp;decode=true
wordt de berichtparameter echter verwerkt als "Dit is een bericht".


  • style-id - hiermee kunt u deze link classificeren in een bepaalde categorie zodat er een standaardstijl op kan worden toegepast.
  • filteredFrom - een optioneel kenmerk waarmee een element uit een specifieke implementatie kan worden gefilterd. Als voor een groep filteredFrom = swt is opgegeven, wordt deze groep niet weergegeven als inhoud in de SWT-implementatie.
  • 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

    U kunt HTML rechtstreeks in de pagina opnemen door het hele document in te bedden of een HTML-fragment te integreren. Voor een alternatieve SWT-presentatierendering moet u een uitwijkafbeelding of -tekst definiëren. Als de content vervangingssegmenten in de notatie $plugin:plugin_id$ bevat, worden de segmenten vervangen door het absolute pad naar de plugin met het ID van plugin_id.
    U kunt een volledig gedefinieerd HTML-bestand inbedden in de content van de dynamische pagina. Hiertoe maakt u het HTML-element object met een verwijzing naar het HTML-bestand.
    U kunt ook rechtstreeks een stuk HTML-code uit een HTML-bestand in de dynamische HTML-pagina insluiten.


    hr


    <!ELEMENT hr EMPTY>

    <!ATTLIST hr

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Een horizontale lijn.


    title


    <!ELEMENT title EMPTY>

    <!ATTLIST title

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Een stukje tekst dat HTML-tags met ontsnappingstekens kan bevatten. De tekst wordt alleen als paginatitel gebruikt, dus elke pagina kan maximaal één titelelement bevatten.


    text


    <!ELEMENT text EMPTY>

    <!ATTLIST text

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Een stukje tekst dat HTML-tags met ontsnappingstekens kan bevatten. De tekst kan de tags b en li bevatten. Ook kan de tekst ankers voor URL's bevatten. Als u meerdere alinea's wenst, kunt u de tekst onderverdelen in verschillende secties met een p-tag aan het begin en het eind van elke alinea.


    include


    <!ELEMENT include EMPTY>

    <!ATTLIST include

    configId    CDATA #IMPLIED

    path        CDATA #REQUIRED

    merge-style (true | false) >

    Hiermee kunt u een element uitbreiden met het opgegeven pad (path) en optionele kenmerken voor configId. Het pad moet verwijzen naar een uniek adres van een element binnen de opgegeven configuratie. Het kan verwijzen naar gedeelde groep die op configuratieniveau is gedefinieerd of een willekeurig element van een pagina.


    head


    <!ELEMENT head EMPTY>

    <!ATTLIST head

    src CDATA #REQUIRED>

    encoding     CDATA #IMPLIED

    Verwijzing naar HTML die u wilt opnemen in het paginacontentgebied HEAD. Hiermee kunt u HTML toevoegen aan de HTML-sectie HEAD. Dit is nuttig als u Java-scripts of extra stijlbladen wilt toevoegen. Als de content vervangingssegmenten in de notatie $plugin:plugin_id$ bevat, worden de segmenten vervangen door het absolute pad naar de plugin met het ID van plugin_id. Deze markup wordt alleen gebruikt bij een HTML-implementatie met een inleidingsgedeelte. Bij een implementatie met gebruikersinterfaceschermen wordt deze code genegeerd. Een pagina kan meer dan één head-element bevatten. Een implementatie kan slechts één head-element bevatten (omdat het voor alle pagina's wordt gebruikt).


    img


    <!ELEMENT img EMPTY>

    <!ATTLIST img

    id           CDATA #REQUIRED

    src          CDATA #REQUIRED

    alt          CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Een afbeelding die inleidingscontent vertegenwoordigt en geen presentatiecontent (in tegenstelling tot decoratie-afbeeldingen die worden gedefinieerd in stijlen).


    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>

    De content die aan het doelanker moet worden toegevoegd. In elk configExtension-element mag het element extensionContent slechts één keer voorkomen, omdat de pagina's en/of groepen in de extensie moeten worden genegeerd wanneer de extensie niet kan worden omgezete (bijvoorbeeld omdat de configuratie of het doelankerelement niet is gevonden).


    anchor


    <!ELEMENT anchor EMPTY>

    <!ATTLIST anchor

    id CDATA #REQUIRED>

    Het element anchor (anker) wordt gebruikt om uitbreidingen te declareren. Het is een locatie in de configuratie waar externe aanleveringen kunnen worden gedefinieerd. Alleen ankers zijn geldige doelwaarden voor het kenmerk path van het element extensionContent.


    contentProvider

     

    <!ELEMENT contentProvider (text)>

    <!ATTLIST contentProvider

    id       CDATA #REQUIRED

    pluginId CDATA #IMPLIED

    class    CDATA #REQUIRED>

     

    Een proxy voor een provider van inleidingscontent, waarmee voor een inleidingspagina dynamische gegevens kunnen worden geladen uit verschillende bronnen (zoals het web, eclipse enzovoort) en bij uitvoering content wordt aangeleverd op basis van deze dynamische gegevens. Als de klasse IIntroContentProvider, die is opgegeven in het kenmerk class, niet kan worden geladen, wordt in plaats daarvan de inhoud van het element text weergegeven. Dit is een dynamische versie van de inleidingstag html. Hoewel u met de tag HTML statische HTML-content in de gegenereerde HTML-inleidingspagina kunt inbedden of integreren, kunt u met de tag contentProvider die content tijdens runtime dynamisch genereren. Een ander verschil tussen de tags is dat de tag HTML alleen worden ondersteund voor een HTML-presentatie, terwijl de tag contentProvider wordt ondersteund voor zowel HTML- als SWT-presentaties. Sinds versie 3.0.1