blob: e79292acc8f1361250a60f4865702d128bcda342 [file] [log] [blame]
Xiaoying Gu07591712010-12-06 06:28:46 +00001<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html lang="en" xml:lang="en">
5<head>
6<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7<meta name="copyright" content="(C) Copyright 2005"/>
8<meta name="DC.rights.owner" content="(C) Copyright 2005"/>
9<meta name="DC.Type" content="concept"/>
10<meta name="DC.Title" content="UI Plug-ins Associated with Help Contexts"/>
11<meta name="abstract" content="DITA maps for context-sensitive help plug-ins must contain a &lt;topicmeta&gt; element as the first child of the &lt;map&gt; element, and for each UI plug-in whose help context IDs are identified in the map, that &lt;topicmeta&gt; element must contain one &lt;othermeta&gt; element that identifies the UI plug-in."/>
12<meta name="description" content="DITA maps for context-sensitive help plug-ins must contain a &lt;topicmeta&gt; element as the first child of the &lt;map&gt; element, and for each UI plug-in whose help context IDs are identified in the map, that &lt;topicmeta&gt; element must contain one &lt;othermeta&gt; element that identifies the UI plug-in."/>
13<meta name="DC.Relation" scheme="URI" content="../../../../../projects/dtp/dtp/en/source/c_csh_plugins_with_dita.html"/>
14<meta name="DC.Creator" content="dresch"/>
15<meta name="DC.Format" content="XHTML"/>
16<meta name="DC.Identifier" content="concept_6245D50571D94B8E8D2B63620A5D9043"/>
17<meta name="DC.Language" content="en"/>
18<link rel="stylesheet" type="text/css" href="../../../../../styles/commonltr.css"/>
19<link rel="stylesheet" type="text/css" href="../../../../../styles/doc.css"/>
20<title>UI Plug-ins Associated with Help Contexts</title>
21<meta name="provider" content="Sybase, Inc."/></head>
22<body id="concept_6245D50571D94B8E8D2B63620A5D9043"><a name="concept_6245D50571D94B8E8D2B63620A5D9043"><!-- --></a>
23<br/>
24
25 <h1 class="topictitle1">UI Plug-ins Associated with Help Contexts</h1>
26
27
28 <div><p>DITA maps for context-sensitive help plug-ins must contain a
29 <samp class="codeph">&lt;topicmeta&gt;</samp> element
30 as the first child of the
31 <samp class="codeph">&lt;map&gt;</samp> element, and for each UI plug-in
32 whose help context IDs are identified in the map, that
33 <samp class="codeph">&lt;topicmeta&gt;</samp> element must contain one
34 <samp class="codeph">&lt;othermeta&gt;</samp> element that identifies the
35 UI plug-in.
36 </p>
37
38
39
40 <div class="note"><span class="notetitle">Note:</span> The <samp class="codeph">&lt;othermeta&gt;</samp> elements that identify
41 UI plug-ins should be the last child element in the
42 <samp class="codeph">&lt;topicmeta&gt;</samp> element. The
43 <samp class="codeph">&lt;topicmeta&gt;</samp> element may contain any other valid child elements
44 (preceding the
45 <samp class="codeph">&lt;othermeta&gt;</samp> elements that identify UI plug-ins).
46 </div>
47
48 <div class="p">The <samp class="codeph">&lt;othermeta&gt;</samp> element’s name
49 and content attribute values will be used to
50 identify UI plug-ins in the org.eclipse.help.contexts extension, which is
51 declared in the plug-in manifest (plugin.xml file) of the context-sensitive help
52 plug-in. For example:
53 <pre class="codeblock">
54 &lt;map id="org.eclipse.datatools.ui.doc"&gt;
55 &lt;topicmeta&gt;
56 ...
57 &lt;othermeta name="ui-plugin"
58 content="org.eclipse.datatools.connectivity.ui"/&gt;
59 &lt;othermeta name="ui-plugin"
60 content="org.eclipse.datatools.connectivity.ui.dse"/&gt;
61 &lt;/topicmeta&gt;
62 ...
63 &lt;/map&gt;
64</pre>
65
66 </div>
67
68 <p>The name attribute value "ui-plugin" is a fixed, literal string. The content
69 attribute value is the Eclipse plug-in ID of a UI plug-in.
70 </p>
71
72
73 <p>Nested maps that contribute context-related help topics must include the
74 same markup to identify each UI plug-in whose context IDs are identified in that
75 map.
76 </p>
77
78 </div>
79
80<div>
81<div class="familylinks">
82<div class="parentlink"><strong>Parent topic:</strong> <a href="../../../../../projects/dtp/dtp/en/source/c_csh_plugins_with_dita.html" title="Any DITA map document that defines an online documentation (doc) plug-in can be modified to also define a corresponding context-sensitive help plug-in by inserting the appropriate context-related markup.">Context-Sensitive Help Plug-ins with DITA</a></div>
83</div>
84</div>
85<div/>
86</body>
87</html>