Formato XML del archivo de contenido de introducción

Versión 3.1.0

Este documento describe la estructura de archivos de contenido de introducción como una serie de fragmentos de DTD.

introContent


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

El elemento introContent define el cuerpo del archivo de contenido de introducción. El archivo de contenido está formado por páginas, grupos compartidos que pueden incluirse en varias páginas y extensiones para puntos de anclaje definidos en otras configuraciones.



page


<!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>

Este elemento se utiliza para describir una página que debe visualizarse. La introducción puede visualizar páginas tanto estáticas como dinámicas.

El contenido de las páginas dinámicas se genera desde los subelementos de la página, descritos más adelante. Se aplicará el estilo o estilo alternativo dependiendo de la presentación. Los estilos pueden mejorarse haciendo referencia al ID o ID de clase.

Las páginas estáticas permiten la reutilización de documentos HTML existentes en la introducción del usuario, y éste puede enlazarse a ellas desde cualquier página estática o dinámica. Las páginas estáticas no se definen en un elemento page, sino que son simplemente archivos html a los que otras páginas pueden enlazarse.

La página inicial, cuyo ID se especifica en el elemento presentation del punto de extensión intro config, puede tener un URL que indique que se trata de una página estática. Si no se especifica ningún URL, se presupone que la página inicial es dinámica. Todas las demás páginas descritas mediante el elemento page son dinámicas.
Tenga en cuanta también que, si se utiliza la presentación SWT y debe visualizarse una página estática, se lanza un navegador externo y la página actual permanece visible.

Los subelementos utilizados en una página dinámica son los siguientes: un subelemento group se utiliza para agrupar contenido relacionado y aplicar el estilo a todo el contenido agrupado. Un subelemento link define un enlace que puede utilizarse para enlazarse a una página estática o dinámica y ejecutar una acción/mandato de introducción. Un enlace se define generalmente a nivel de página para navegar entre páginas principales, al contrario que los enlaces situados dentro de una página. Un subelemento text define contenido textual a nivel de página. Un subelemento head sólo es aplicable a la presentación basada en la Web y permite añadir html adicional a la sección HTML head. Esto resulta de utilidad para añadir scripts Java u hojas de estilo adicionales. Un subelemento imgdefine contenido de imagen a nivel de página. Un subelemento include permite reutilizar cualquier elemento que no sea una página. Un subelemento html sólo es aplicable a la presentación basada en la Web y permite incluir o intercalar html en el contenido de la página. La intercalación permite intercalar un archivo html totalmente definido dentro de un objeto HTML haciendo referencia al archivo html. La inclusión permite incluir un fragmento de código html directamente desde un archivo html. Un subelemento title define el título de la página. Un subelemento anchor define un punto en el que pueden efectuarse contribuciones externas mediante un elemento <extensionContent>.


group


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

<!ATTLIST group

id           CDATA #REQUIRED

label        CDATA #IMPLIED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Utilizado para agrupar contenido relacionado, contenido al que debe aplicarse un estilo similar o contenido que se incluirá en otras páginas.


link


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

<!ATTLIST link

id           CDATA #IMPLIED

label        CDATA #IMPLIED

url          CDATA #REQUIRED

style-id     CDATA #IMPLIED

filteredFrom (swt|html) >

Puede enlazarse a un archivo HTML estático, a un sitio Web externo o puede ejecutar una acción de URL de introducción.




Las acciones predefinidas se describirán mediante este formato:

nombre acción - descripción de acción
parámetro1 de acción - descripción de parámetro
parámetro2 de acción (opcional) - descripción de parámetro
parámetro3 de acción (opcional) = ("true" | "false") "false" - descripción de parámetro, opción de elegir true o false; el valor por omisión es "false"


En la infraestructura de introducción se incluyen las siguientes acciones predefinidas:

close - cierra el componente intro
no se requieren parámetros

navigate - navega por las páginas de introducción en un sentido dado o vuelve a la página inicial
direction = ("backward" | "forward" | "home") - especifica el sentido de la navegación

openBrowser - abrir el URL en un navegador externo. A partir la versión 3.1, esta acción se basa en el soporte de navegadores del entorno de trabajo. Esto quiere decir que se respetarán las preferencias de usuario establecidas para el navegador.
url - un URL válido a un sitio Web externo o a un archivo HTML estático
pluginId (opcional) - sólo es necesario si se especifica un archivo HTML estático. Se trata del ID del conector que contiene el archivo.

openURL - abrir el URL incorporado en la página de bienvenida. En el caso de la presentación SWT, el URL se visualiza en un navegador externo (similar a la acción openBrowser indicada anteriormente). A partir de la versión 3.1
url - un URL válido a un sitio web externo o a un archivo HTML local
pluginId (opcional) - si el URL es relativo, especifica el ID del conector que contiene el archivo.

runAction - ejecuta la acción especificada
class - nombre de clase totalmente calificado de la clase que implementa org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction u org.eclipse.ui.IActionDelegate
pluginId - ID del conector que contiene la clase.
standby (opcional) = ("true" | "false") "false" - indica si debe establecerse la introducción en modalidad de espera después de ejecutar la acción
parámetros adicionales - los parámetros adicionales se pasan a las acciones que implementan org.eclipse.ui.intro.config.IIntroAction

setStandbyMode - establece el estado del componente intro
standby = ("true" | "false") - true para situar la parte intro en su modalidad de espera parcialmente visible, y false para hacerla totalmente visible

showHelp - abrir el sistema de ayuda.
no se requieren parámetros

showHelpTopic - abrir un tema de la ayuda.
id - URL del recurso de ayuda. (Consulte el Javadoc de org.eclipse.ui.help.WorkbenchHelp.displayHelpResource)
embed (optional) = ("true" | "false") "true" - indica que el recurso de ayuda tiene que visualizarse incorporado como parte de las páginas de bienvenida. El valor por omisión es false. En el caso de la presentación SWT, este distintivo simplemente se pasa por alto. A partir de la versión 3.1
embedTarget (opcional) - vía de acceso a una div en la página de bienvenida actual que tendrá el contenido del tema de ayuda. Si se especifica, embed tiene el valor true por omisión y el URL incorporado se inserta en div con la vía de acceso especificada. La vía de acceso es relativa a la página y por ello no debe comenzar por el ID de página. Los hijos de la div se sustituyen por el contenido del URL. Sólo puede utilizarse una div por página como destino de incorporación. En el caso de la presentación SWT, este distintivo simplemente se pasa por alto. Tampoco está soportado si se utiliza XHTML como contenido de introducción. A partir de la versión 3.1


showMessage - muestra al usuario un mensaje mediante un diálogo de información estándar.
message - el mensaje que debe mostrarse al usuario.

showStandby - establece el componente intro en modalidad de espera y muestra el standbyContentPart con la entrada dada
partId - ID del standbyContentPart que debe mostrarse
input - entrada que debe establecerse en el standbyContentPart

showPage - mostrar la página de introducción con el ID dado
id - ID de la página de introducción que debe mostrarse
standby (opcional) = ("true" | "false") "false" - indica si debe establecerse la introducción en modalidad de espera después de mostrar la página

Si algunos de los parámetros pasados a estas acciones tienen caracteres especiales (es decir, caracteres que no están permitidos en un URL), deben codificarse mediante la codificación de URL UTF-8. Para recibir estos parámetros en estado descodificado puede utilizarse un parámetro especial, decode = ("true" "false") para forzar la descodificación de estos parámetros cuando la infraestructura Intro los procese.
Por ejemplo, el siguiente URL de introducción:
http://org.eclipse.ui.intro/showMessage?message=Esto+es+un+mensaje
procesará el parámetro de mensaje como "Esto+es+un+mensaje"
mientras que
http://org.eclipse.ui.intro/showMessage?message=Esto+es+un+mensaje&amp;decode=true
procesará el parámetro de mensaje como "Esto es un mensaje"


  • style-id - Medio para clasificar este enlace en una categoría dada para que pueda aplicarse un estilo común.
  • filteredFrom - Atributo opcional que permite filtrar un elemento dado de una implementación específica. Por ejemplo, si un grupo tiene filteredFrom = swt, significa que este grupo no aparecerá como contenido en la implementación 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 directo que debe incluirse en la página incorporando todo el documento o un fragmento de HTML in situ. debe definirse una imagen o texto de urgencia para la visualización de presentación SWT alternativa.
    La intercalación permite intercalar un archivo html totalmente definido dentro del contenido de una página dinámica. Se crea un elemento HTML object que hace referencia al archivo html.
    La inclusión permite incluir un fragmento de código html directamente desde un archivo html en la página html dinámica.


    title


    <!ELEMENT title EMPTY>

    <!ATTLIST title

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    fragmento de texto que puede contener opcionalmente códigos de escape HTML. Sólo se utiliza como título de página, y por tanto una página determinada puede tener un máximo de un elemento title.


    text


    <!ELEMENT text EMPTY>

    <!ATTLIST text

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    fragmento de texto que puede contener opcionalmente códigos de escape HTML. Puede incluir códigos b y li. También puede contener anclas para los URL. Si son necesarios varios párrafos, el texto puede dividirse en varias secciones, cada una de las cuales empieza y termina con el código p.


    include


    <!ELEMENT include EMPTY>

    <!ATTLIST include

    configId    CDATA #IMPLIED

    path        CDATA #REQUIRED

    merge-style (true | false) >

    expande un elemento dirigido por la vía de acceso especificada y atributos configId opcionales. La vía de acceso debe dirigir exclusivamente un elemento dentro de la configuración especificada. Puede señalar a un grupo compartido definido a nivel de configuración o a cualquier elemento de una página.


    head


    <!ELEMENT head EMPTY>

    <!ATTLIST head

    src CDATA #REQUIRED>

    encoding     CDATA #IMPLIED

    HTML directo que debe incluirse en el área de contenido HEAD de una página. Permite añadir html adicional a la sección HTML HEAD. Esto resulta de utilidad para añadir scripts Java u hojas de estilo adicionales. Este código sólo debe utilizarse con una implementación de componente intro basada en HTML. En el caso de una implementación de formularios de UI, simplemente se pasa por alto. Una página puede tener más de un elemento head. Una implementación sólo puede tener un elemento head (ya que lo comparten todas las páginas).


    img


    <!ELEMENT img EMPTY>

    <!ATTLIST img

    id           CDATA #REQUIRED

    src          CDATA #REQUIRED

    alt          CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Imagen que representa contenido de introducción y no de presentación (al contrario de las imágenes de decoración definidas en los estilos).


    extensionContent


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

    <!ATTLIST extensionContent

    style     CDATA #IMPLIED

    alt-style CDATA #IMPLIED

    path      CDATA #REQUIRED>

    Contenido que debe añadirse al ancla destino. Sólo se permite un extensionContent en una configExtension dada, ya que, si esta extensión no puede resolverse (si no puede encontrarse la configuración o el elemento anchor destino), las páginas y/o grupos de la extensión deben pasarse por alto.


    anchor


    <!ELEMENT anchor EMPTY>

    <!ATTLIST anchor

    id CDATA #REQUIRED>

    un ancla es el elemento utilizado para declarar la ampliabilidad. Es una ubicación de la configuración que permite contribuciones externas. Sólo las anclas son valores destino válidos para el atributo path de un extensionContent


    contentProvider

     

    <!ELEMENT contentProvider (text)>

    <!ATTLIST contentProvider

    id       CDATA #REQUIRED

    pluginId CDATA #IMPLIED

    class    CDATA #REQUIRED>

     

    Un proxy para un proveedor de contenido de introducción, que permite que una página de introducción extraiga datos dinámicamente de diversas fuentes (por ejemplo, la Web, Eclipse, etc.) y proporciona contenido durante la ejecución basado en estos datos dinámicos. Si no se puede cargar la clase IIntroContentProvider que se especifica en el atributo class, en su lugar se presentará el contenido del elemento de texto. Es una versión dinámica del código de introducción html. Mientras que el código html permite incorporar un contenido estático en HTML a la página de introducción HTML generada, el código contentProvider permite la creación dinámica de dicho contenido durante la ejecución. Otra diferencia entre los códigos es que el código html sólo está soportado para la presentación HTML, mientras que este código contentProvider está soportado para presentaciones HTML y SWT. A partir de la versión 3.0.1