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 é 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.



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>

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 páginas dinâmicas é gerado a partir de dos 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 é usada 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>.


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

Utilizado para agrupar conteúdo relacionado, conteúdo que tenha estilo semelhante aplicado ou conteúdo que seja 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 a um arquivo HTML estático, um Web site externo ou pode executar uma ação de URL de Introdução.




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

action name - 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


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

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

execute - executa o comando especificado. Consulte o método serialize() em org.eclipse.core.command.ParameterizedCommand para obter detalhes do formato de serialização de comando. Desde a 3.2.
command - um ParameterizedCommand serializado
standby (optional) = ("true" | "false") "false" - indica a definição ou não da introdução no modo de espera depois de executar o comando

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 - abre 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 - um URL válido para um Web site externo ou um arquivo HTML estático
pluginId (opcional) - necessário somente se um arquivo HTML estático for especificado. Esse é 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 de classe completo da classe que implementa um dos seguintes: org.eclipse.ui.intro.config.IIntroAction, org.eclipse.jface.action.IAction ou org.eclipse.ui.IActionDelegate
pluginId - O id do plug-in que contém a classe.
standby (opcional) = ("true" | "false") "false" - indica se deve definir 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 o Javadoc para obterorg.eclipse.ui.help.WorkbenchHelp.displayHelpResource
embed (opcional) = ("true" | "false") "true" - indica que o recurso de 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 (opcional) - 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 (opcional) = ("true" | "false") "false" - indica se deve definir 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&amp;decode=true
processará o parâmetro de mensagem como "This is a message".


  • style-id - Um meio de classificar este link em uma categoria dada 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 tiver filteredFrom = swt, significa que esse 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, 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.


    hr


    <!ELEMENT hr EMPTY>

    <!ATTLIST hr

    id           CDATA #IMPLIED

    style-id     CDATA #IMPLIED

    filteredFrom (swt|html) >

    uma regra horizontal.


    title


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


    text


    <!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 forem necessários vários parágrafos, o texto pode ser dividido em várias seções, cada uma começando e terminando com a tag p.


    include


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


    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. Ele permite que o html adicional seja incluído na seção HTML HEAD. Isso é útil para incluir 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.


    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 represente o conteúdo de introdução e não a apresentação (como o oposto das imagens de decoração definidas em estilos).


    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>

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


    anchor


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


    contentProvider

     

    <!ELEMENT contentProvider (texto)>

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