diff options
Diffstat (limited to 'org.eclipse.ui.intro/schema/introContentFileSpec.html')
| -rw-r--r-- | org.eclipse.ui.intro/schema/introContentFileSpec.html | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/org.eclipse.ui.intro/schema/introContentFileSpec.html b/org.eclipse.ui.intro/schema/introContentFileSpec.html index 0ff6a8f61..0af9bdfed 100644 --- a/org.eclipse.ui.intro/schema/introContentFileSpec.html +++ b/org.eclipse.ui.intro/schema/introContentFileSpec.html @@ -31,7 +31,8 @@ The introContent element defines the body of the intro content file. The conten <br><p class=code id=dtd><!ELEMENT <a name="e.page">page</a> (<a href="#e.group">group</a>* | <a href="#e.link">link</a>* | <a href="#e.text">text</a>* | <a href="#e.head">head</a>* | <a href="#e.img">img</a>* | <a href="#e.include">include</a>* | <a href="#e.html">html</a>* | <a href="#e.title">title</a>? | <a href="#e.anchor">anchor</a>* | <a href="#e.contentProvider">contentProvider</a>*)></p> <p class=code id=dtd><!ATTLIST page</p> -<p class=code id=dtdAttlist>url CDATA #IMPLIED<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>style CDATA #IMPLIED<p class=code id=dtdAttlist>alt-style CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) <p class=code id=dtdAttlist>content CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED></p> +<p class=code id=dtdAttlist>url CDATA #IMPLIED<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>style CDATA #IMPLIED<p class=code id=dtdAttlist>alt-style CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html)<br> +bgImage CDATA #IMPLIED <p class=code id=dtdAttlist>content CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED></p> <p></p> <p class=ConfigMarkup id=elementDesc> This element is used to describe a page to be displayed. The intro can display both dynamic and static pages.<br> @@ -72,13 +73,15 @@ The subelements used in a dynamic page are as follows: A <b>group</b> subelement This separation of pages can be used when performance is an issue, as the content of a page is now loaded more lazily.Since 3.1, if the content of the external file is XHTML 1.0, then the page is rendered as is.</li> <li><b>style-id</b> - A means to classify the page into a given category so that a common style may be applied.</li> <li><strong>shared-style </strong> - a boolean flag that controls the addition of the shared style into this page's list of styles. If true (the default), the shared style is added to this page's styles. If false , the shared style defined in the Intro configuration will not be injected into the styles of this page. </li> -<li></li> +<li><b>bgImage</b> - an optional URL of the background image to be used for this +page</li> </ul> <h2><code>group</code></h2> <br><p class=code id=dtd><!ELEMENT <a name="e.group">group</a> (<a href="#e.group">group</a>* | <a href="#e.link">link</a>* | <a href="#e.text">text</a>* | <a href="#e.img">img</a>* | <a href="#e.include">include</a>* | <a href="#e.html">html</a>* | <a href="#e.anchor">anchor</a>*)></p> <p class=code id=dtd><!ATTLIST group</p> <p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>label CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code> -<p class=code id=dtdAttlist>dynamic CDATA (true|false) "false"</p> +<p class=code id=dtdAttlist>computed CDATA (true|false) "false"<br> +bgImage CDATA #IMPLIED</p> <p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> <p></p> <p class=ConfigMarkup id=elementDesc> @@ -89,9 +92,11 @@ Used to group related content, content that should have similar style applied, o <li><b>label</b> - a label or heading for this group</li> <li><b>style-id</b> - A means to classify this group into a given category so that a common style may be applied.</li> <li><b>filteredFrom</b> - an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.</li> -<li><b>dynamic</b> - if <code>true</code>, the children of this group will be +<li><b>computed</b> - if <code>true</code>, the children of this group will be provided by the intro configurer at run time. It is advised not to define any children statically in this case.</li> +<li><b>bgImage</b> - an optional URL of the background image to be used for this +group</li> </ul> <h2><code>link</code></h2> <br><p class=code id=dtd><!ELEMENT <a name="e.link">link</a> (<a href="#e.text">text</a>? , <a href="#e.img">img</a>?)></p> @@ -287,7 +292,9 @@ An image that represents intro content and not presentation (as opposed to decor <h2><code>extensionContent</code></h2> <br><p class=code id=dtd><!ELEMENT <a name="e.extensionContent">extensionContent</a> (<a href="#e.text">text</a> | <a href="#e.group">group</a> | <a href="#e.link">link</a> | <a href="#e.html">html</a> | <a href="#e.include">include</a>)></p> <p class=code id=dtd><!ATTLIST extensionContent</p> -<p class=code id=dtdAttlist>style CDATA #IMPLIED<p class=code id=dtdAttlist>alt-style CDATA #IMPLIED<p class=code id=dtdAttlist>path CDATA #REQUIRED></p> +<p class=code id=dtdAttlist>style CDATA #IMPLIED<p class=code id=dtdAttlist>alt-style CDATA #IMPLIED<br> +id CDATA #IMPLIED<p class=code>name +CDATA #IMPLIED<p class=code id=dtdAttlist>path CDATA #REQUIRED></p> <p></p> <p class=ConfigMarkup id=elementDesc> The content to be added to the target anchor. Only one extensionContent is allowed in a given configExtension because if this extension could not be resolved (if the config could not be found, or the target anchor element could not be found) then the pages and/or groups in the extension need to be @@ -304,10 +311,18 @@ Since 3.1, styles can also be a comma separated list of styles. These styles wil A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation. The path is relative to the location of this xml content file. <br> Since 3.1, styles can also be a comma separated list of styles. These styles will be used when creating the SWT presentation of the welcome page.</li> -<li><b>path</b> - the path that uniquely represents the path to an anchor. (e.g. page/group1/group2/anchorId) within the target configuration to be extended. It can only be an anchor which can be in any page or group, including shared groups at configuration level</li> -<li><strong>content </strong> - if content is defined, it is assumed that the extension content is defined in an external XHTML file. In that case the resource pointed to by this content attribute is loaded and the path attribute is now resolved in this external file. since 3.1 </li> -<li></li> +<li><b>path</b> - the path that uniquely represents the path to an anchor. (e.g. +<b>page/group1/group2/anchorId</b>) within the target configuration to be extended. It can only be an anchor which can be in any page or group, including shared groups at configuration level. +Since 3.2, path can also use format 'page/@'. This format delegates path +resolution to the intro configurer.</li> +<li><b>id</b> - (since 3.2) a unique identifier of this extension required when +used in conjunction with intro configurer.</li> +<li><b>name</b> - (since 3.2) a translatable name of this extension required +when used in conjunction with intro configurer</li> +<li><strong>content </strong>- if content is defined, it is assumed that the extension content is defined in an external XHTML file. In that case the resource pointed to by this content attribute is loaded and the path attribute is now resolved in this external file. since 3.1 +</li> </ul> +<p></p> <h2><code>anchor</code></h2> <br><p class=code id=dtd><!ELEMENT <a name="e.anchor">anchor</a> EMPTY></p> <p class=code id=dtd><!ATTLIST anchor</p> |