As introduções são organizadas em páginas que normalmente refletem uma categoria específica de material introdutório. Por exemplo, uma página Novidades pode apresentar novos conceitos ou funcionalidade desde a versão anterior. O conteúdo definido por uma configuração de introdução pode ser referido e estendido a partir de outros plug-ins que utilizam o ponto de extensão 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>
Um elemento de configuração pode ser utilizado para configurar uma Parte de Introdução personalizável. Um elemento de configuração deve especificar um ID, um introId e um arquivo de conteúdo. O arquivo de conteúdo da introdução é um arquivo XML que descreve as páginas, os grupos e os links que a introdução possui.
org.eclipse.ui.intro.IntroConfigurer
.<!ELEMENT presentation (implementation+ , launchBar?)>
<!ATTLIST presentation
home-page-id CDATA #REQUIRED
standby-page-id CDATA #IMPLIED>
O elemento de apresentação que define todas as possíveis implementações da apresentação de uma parte de introdução. Ele pode conter uma ou mais implementações definidas. Somente uma implementação será escolhida na inicialização, baseado nos atributos os/ws das implementações. Caso contrário, será escolhida a primeira implementação que não tenha atributos os/ws definidos.
<!ELEMENT implementation (head?)>
<!ATTLIST implementation
kind (swt|html)
style CDATA #IMPLIED
os CDATA #IMPLIED
ws CDATA #IMPLIED>
A apresentação da experiência já apresentada da Plataforma possui duas implementações. Uma delas baseia-se no Navegador SWT e a outra baseia-se em Formulários de UI. A parte de introdução personalizável pode ser configurada para obter uma dessas duas apresentações com base no OS e WS atuais. O tipo da implementação pode ser swt ou 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
computed (true | false) "false">
A barra de ativação funciona em conjunto com o comando 'switchToLaunchBar'. Quando executada, o comando fechará a introdução e criará uma barra de ativação em uma das áreas cortadas da janela principal. A barra de ativação conterá pelo menos um botão que permitirá que os usuários retornem para a última página de introdução. Opcionalmente, ela pode conter botões adicionais definidos utilizando elementos shortcut
. Esses botões podem ser utilizados para ir rapidamente para uma determinada página de introdução. Desde 3.1
esquerda
,
inferior
ou direita
). Se a opção for
configurada como visualização rápida
(o padrão), a barra
de ativação será inicialmente criada onde está a barra de
visualização rápida.true
, os elementos estáticos de atalho
definidos no plugin.xml
serão ignorados.<!ELEMENT shortcut EMPTY>
<!ATTLIST shortcut
tooltip CDATA #IMPLIED
icon CDATA #REQUIRED
url CDATA #REQUIRED>
um botão será criado na barra de ativação da introdução para cada elemento shortcut. O atalho definido da URL no atalho será executado quando o botão for pressionado. Desde 3.1
<!ELEMENT handle EMPTY>
<!ATTLIST handle
close (true | false) "true"
image CDATA #IMPLIED>
um elemento opcional que controla a quantidade de manuseio da barra de ativação que é renderizada. Desde 3.1
true
).<!ELEMENT introContent (page+ , group* , extensionContent*)>
O elemento introContent define o corpo do arquivo de conteúdo da introdução. O arquivo de conteúdo é composto por páginas, grupos compartilhados que podem ser incluídos em múltiplas páginas e extensões para pontos de âncora definidos em outras configurações.
<!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>
Esse elemento é utilizado para descrever uma página a ser exibida. A introdução pode exibir as páginas dinâmicas e estáticas.
O conteúdo para as páginas dinâmicas é gerado a partir de subelementos da página, descritos a seguir. O estilo ou o alt-estilo serão aplicados dependendo da apresentação. Os estilos podem ser mais avançados fazendo referência ao id ou id da classe.
As páginas estáticas permitem a reutilização de documentos HTML existentes na apresentação de alguém e podem ser vinculadas de qualquer página estática ou dinâmica. As páginas estáticas não são definidas em um elemento de página, simplesmente são arquivos html que podem ser vinculados por outras páginas.
A home page, cujo id é especificado no elemento de apresentação do ponto de extensão de configuração da introdução, pode ter um url indicando que é uma página estática. Se nenhum url for especificado presume-se que a home page é dinâmica. Todas as outras páginas descritas que utilizam o elemento de página são dinâmicas.
Observe também que quando a apresentação SWT é utilizada e uma página estática deve ser exibida, um navegador externo é ativado e a página atual permanece visível.
Os subelementos utilizados em uma página dinâmica são os seguintes: Um subelemento grupo é utilizado para agrupar conteúdo relacionado e aplicar estilo a todo o conteúdo agrupado. Um subelemento link define um link que possa ser utilizado para vincular uma página estática ou dinâmica e executar uma ação/comando de introdução. Um link normalmente é definido no nível da página para navegar entre as páginas principais versus os links em uma página. Um subelemento text define o conteúdo textual no nível da página. Um subelemento head só é aplicável para a apresentação baseada na Web e
permite que html adicional seja incluído na seção head de HTML. Isso é útil para a
inclusão de scripts java ou folhas de estilo extras. Um subelemento img
define conteúdo de imagem para o nível de página. Um subelemento include permite a reutilização de qualquer elemento que não seja uma página. Um subelemento html
só é aplicável para a apresentação baseada na Web e permite a incorporação ou inclusão de
html no conteúdo da página.A incorporação permite que um arquivo html totalmente
definido seja incorporado em um object HTML, definindo o arquivo html como
referência. A inclusão permite incluir um trecho em html diretamente de um arquivo html. Um subelemento title define o título da página. Um subelemento anchor define um ponto em que as contribuições externas podem ser feitas por um elemento <extensionContent>.
true
(o padrão), o estilo compartilhado será incluído
nos estilos dessa página. Se false
, o estilo
compartilhado definido na configuração de Introdução não será
inseridos nos estilos dessa 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)
computed (true | false) "false"
bgImage CDATA #IMPLIED>
Utilizado para agrupar conteúdo relacionado, conteúdo que tenha estilo semelhante aplicado ou conteúdo que seja incluído em outras páginas.
true
, os filhos deste grupo serão fornecidos pelo
configurador de introdução no tempo de execução. É aconselhável não definir nenhum filho
estaticamente nesse caso.<!ELEMENT head EMPTY>
<!ATTLIST head
src CDATA #REQUIRED
encoding CDATA #IMPLIED>
HTML direto a ser incluído em uma área de conteúdo HEAD da página. Ele permite que o html adicional seja incluído na seção HTML HEAD. Isso é útil para a inclusão de scripts java ou folhas de estilo extras. Se o conteúdo contiver segmentos de substituição do formulário $plugin:plugin_id$, então eles serão substituídos pelo caminho absoluto para o plug-in com id plugin_id. Essa marcação é para ser utilizada somente com um HTML baseado na implementação da parte de introdução. Ele é simplesmente ignorado no caso de uma implementação de Formulários de UI. Uma página pode ter mais de um elemento de cabeçalho. Uma implementação pode ter somente um elemento de cabeçalho (desde que seja compartilhado em todas as páginas.
<!ELEMENT title EMPTY>
<!ATTLIST title
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
um trecho do texto que pode conter opcionalmente tags HTML de seqüência de escape. Ele é utilizado somente como um Título de Página e, portanto, uma determinada página pode ter no máximo um elemento de título.
<!ELEMENT link (text? , img?)>
<!ATTLIST link
id CDATA #IMPLIED
label CDATA #IMPLIED
url CDATA #REQUIRED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Pode vincular a um arquivo HTML estático, um Web site externo ou pode executar uma ação de URL de Introdução.
nome da ação - descrição da ação
action parameter1 - descrição do parâmetro
action parameter2 (opcional) - descrição do parâmetro
action parameter3 (opcional) = ("true"
"false") "false" - descrição do parâmetro, opção de true ou
false e "false" é o padrão
close - fecha a parte de introdução
nenhum parâmetro necessário
navigate - navega pelas páginas de introdução em uma determinada direção ou retornar à home page
direction = ("backward"
"forward"
"home") - especifica a direção a navegar
openBrowser - abrir a url em um navegador externo. Desde a
3.1, essa ação conta com o suporte ao Navegador do ambiente de trabalho. Isso significa que quaisquer preferências do usuário configuradas para o navegador serão respeitadas.
url - uma URL válida para um Web site externo ou para um arquivo HTML local
pluginId (opcional) - se a url for relativa, ela será relativo a um plug-in. Especifique aqui o ID do plug-in que contém o arquivo.
openURL - abrir a url incorporada na página de Boas-vindas. No caso de apresentação SWT, a url é exibida em um navegador externo (semelhante à ação openBrowser acima). Desde 3.1
url - uma URL válida para um Web site externo ou para um
arquivo HTML local
pluginId (opcional) - se a url for relativa, então, isso
especifica o id do plug-in que contém o arquivo.
runAction - executa a ação especificada
class - o nome completo da classe que implementa uma dasorg.eclipse.ui.intro.config.IIntroAction
,
org.eclipse.jface.actino.IAction
ou org.eclipse.ui.IActionDelegate
pluginId - O id do plug-in que contém a classe.
standby (optional) = ("true"
"false") "false" - indica se configurar a introdução no modo de
espera após executar a ação
parâmetros adicionais - quaisquer parâmetros adicionais são transmitidos para ações que implementamorg.eclipse.ui.intro.config.IIntroAction
setStandbyMode - define o estado da parte de introdução
standby = ("true"
"false") - true para colocar a parte de introdução em seu modo
de espera parcialmente visível e false para torná-la totalmente
visível
showHelp - Abre o sistema de ajuda.
nenhum parâmetro necessário
showHelpTopic - Abre o tópico da ajuda.
id - o URL do recurso da ajuda. (Consulte Javadoc para
org.eclipse.ui.help.WorkbenchHelp.displayHelpResource)
embed (optional) = ("true"
"false") "true" - indica se o recurso da ajuda precisa ser
exibido incorporado como parte das páginas de Boas-vindas. O padrão é false.
Este sinalizador é simplesmente ignorado no caso da apresentação SWT. É equivalente ao comando openURL(), mas para tópicos do Sistema de Ajuda. A URL incorporada ocupa o estado real completo da página atual. Desde 3.1
embedTarget (optional) - o caminho para uma div na página de
Boas-vindas atual que manterá o conteúdo do tópico Ajuda. Se
especificado, embed será true por padrão e a URL incorporada
será inserida na div com o caminho especificado. O caminho é relativo à página e, portanto, não deve iniciar com o ID da página. Os filhos da div são substituídos pelo conteúdo da URL. Apenas uma div por página pode ser utilizada como um destino de incorporação. Este sinalizador é simplesmente ignorado no caso da apresentação SWT.
Ele também não é suportado quando utilizar XHTML como o conteúdo de
introdução. Desde 3.1
showMessage - Exibe uma mensagem ao usuário utilizando um diálogo de informações padrão.
message - mensagem a ser exibida ao usuário
showStandby - Define a parte de introdução para o modo de espera e mostra o standbyContentPart com a entrada específica
partId - o id do standbyContentPart a ser mostrado
input - a entrada a ser definida no standbyContentPart
showPage - mostra a página de introdução com o id específico
id - o id da página de introdução a ser mostrada
standby (optional) = ("true"
"false") "false" - indica se configurar a introdução no modo de
espera após mostrar a página
Se qualquer um dos parâmetros transmitidos para essas ações tiverem
caracteres especiais (isto é, caracteres ilegais em uma URL), eles
deverão ser codificados utilizando a codificação de URL UTF-8. Para
receber esses parâmetros dentro do estado decodificado de um
parâmetro especial, decode = ("true" "false") pode ser
utilizado para forçar uma decodificação desses parâmetros, quando a
estrutura de Introdução processá-los.
Por exemplo, a seguinte URL de Introdução:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
processará o parâmetro de mensagem como "This+is+a+message"
enquanto que
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&decode=true
processará o parâmetro de mensagem como "This is a message".
<!ELEMENT text EMPTY>
<!ATTLIST text
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
um trecho do texto que pode conter opcionalmente tags HTML de seqüência de escape. Ele pode incluir tags b e li. Pode também conter âncoras para urls. Se vários parágrafos são necessários, o texto pode ser dividido em várias seções, começando e terminando com a marcação p.
<!ELEMENT img EMPTY>
<!ATTLIST img
id CDATA #REQUIRED
src CDATA #REQUIRED
alt CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
Uma imagem que represente o conteúdo de introdução e não a apresentação (como o oposto das imagens de decoração definidas em estilos).
<!ATTLIST html
id CDATA #REQUIRED
src CDATA #REQUIRED
type (inline|embed)
style-id CDATA #IMPLIED
filteredFrom (swt|html)
encoding CDATA #IMPLIED>
HTML direto a ser incluído na página, incorporando o documento inteiro ou alinhando um trecho de HTML no local. Uma imagem ou texto de retorno deve ser definida para processamento alternativo de apresentação swt.
Se o conteúdo contiver segmentos de substituição do formulário $plugin:plugin_id$, então eles serão substituídos pelo caminho absoluto para o plug-in com id plugin_id.
A incorporação permite que um arquivo html totalmente
definido seja incorporado em um conteúdo da página dinâmica. Um elemento object HTML é criado para fazer referência ao arquivo html.
A inclusão permite incluir um trecho em html diretamente de um arquivo para uma página html.
<!ELEMENT include EMPTY>
<!ATTLIST include
configId CDATA #IMPLIED
path CDATA #REQUIRED
merge-style (true | false) >
expande um elemento marcado pelo caminhos específico e pelos atributos configId opcionais. O caminho deve identificar com exclusividade um elemento dentro da configuração especificada. Pode apontar para um grupo compartilhado definido no nível de configuração ou qualquer elemento em uma página.
true
, o estilo pertencente à página que possui o elemento incluído será adicionado à lista de estilos da página de inclusão. Se false
(o padrão), a página de inclusão será responsável pelo controle das propriedades do elemento incluído. <!ELEMENT anchor EMPTY>
<!ATTLIST anchor
id CDATA #REQUIRED>
uma âncora é o elemento utilizado para declarar a extensibilidade. É um local na configuração que permite contribuições externas. Somente as âncoras são valores de destino válidos para o atributo de caminho em uma extensionContent
<!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>
O conteúdo a ser incluído na âncora de destino. Somente um extensionContent é permitido em uma determinada configExtension porque se essa extensão não puder ser resolvida (se a configuração não foi localizada ou o elemento de âncora de destino não foi localizado), as páginas e/ou grupos na extensão precisarão ser ignorados.
<!ELEMENT contentProvider (text?)>
<!ATTLIST contentProvider
id CDATA #REQUIRED
pluginId CDATA #IMPLIED
class CDATA #REQUIRED>
Um proxy para um provedor de conteúdo de introdução, que permite que uma página de introdução extraia dados dinamicamente de várias origens (por exemplo, a Web, Eclipse etc) e forneça conteúdo em tempo de execução com base nesses dados dinâmicos. Se não for possível carregar a classe IIntroContentProvider especificada no atributo de classe, o conteúdo do elemento de texto será apresentado em seu lugar. Esta é uma versão dinâmica da tag intro de HTML. Enquanto a tag de HTML permite incorporar ou colocar em linha um conteúdo HTML estático na página de introdução HTML gerada, a tag contentProvider permite a criação dinâmica desse conteúdo em tempo de execução. Outra diferença entre as tags é que a tag HTML somente é suportada para a apresentação HTML, enquanto esta tag contentProvider é suportada para apresentações HTML e SWT. Desde 3.0.1
<!ELEMENT hr EMPTY>
<!ATTLIST hr
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
uma regra horizontal.
<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>
Direitos Autorais (c) 2004, 2006 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais fornecidos com ele são
disponibilizados sob os termos da Licença Pública do Eclipse v1.0 que acompanha
esta distribuição e está disponível em
http://www.eclipse.org/legal/epl-v10.html