Configuração da Parte de Introdução

org.eclipse.ui.intro.config

3.0

Esse ponto de extensão é utilizado para registrar uma configuração da introdução. Essa configuração fornece implementações de apresentação e conteúdo para uma determinada contribuição de introdução. Uma introdução aparece quando o ambiente de trabalho é ativado pela primeira vez e como uma opção do menu "Ajuda". Geralmente a introdução é utilizada para apresentar ao usuário um produto construído no Eclipse.

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.



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



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



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



O elemento handle foi reprovado

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



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



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



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



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



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



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



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



A seguir está um exemplo do ponto de extensão de configuração.

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

Para obter detalhes adicionais, consulte a especificação do pacote de API org.eclipse.ui.intro.config.

A introdução contribuída pelo plugin org.eclipse.platform é a única implementação no Eclipse.