| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| <head> |
| <meta name="copyright" content= |
| "Copyright (c) IBM Corporation and others 2006, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." /> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <title> |
| Help Data |
| </title> |
| <link rel="stylesheet" href="../schema.css" charset="utf-8" type= |
| "text/css" /> |
| <link rel="stylesheet" href="../book.css" charset="utf-8" type= |
| "text/css" /> |
| <style type="text/css"> |
| /*<![CDATA[*/ |
| span.c3 {color: #008000} |
| span.c2 {color: #0000FF} |
| h1.c1 {text-align:center} |
| /*]]>*/ |
| </style> |
| |
| </head> |
| <body> |
| <h1 class="c1"> |
| Help Data |
| </h1> |
| <h6 class="CaptionFigColumn"> |
| Identifier: |
| </h6>org.eclipse.help.HELP_DATA |
| <h6 class="CaptionFigColumn"> |
| Since: |
| </h6>3.3 |
| <h6 class="CaptionFigColumn"> |
| |
| Description: |
| </h6> |
| <p> |
| The help data XML file is used by products to control the order of books |
| in the help table of contents, as well whether or not books or keyword |
| index sets should be displayed at all. The file must be referenced in the |
| product's <code>plugin_customization.ini</code> file using the |
| <code>org.eclipse.help/HELP_DATA</code> property. |
| </p> |
| <h6 class="CaptionFigColumn"> |
| Configuration Markup: |
| </h6> |
| |
| <p class="SchemaDtd"> |
| <!ELEMENT <a name="e.extensions" id="e.extensions">extensions</a> |
| (<a href="#e.tocOrder">tocOrder</a>? , <a href= |
| "#e.hidden">hidden</a>?)> |
| </p> |
| <p class=""> |
| |
| The extension data for Help. |
| </p><br /> |
| <br /> |
| <p class="SchemaDtd"> |
| <!ELEMENT <a name="e.tocOrder" id="e.tocOrder">tocOrder</a> (<a href= |
| "#e.toc">toc</a> | <a href="#e.category">category</a>)*> |
| |
| </p> |
| <p class="ConfigMarkupElementDesc"> |
| Specifies the order in which top-level table of contents entries (also |
| called "books") or categories of books should appear in Help. If one of |
| the items listed is not available, it is ignored. If there are items |
| available that are not listed and not hidden, they will be displayed |
| after the ones listed here. |
| </p><br /> |
| <br /> |
| <p class="SchemaDtd"> |
| <!ELEMENT <a name="e.toc" id="e.toc">toc</a> EMPTY> |
| |
| </p> |
| <p class="SchemaDtd"> |
| <!ATTLIST toc |
| </p> |
| <p class="SchemaDtdAttlist"> |
| id CDATA #REQUIRED> |
| </p> |
| <p class="ConfigMarkupElementDesc"> |
| |
| A reference to a top-level table of contents (TOC) entry, also called a |
| "book". |
| </p><br /> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li> |
| <b>id</b> - The unique identifier for this book. For XML file TOC |
| contributions, this is a path to the file in the form |
| "<code>/<plugin_id>/<path>/<file></code>" (e.g., |
| "<code>/org.eclipse.platform.doc.user/toc.xml</code>"). In general, |
| this is the ID of the <code>TocContribution</code> supplied by its |
| originating <code>AbstractTocProvider</code>. |
| </li> |
| |
| </ul><br /> |
| <p class="SchemaDtd"> |
| <!ELEMENT <a name="e.category" id="e.category">category</a> EMPTY> |
| </p> |
| <p class="SchemaDtd"> |
| <!ATTLIST category |
| </p> |
| |
| <p class="SchemaDtdAttlist"> |
| id CDATA #REQUIRED> |
| </p> |
| <p class="ConfigMarkupElementDesc"> |
| A reference to a category of top-level table of contents (TOC) entries |
| (books). Categories are implicitly created when a table of contents |
| contribution declares itself to be of that category, for example, by |
| specifying a <code>category</code> attribute for the <code>toc</code> |
| |
| element in the <code>org.eclipse.help.toc</code> extension point. |
| </p><br /> |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li> |
| <b>id</b> - The unique id of the category. |
| </li> |
| </ul><br /> |
| |
| <p class="SchemaDtd"> |
| <!ELEMENT <a name="e.hidden" id="e.hidden">hidden</a> (<a href= |
| "#e.toc">toc</a> | <a href="#e.category">category</a> | <a href= |
| "#e.index">index</a>)*> |
| </p> |
| |
| <p class="ConfigMarkupElementDesc"> |
| Contains a set of help items that should be hidden from the user. |
| </p><br /> |
| <br /> |
| <p class="SchemaDtd"> |
| <!ELEMENT <a name="e.index" id="e.index">index</a> EMPTY> |
| </p> |
| |
| <p class="SchemaDtd"> |
| <!ATTLIST index |
| </p> |
| <p class="SchemaDtdAttlist"> |
| id CDATA #REQUIRED> |
| </p> |
| <p class="ConfigMarkupElementDesc"> |
| A reference to a contribution of help index keywords. |
| </p><br /> |
| |
| <ul class="ConfigMarkupAttlistDesc"> |
| <li> |
| <b>id</b> - The unique identifier for this contribution of keywords. |
| For XML file index contributions, this is a path to the file in the |
| form "<code>/<plugin_id>/<path>/<file></code>" (e.g., |
| "<code>/org.eclipse.platform.doc.user/index.xml</code>"). In general, |
| this is the ID of the <code>IndexContribution</code> supplied by its |
| originating <code>AbstractIndexProvider</code>. |
| </li> |
| |
| </ul><br /> |
| <h6 class="CaptionFigColumn"> |
| Examples: |
| </h6> |
| <p> |
| The following example shows how to arrange the following books in the |
| order shown: |
| </p> |
| <ul> |
| <li>Book #1: "Introduction to XYZ" (category: "<code>user.intro</code>") |
| in <code>/com.xyz.doc.user/introToc.xml</code> |
| |
| </li> |
| <li>Book #2: "Using XYZ" (category: "<code>user.content</code>") in |
| <code>/com.xyz.doc.user/usingToc.xml</code> |
| </li> |
| <li>Book #3: "Troubleshooting" (category: "<code>user.reference</code>") |
| in <code>/com.xyz.doc.user/refToc.xml</code> |
| </li> |
| |
| </ul> |
| <p> |
| As well as hide the following books/categories and related keyword |
| indexes: |
| </p> |
| <ul> |
| <li>Book #4: "Platform ABC" (category: <code>none</code>) in |
| <code>/org.abc.doc.isv/toc.xml</code> |
| </li> |
| |
| <li>Book #5: "DEF Toolkit" (category: "<code>isv.reference</code>") in |
| <code>/com.def.doc.isv/toc.xml</code> |
| </li> |
| <li>Book #6: "GHI Support" (category: "<code>isv.reference</code>") in |
| <code>/com.ghi.doc.isv/toc.xml</code> |
| </li> |
| </ul> |
| |
| <p> |
| The markup would be the following: |
| </p> |
| <pre> |
| <span class="c2"><extensions> |
| <tocOrder> |
| <toc id=</span><span class= |
| "c3">"/com.xyz.doc.user/introToc.xml"</span><span class="c2">/> |
| |
| <category id=</span><span class="c3">"user.content"</span><span class= |
| "c2">/> |
| <toc id=</span><span class= |
| "c3">"/com.xyz.doc.user/refToc.xml"</span><span class="c2">/> |
| </tocOrder> |
| <hidden> |
| <toc id=</span><span class= |
| "c3">"/org.abc.doc.isv/toc.xml"</span><span class="c2">/> |
| |
| <category id=</span><span class= |
| "c3">"isv.reference"</span><span class="c2">/> |
| <index id=</span><span class= |
| "c3">"/org.abc.doc.isv/index.xml"</span><span class="c2">/> |
| <index id=</span><span class= |
| "c3">"/com.def.doc.isv/index.xml"</span><span class="c2">/> |
| </hidden> |
| |
| </extensions></span> |
| </pre> |
| <h6 class="CaptionFigColumn"> |
| Supplied Implementation: |
| </h6>This API is supported by any help implementation that is based on |
| <code>org.eclipse.help</code>, including the default help implementation |
| provided by Eclipse. |
| <p class="SchemaCopyright"> |
| Copyright (c) 2006, 2011 IBM Corporation and others.<br /> |
| 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 <a href= |
| "http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> |
| |
| </p> |
| </body> |
| </html> |
