Las introducciones se organizan en páginas que generalmente reflejan una categoría determinada de material introductorio. Por ejemplo, una página de Novedades puede presentar conceptos o funciones nuevos con respecto a versiones anteriores. Puede hacerse referencia y ampliarse el contenido definido por una configuración de introducción desde otros conectores mediante el punto de extensión org.eclipse.ui.intro.configExtension.
<!ELEMENT extension (handle? , 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>
Un elemento config puede utilizarse para configurar un componente Intro personalizable. Un elemento config debe especificar un ID, un introId y un archivo de contenido. El archivo de contenido de hoja de intro es un archivo XML que describe las páginas, grupos y enlaces que contiene la introducción.
<!ELEMENT presentation (implementation+ , launchBar?)>
<!ATTLIST presentation
home-page-id CDATA #REQUIRED
standby-page-id CDATA #IMPLIED>
Elemento presentation que define todas las implementaciones posibles de una presentación de componente intro. Puede contener una o varias implementaciones definidas. Durante el inicio sólo se elegirá una implementación, en función de los atributos os/ws de las implementaciones. De lo contrario, se elegirá la primera sin atributos os/ws.
<!ELEMENT implementation (head?)>
<!ATTLIST implementation
kind (swt|html)
style CDATA #IMPLIED
os CDATA #IMPLIED
ws CDATA #IMPLIED>
La presentación de la plataforma tiene dos implementaciones posibles. Una de ellas se basa en el navegador de SWT, mientras que la otra se basa en formularios de UI. El componente intro personalizable puede configurarse para elegir de esas dos presentaciones en función de los OS y WS actuales. El tipo de la implementación puede ser swt o html.
org.eclipse.core.runtime.Platform
).org.eclipse.core.runtime.Platform
).<!ELEMENT launchBar (handle? , shortcut*)>
<!ATTLIST launchBar
location (left|bottom|right|fastview) "fastview"
bg CDATA #IMPLIED
fg CDATA #IMPLIED>
La barra de lanzamiento funciona conjuntamente con el mandato
'switchToLaunchBar'. Al ejecutarse, el mandato cerrará la introducción y creará una barra de
lanzamiento en una de las áreas de recorte de la ventana principal. La barra de lanzamiento contendrá como mínimo un botón que permitiría a los
usuarios volver a la última página de introducción. Opcionalmente, puede contener botones adicionales definidos utilizando elementos
shortcut
. Estos botones pueden utilizarse para ir rápidamente a
una página de introducción determinada. A partir de la versión 3.1
left
(izquierda), bottom
(abajo) o
right
(derecha)). Si se establece la opción de
fastview
(valor por omisión), la barra de lanzamiento
se creará inicialmente donde se encuentra la barra de vista rápida.
<!ELEMENT shortcut EMPTY>
<!ATTLIST shortcut
tooltip CDATA #IMPLIED
icon CDATA #REQUIRED
url CDATA #REQUIRED>
se creará un botón en la barra de lanzamiento de introducción para cada elemento de acceso directo. El URL definido en el acceso directo se ejecutará cuando se pulse el botón. A partir de la versión 3.1
<!ELEMENT handle EMPTY>
<!ATTLIST handle
close (true | false) "true"
image CDATA #IMPLIED>
elemento opcional que controla cómo se presenta el handle de la barra de lanzamiento. A partir de la versión 3.1
true
).<!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.
<!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) >
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>.
true
(valor por omisión), el estilo compartido se añade a
los estilos de esta página.
Si es false
, el estilo compartido definido en la configuración de
introducción no se inyectará en los estilos de esta página.
<!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) >
Utilizado para agrupar contenido relacionado, contenido al que debe aplicarse un estilo similar o contenido que se incluirá en otras páginas.
<!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).
<!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.
<!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.
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ámetero3 de acción (opcional) = ("true"
"false") "false" - descripción de parámetro, elección entre true
(verdadero) y false (falso), siendo "false" el valor por omisión
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 la dirección en que se ha de navegar
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 local
pluginId (opcional) - si el URL es relativo, lo es respecto a un
conector. Especifique aquí el 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.actino.IAction
o
org.eclipse.ui.IActionDelegate
pluginId - ID del conector que contiene la clase.
standby (opcional) = ("true"
"false") "false" - indica si se establece intro 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 el componente intro en su modalidad de espera parcialmente visible, y false para hacerlo 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 (opcional) = ("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. Esto equivale al mandato openURL(), aunque para los temas del sistema de ayuda. El URL incorporado ocupa el espacio completo de la página actual. 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 (optional) = ("true"
"false") "false" - indica si se establece intro en la 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&decode=true
procesará el parámetro de mensaje como "Esto es un mensaje"
<!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.
<!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).
<!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.
<!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.
true
, el estilo que pertenece a la página propietaria del elemento incluido se añadirá a la lista de estilos de la página incluyente. Si es false
(valor por omisión), la página incluyente será responsable de controlar las propiedades del elemento incluido.<!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
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED
content CDATA #IMPLIED>
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.
<!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
<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>
Copyright (c) 2004 IBM Corporation y otros.
Reservados todos los derechos.
Este programa y sus materiales adjuntos están disponibles bajo los términos de
la licencia pública común (Eclipse Public License) v1.0 que acompaña a esta
distribución, y está disponible en
http://www.eclipse.org/legal/epl-v10.html