简介分成若干页,通常会反映特殊类别的介绍性资料。例如,“新增内容”可能会介绍自先前版本以来新增的概念或功能。可使用 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>
可用来配置可定制简介部分的配置元素。配置元素必须指定标识、简介标识和内容文件。简介内容文件是描述简介所具有的页面、组和链接的 XML 文件。
<!ELEMENT presentation (implementation+ , launchBar?)>
<!ATTLIST presentation
home-page-id CDATA #REQUIRED
standby-page-id CDATA #IMPLIED>
定义简介部分的表示的所有可能实现的表示元素。它可能定义了一个或多个实现。根据实现的 os/ws 属性,启动时只会有一个实现被选中。否则,没有定义 os/ws 属性的第一项将会被选中。
<!ELEMENT implementation (head?)>
<!ATTLIST implementation
kind (swt|html)
style CDATA #IMPLIED
os CDATA #IMPLIED
ws CDATA #IMPLIED>
平台的现成经验的表示具有两个实现。其中一项是基于 SWT 浏览器的,而另一项是基于用户界面表单的。可配置可定制简介部分以便根据当前操作系统和窗口系统选择这两个表示的其中一个。实现的类型可以是 SWT 或 HTML。
org.eclipse.core.runtime.Platform
的 Javadoc)。org.eclipse.core.runtime.Platform
的 Javadoc)。<!ELEMENT launchBar (handle? , shortcut*)>
<!ATTLIST launchBar
location (left|bottom|right|fastview) "fastview"
bg CDATA #IMPLIED
fg CDATA #IMPLIED>
启动栏与“switchToLaunchBar”命令配合工作。当命令执行时,它将关闭简介并在主窗口某一个贴面区域创建启动栏。启动栏将至少包含一个按钮,可允许用户返回到最后的简介页。(可选)它包含使用 shortcut
元素定义的其它按钮。这些按钮可用来快速转到某一特定简介页。起始版本为 3.1
left
、bottom
或 right
)。如果将此选项设置为 fastview
(缺省值),则最初将在快速视图所在位置创建启动栏。<!ELEMENT shortcut EMPTY>
<!ATTLIST shortcut
tooltip CDATA #IMPLIED
icon CDATA #REQUIRED
url CDATA #REQUIRED>
将在简介启动栏中为每个 shortcut 元素创建按钮。当按该按钮时,将执行在快捷方式中定义的 URL。起始版本为 3.1
<!ELEMENT handle EMPTY>
<!ATTLIST handle
close (true | false) "true"
image CDATA #IMPLIED>
用来控制如何呈示启动栏把手的可选元素。起始版本为 3.1
true
)。<!ELEMENT introContent (page+ , group* , extensionContent*)>
introContent 元素定义简介内容文件的主体。内容文件包括页面、可包括在多个页面中的共享组以及在其它配置中定义的锚点的扩展。
<!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) >
此元素用来描述要显示的页面。此简介可显示动态和静态页面。
动态页面的内容是从下面所述的页面的子元素生成的。将根据表示应用样式或 alt 样式。该样式可通过引用标识或类标识进一步增强。
静态页面允许在某项简介中重用现有 HTML 文档并可从任何静态或动态页面链接。静态页面未在页面元素中定义,它们只是可由其它页面链接的 HTML 文件。
其标识在简介配置扩展点的表示元素中指定的主页可能有一个 URL 指示它是静态页面。如果未指定任何 URL,则会假定主页是动态的。使用页面元素描述的所有其它页面都是动态的。
而且还要注意,在使用 SWT 表示且即将显示静态时,将启动外部浏览器而且当前页面仍然可视。
动态页面中使用的子元素如下所示:group 子元素用于组合相关内容并在组合内容间应用样式。link
子元素定义可用来链接至静态或动态页面的链接并运行简介操作/命令。链接通常是在页面级别定义的,用于在主页与页面中的链接之间进行导航。text
子元素在页面级别定义文本内容。head 子元素仅适用于基于 Web
的表示并允许将其它 HTML 添加至 HTML head 节。这在添加 java 脚本或其它样式表时特别有用。img
子元素定义页面级别的图像内容。include 子元素允许重用除页面以外的任何元素。html 子元素仅适用于基于 Web
的表示并允许在页面的内容中嵌入或包括 HTML。嵌入允许通过引用 HTML 文件将严格定义的文件嵌入到 HTML object
中。包括允许包括直接取自 HTML 文件的 HTML 片段。title 子元素定义页面的标题。anchor
子元素定义其中外部添加项可以通过 <extensionContent> 元素指定的点。
true
(缺省值),则将共享样式添加到此页面的样式中。如果为 false
,则不会将简介配置中定义的共享样式注入到此页面的样式中。<!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) >
用于组合相关内容、应该应用类似样式的内容或者应一起包括在其它页面中的内容。
<!ELEMENT head EMPTY>
<!ATTLIST head
src CDATA #REQUIRED
encoding CDATA #IMPLIED>
指示要将 HTML 包括在页面在的 HEAD 内容区域中。它允许将其它 HTML 添加至 HTML HEAD 节。这在添加 java 脚本或其它样式表时特别有用。此标记仅将与基于 HTML 的简介部分实现配合使用。只是在用户界面表单实现的情况下会忽略它。一个页面可有多个头元素。实现可有且只能有一个头元素(因为它是在所有页面间共享的)。
<!ELEMENT title EMPTY>
<!ATTLIST title
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
可选择包含转义 HTML 标记的文本片段。它仅被用作页面标题,所以给定页面最多只能有一个标题元素。
<!ELEMENT link (text? , img?)>
<!ATTLIST link
id CDATA #IMPLIED
label CDATA #IMPLIED
url CDATA #REQUIRED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
可链接至静态 HTML 文件、外部 Web 站点或可运行简介 URL 操作。
action name - 操作的描述
action parameter1 - 参数的描述
action parameter2(可选) - 参数的描述
action parameter3(可选)= ("true"
"false") "false" - 参数的描述,选项为 true 或 false,"false" 是缺省值
close - 关闭简介部分
不需要任何参数
navigate - 按给定方面浏览简介页面或返回至主页
direction = ("backward"
"forward"
"home") - 指定导航方向
openBrowser - 在外部浏览器中打开 URL。自 3.1 开始,此操作依赖于工作台浏览器支持。这意味着将采用对浏览器设置的任何用户首选项。
url - 外部 Web 站点或本地 HTML 文件的有效 URL
pluginId(可选) - 如果 URL 是相对的,则它是插件的相对 URL。在此指定包含该文件的插件的标识。
openURL - 打开“欢迎”页面中嵌入的 URL。在 SWT 表示的情况下,该 URL 显示在外部浏览器中(类似于以上的 openBrowser 操作)。起始版本为 3.1
url - 外部 Web 站点或本地 HTML 文件的有效 URL
pluginId(可选) - 如果 URL 是相对的,则它指定了包含此文件的插件的标识。
runAction - 运行指定操作
class - 实现 org.eclipse.ui.intro.config.IIntroAction
、org.eclipse.jface.actino.IAction
或 org.eclipse.ui.IActionDelegate
的其中一个的类的标准类名
pluginId - 包含该类的插件的标识。
standby(可选)= ("true"
"false") "false" - 指示是否在执行操作后将简介设置为备用方式
其它参数 - 传送至实现 org.eclipse.ui.intro.config.IIntroAction
的操作的所有其它参数
setStandbyMode - 设置简介部分的状态
standby = ("true"
"false") - 如果为 true,则会将简介部分置于部分可视备用方式,如果为 false,则会将其置于完全可视方式
showHelp - 打开帮助系统。
不需要任何参数
showHelpTopic - 打开帮助主题。
id - 帮助资源的 URL。(请参阅
org.eclipse.ui.help.WorkbenchHelp.displayHelpResource
的 Javadoc)
embed(可选)= ("true"
"false") "true" - 指示需要将帮助资源作为欢迎页面的一部分嵌入。缺省值为 false。在 SWT 表示的情况下,只需忽略此标志。这相当于 openURL() 命令,但用于帮助系统主题。嵌入的 URL 占据当前页的全部空间。起始版本为 3.1
embedTarget(可选) - 当前欢迎页面中将存储帮助主题内容的 div 的路径。如果指定此项,则缺省情况下 embed 为 true,且嵌入的 URL 插入在具有指定路径的 div 内。此路径相对于该页,因此它不应以页面标识开头。div 的子部分由 URL 的内容所替换。每页只有一个 div 可用于嵌入的目标。在 SWT 表示的情况下,只需忽略此标志。当使用 XHTML 作为简介内容时,它不受支持。起始版本为 3.1
showMessage - 使用标准信息对话框对用户显示消息。
message - 要对用户显示的消息
showStandby - 将简介部分设置为备用方式并显示带有给定输入的 standbyContentPart
partId - 要显示的 standbyContentPart 的标识
input - 要在 standbyContentPart 上设置的输入
showPage - 显示带有给定标识的简介页面
id - 要显示的简介页面的标识
standby(可选)= ("true" "false") "false" - 指示是否在显示页面后将简介设置为备用方式
如果任何传递给这些操作的参数包含特殊字符(即在 URL 中不合法的字符),则应使用
UTF-8 url 编码来对这些字符进行编码。要接收这些具有编码状态的参数,可以使用一个特殊参数 decode = ("true" "false") 来在简介框架处理这些参数时强制对它们执行解码。
例如,以下简介 url:
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message
将处理消息参数“This+is+a+message”
而
http://org.eclipse.ui.intro/showMessage?message=This+is+a+message&decode=true
将处理消息参数“This is a message”。
<!ELEMENT text EMPTY>
<!ATTLIST text
id CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
可选择包含转义 HTML 标记的文本片段。它可以包括 b 和 li 标记。它还可以包含 URL 的锚点。如果需要多个段落,就可以将文本分成多个部分,每个部分以 p 标记开头和结尾。
<!ELEMENT img EMPTY>
<!ATTLIST img
id CDATA #REQUIRED
src CDATA #REQUIRED
alt CDATA #IMPLIED
style-id CDATA #IMPLIED
filteredFrom (swt|html) >
表示简介内容和不表示的图像(与样式中定义的修饰图像相反)。
<!ATTLIST html
id CDATA #REQUIRED
src CDATA #REQUIRED
type (inline|embed)
style-id CDATA #IMPLIED
filteredFrom (swt|html)
encoding CDATA #IMPLIED>
指示 HTML 通过嵌入整个文档或在适当位置直接插入 HTML 片段来包括在页面中。必须定义回退图像或文本以便呈示备用 SWT 表示。
嵌入允许在动态页面的内容中嵌入严格定义的 HTML 文件。将创建引用 HTML 文件的 HTML object 元素。
包括允许在动态 HTML 页面中包括直接取自文件的 HTML 片段。
<!ELEMENT include EMPTY>
<!ATTLIST include
configId CDATA #IMPLIED
path CDATA #REQUIRED
merge-style (true | false) >
展开给定路径指向的元素和可选 configId 属性。路径应该唯一指向指定配置中的某个元素。它可能指向在配置级别定义的共享组或页面中的任何元素。
true
,属于拥有包括的元素的页面的样式将被添加至包括页面的样式列表。如果为
false
(缺省值),包括页面将负责控制被包括元素的控制属性。<!ELEMENT anchor EMPTY>
<!ATTLIST anchor
id CDATA #REQUIRED>
锚点是用来声明可扩展性的元素。它是配置中允许有外部添加项的位置。只有锚点才是 extensionContent 中的路径属性的有效值。
<!ELEMENT extensionContent (text | group | link | html | include)>
<!ATTLIST extensionContent
style CDATA #IMPLIED
alt-style CDATA #IMPLIED
path CDATA #REQUIRED
content CDATA #IMPLIED>
要添加至目标锚点的内容。在给定 configExtension 中只允许一个 extensionContent,这是因为如果未能解决此扩展 (如果找不到配置或者找不到目标锚点元素),就需要忽略扩展中的页面和/或组。
<!ELEMENT contentProvider (text?)>
<!ATTLIST contentProvider
id CDATA #REQUIRED
pluginId CDATA #IMPLIED
class CDATA #REQUIRED>
简介内容提供商的代理允许简介页从各种来源(Web 和 eclipse 等)动态拉出数据,并根据此动态数据在运行时提供内容。如果不能装入在类属性中指定的 IIntroContentProvider 类,则将代以呈示文本元素的内容。这是 html 简介页的动态版本。当该 html 标记允许将静态 html 内容嵌入或直接插入到所生成的 html 简介页中,则 contentProvider 标记允许在运行时动态创建内容。这些标记之间的不同之处是 html 标记仅支持 HTML 显示,而此 contentProvider 标记同时支持 HTML 和 SWT 显示。起始版本为 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, 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html