Formato XML do Arquivo de Conteúdo de Introdução

Versão 3.1.0

Este documento descreve a estrutura do arquivo de conteúdo de introdução como uma série de fragmentos DTD.

introContent


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

O elemento introContent define o corpo do arquivo de conteúdo da introdução. O arquivo de conteúdo é feito de páginas, grupos compartilhados que podem ser incluídos em várias páginas e extensões para pontos de âncora definidos em outras configurações.



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 é utilizado para descrever uma página a ser exibida. A introdução pode exibir páginas dinâmicas e estáticas.

O conteúdo das páginas dinâmicas é gerado a partir dos subelementos da página, descritos a seguir. O estilo ou estilo alt será aplicado, dependendo da apresentação. Os estilos podem ser mais aprimorados, utilizando como referência o id ou o id de classe.

As páginas estáticas permitem a reutilização dos documentos HTML existentes dentro da introdução e podem ser vinculados a partir de qualquer página estática ou dinâmica. As páginas estáticas não estão definidas em um elemento de página, elas são simplesmente arquivos html que podem estar vinculados a outras páginas.

A home page, cujo id está especificado no elemento de apresentação do ponto de extensão da configuração de introdução, pode ter uma url indicando que é uma página estática. Se nenhuma url estiver especificada, presume-se que a home page seja dinâmica. Todas as outras páginas descritas utilizando o elemento de página são dinâmicas.
Observe também que, quando a apresentação do SWT é utilizada e uma página estática é 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 group é utilizado para agrupar o conteúdo relacionado e aplicar o estilo no conteúdo agrupado. Um subelemento link define um link que pode ser utilizado para vincular uma página estática ou dinâmica e executar uma ação/comando de introdução. Normalmente, um link é definido no nível de página para navegar entre as páginas principais e os links em uma página. Um subelemento text define o conteúdo textual no nível de 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 incluir 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 diferente de 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 fragmento 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>.


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 o conteúdo relacionado, o conteúdo deve ter um estilo semelhante aplicado ou o conteúdo que será incluído em outras 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) >

Pode vincular um arquivo HTML estático, um web site externo ou pode executar um a ação Intro URL.




As ações predefinidas serão descritas utilizando este formato:

action name - descrição da ação
parâmetro de ação1 - descrição do parâmetro
parâmetro de ação2 (opcional) - descrição do parâmetro
parâmetro de ação3 (opcional) = ("true" | "false") "false" - descrição do parâmetro, opção de true ou false e "false" é o padrão


As seguintes ações predefinidas são incluídas na estrutura da introdução:

close - fecha a parte da introdução
nenhum parâmetro necessário

navigate - navega pelas páginas de introdução em uma determinada direção ou retornar para a home page
direction = ("backward" | "forward" | "home") - especifica a direção da navegação

openBrowser - abre a url em um navegador externo. Desde a 3.1, essa ação conta com o suporte ao Navegador do workbench. 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 um arquivo HTML estático
pluginId (opcional) - somente necessário se um arquivo HTML estático estiver especificado. Este é o id do plug-in contendo o arquivo.

openURL - abre a url incorporada na página de Boas-vindas. No caso da apresentação SWT, o url é exibido em um navegador externo (semelhante ao da 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 qualificado da classe que implementa um org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction ou org.eclipse.ui.IActionDelegate.
pluginId - A id do plug-in que contém a classe.
standby (opcional) = ("true" | "false") "false" - indica se o modo de espera deve ser configurado para a introdução depois de 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 da 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 um tópico da ajuda.
id - a URL do recurso de ajuda. (Consulte Javadoc para org.eclipse.ui.help.WorkbenchHelp.displayHelpResource
embed(opcional) = ("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.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 para o usuário, utilizando um diálogo de informações padrão.
message - a mensagem a ser mostrada para o usuário

showStandby - Configura a parte da introdução para o modo de espera e mostra o standbyContentPart com a entrada fornecida
partId - o id de standbyContentPart a ser mostrado
input - a entrada a ser configurada em standbyContentPart

showPage - mostra a página da introdução com o id fornecido
id - o id da página de introdução a ser mostrada
standby (opcional) = ("true" | "false") "false" - indica se a introdução deve ser configurada no modo de espera depois de 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&amp;decode=true
processará o parâmetro de mensagem como "This is a message".


  • style-id - Um meio de classificar esse link em uma determinada categoria para que um estilo comum possa ser aplicado.
  • filteredFrom - um atributo opcional que permite filtrar um determinado elemento fora de uma implementação específica. Por exemplo, se um grupo tem filteredFrom = swt, significa que este grupo não aparecerá como conteúdo na implementação 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 direto a ser incluído na página por incorporação de todo o documento ou inserção de um fragmento do HTML no local. Uma imagem de fallback ou de texto deve ser definida para processamento da apresentação swt alternativa.
    A incorporação permite que um arquivo html completamente definido seja incorporado ao conteúdo da página dinâmica. Um elemento do objeto HTML é criado e faz referência ao arquivo html.
    A inclusão permite incluir um fragmento de html diretamente de um arquivo para uma página html dinâmica.


    title


    <!ELEMENT title EMPTY>

    <!ATTLIST title

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    um fragmento do texto que pode opcionalmente conter marcações HTML de escape. É utilizado somente como Título da Página e assim uma determinada página pode ter no máximo um elemento de título.


    text


    <!ELEMENT text EMPTY>

    <!ATTLIST text

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    um fragmento do texto que pode opcionalmente conter marcações HTML de escape. Pode incluir as marcações b e li. Pode conter também as âncoras para urls. Se vários parágrafos forem necessários, o texto poderá ser dividido em várias seções, cada uma delas começando com a tag p.


    include


    <!ELEMENT include EMPTY>

    <!ATTLIST include

    configId    CDATA #IMPLIED

    path        CDATA #REQUIRED

    merge-style (true | false) >

    expande um elemento destinado pelo caminho determinado e os atributos configId opcionais. O caminho deve exclusivamente direcionar um elemento dentro da configuração especificada. Poderia apontar para um grupo compartilhado no nível de configuração ou qualquer elemento em uma página.


    head


    <!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. Permite que html adicional seja incluído na seção HEAD de HTML. Isso é útil para incluir scripts java ou folhas de estilo extras. Esta marcação deve ser utilizada somente com um HTML com base na implementação da parte da introdução. Ela é simplesmente ignorada no caso de uma implementação dos Formulários da UI. Uma página pode ter mais de um elemento de título.Uma implementação pode ter um e somente um elemento de título (desde que seja compartilhado em todas as páginas).


    img


    <!ELEMENT img EMPTY>

    <!ATTLIST img

    id           CDATA #REQUIRED

    src          CDATA #REQUIRED

    alt          CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    Uma imagem que representa o conteúdo da introdução e não a apresentação (conforme o oposto das imagens de decoração definidas nos estilos).


    extensionContent


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

    <!ATTLIST extensionContent

    style     CDATA #IMPLIED

    alt-style  CDATA #IMPLIED

    path      CDATA #REQUIRED>

    O conteúdo a ser incluído na âncora de destino. Apenas um extensionContent é permitido em uma determinada configExtension porque se essa extensão não puder ser resolvida (se a configuração ou o elemento âncora de destino não puder ser encontrado) as páginas e/ou grupos na extensão precisarão ser ignorados.


    anchor


    <!ELEMENT anchor EMPTY>

    <!ATTLIST anchor

    id CDATA #REQUIRED>

    uma âncora é o elemento utilizado para declarar 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 um extensionContent


    contentProvider

     

    <!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 obtenha dados dinamicamente de várias origens (por exemplo, da Web, do Eclipse, etc.) e forneça conteúdo em tempo de execução com base nesses dados dinâmicos. Se a classe IIntroContentProvider especificada no atributo class não puder ser carregada, o conteúdo do elemento text será renderizado no lugar. Essa é uma versão dinâmica da tag de introdução HTML. Enquanto a tag HTML permite a incorporação ou seqüenciamento de um conteúdo HTML estático na página de introdução HTML gerada, a tag contentProvider permite a criação dinâmica daquele conteúdo em tempo de execução. Outra diferença entre as tags é que a tag HTML é suportada apenas para a apresentação HTML, enquanto essa tag contentProvider é suportada para as apresentações HTML e SWT. Desde 3.0.1