diff options
author | Chris Goldthorpe | 2011-10-24 23:08:47 +0000 |
---|---|---|
committer | Chris Goldthorpe | 2011-10-24 23:08:47 +0000 |
commit | b37f2554c82e64de7e3084be10572dcc7bb6d69a (patch) | |
tree | dcd643c2b368e890edd8b2dd3a1e6d5a53d75023 | |
parent | cf8cb0da972ab730451592f627a3db8a02ef36bb (diff) | |
download | eclipse.platform.common-b37f2554c82e64de7e3084be10572dcc7bb6d69a.tar.gz eclipse.platform.common-b37f2554c82e64de7e3084be10572dcc7bb6d69a.tar.xz eclipse.platform.common-b37f2554c82e64de7e3084be10572dcc7bb6d69a.zip |
Add documentation for toc placeholders
-rw-r--r-- | bundles/org.eclipse.platform.doc.isv/guide/images/helpplaceholder.png | bin | 0 -> 91583 bytes | |||
-rw-r--r-- | bundles/org.eclipse.platform.doc.isv/guide/ua_help_placeholders.htm | 53 | ||||
-rw-r--r-- | bundles/org.eclipse.platform.doc.isv/topics_Guide.xml | 2 |
3 files changed, 55 insertions, 0 deletions
diff --git a/bundles/org.eclipse.platform.doc.isv/guide/images/helpplaceholder.png b/bundles/org.eclipse.platform.doc.isv/guide/images/helpplaceholder.png Binary files differnew file mode 100644 index 000000000..6995d85bc --- /dev/null +++ b/bundles/org.eclipse.platform.doc.isv/guide/images/helpplaceholder.png diff --git a/bundles/org.eclipse.platform.doc.isv/guide/ua_help_placeholders.htm b/bundles/org.eclipse.platform.doc.isv/guide/ua_help_placeholders.htm new file mode 100644 index 000000000..384a49c65 --- /dev/null +++ b/bundles/org.eclipse.platform.doc.isv/guide/ua_help_placeholders.htm @@ -0,0 +1,53 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 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=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"> +<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script> +<title>Help Placeholders</title> +</head> +<body> + +<h2>Help Placeholders</h2> + +<p> +A help placeholder is used when documentation is not installed at the same time as the corresponding software bundles. +A placeholder contains a reference to a help page which describes how to install help bundles. +</p> +<p> +As an example suppose that for reasons of size the documentation bundle org.eclipse.myfeature.doc +was a separate download from org.eclipse.myfeature. Users who installed only org.eclipse.myfeature +without the documentation would not see the help content for myfeature and a help search would not search org.eclipse.myfeature.doc. If the developers of myfeature add a toc placeholder +the user will be made aware that documentation is available and be able to get instructions for installing it. +</p> +<p> +A help placeholder is defined using the placeholder element of the extension point org.eclipse.help.toc. +The easiest way to manage placeholders is to create bundles +which contain one or more help placeholder extensions and no code. +The code bundles will have a dependency to these help placeholder bundles. +</p> +<p> +As an example here is how to setup a placeholder for the ( nonexistent ) help bundle org.eclipse.myfeature.doc +A bundle org.eclipse.myfeature.doc.placeholder is created which contains the extension point below and no code.</p> +<pre> + <extension + point="org.eclipse.help.toc"*gt; + <placeholder + placeholderPage="http://www.eclipse.org/installingmyfeaturedocs.html" + plugin="org.eclipse.myfeature.doc"*gt; + </placeholder*gt; + </extension*gt; +</pre> +<p> +A dependency is added from the Java bundle org.eclipse.myfeature to org.eclipse.myfeature.doc.placeholder. +If the help system is launched with org.eclipse.myfeature installed and org.eclipse.myfeature.doc not installed the + home page will be replaced with a page informing of the missing documentation bundle. + In this example clicking on the link "org.eclipse.myfeature.doc" will open the page http://www.eclipse.org/installingmyfeaturedocs.html. + </p> + <p> + <img src = "images/helpplaceholder.png" alt="help showing placeholder page"> + </p> +</body> +</html>
\ No newline at end of file diff --git a/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml b/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml index 970115840..7ecb727d5 100644 --- a/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml +++ b/bundles/org.eclipse.platform.doc.isv/topics_Guide.xml @@ -407,6 +407,8 @@ </topic> <topic href="guide/ua_help_content_child_links.htm" label="Adding child links to help topics"> </topic> + <topic label="Help Placeholders"> + </topic> </topic> <topic label="Context-sensitive help" href="guide/ua_help_context.htm" > <topic label="Declaring a context id" href="guide/ua_help_context_id.htm" /> |