blob: 42251aa754609f85fa76143175c74f74a2c9a006 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
/*******************************************************************************
* Copyright (c) 2000, 2015 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
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help;
/**
* A help resource, usually a help topic.
* <p>
* This interface models a help resource. In general, help resources are either
* html help files, or table of contents XML files.
* </p>
*
* @since 2.0
*/
public interface IHelpResource {
/**
* This is attribute name used for href in XML files.
*/
public final static String HREF = "href"; //$NON-NLS-1$
/**
* This is attribute name used for label in XML files.
*/
public final static String LABEL = "label"; //$NON-NLS-1$
/**
* Returns the URL (as a string) associated with this help resource.
*
* @return the URL (as a string) associated with the resource
* <p>
* Valid URL of a help resource is:
* <ul>
* <li>a <em>/pluginID/path/to/resource</em>, where
* <ul>
* <li><em>pluginID</em> is the unique identifier of the plugin
* containing the help resource,
* <li><em>path/to/document</em> is the help resource path,
* relative to the plugin directory.
* </ul>
* For example. <em>/myplugin/mytoc.xml</em> or
* <em>/myplugin/references/myclass.html</em> are vaild.
* <li>string representation of URI to an external document. In
* this case, all special characters have to be enoded such that the
* URI is appropriate to be opened with a web browser.
* <em>http://eclipse.org/documents/my%20file.html</em> and
* <em>jar:file:/c:/my%20sources/src.zip!/mypackage/MyClass.html</em>
* are examples of valid URIs.
* </ul>
* </p>
*/
public String getHref();
/**
* Returns the label of this help resource.
*
* @return the label
*/
public String getLabel();
}
|
