Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.help
Interface IHelpResource

All Known Subinterfaces:
IToc, ITopic

public interface IHelpResource

A help resource, usually a help topic.

This interface models a help resource. In general, help resources are either html help files, or table of contents XML files.

Since:
2.0

Field Summary
static  String HREF
          This is attribute name used for href in XML files.
static  String LABEL
          This is attribute name used for label in XML files.
 
Method Summary
  String getHref ()
          Returns the URL (as a string) associated with this help resource.
  String getLabel ()
          Returns the label of this help resource.
 

Field Detail

HREF

static final 
String HREF
This is attribute name used for href in XML files.

See Also:
Constant Field Values

LABEL

static final 
String LABEL
This is attribute name used for label in XML files.

See Also:
Constant Field Values
Method Detail

getHref

String getHref()
Returns the URL (as a string) associated with this help resource.

Returns:
the URL (as a string) associated with the resource

Valid URL of a help resource is:

  • a /pluginID/path/to/resource, where
    • pluginID is the unique identifier of the plugin containing the help resource,
    • path/to/document is the help resource path, relative to the plugin directory.
    For example. /myplugin/mytoc.xml or /myplugin/references/myclass.html are vaild.
  • 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. https://eclipse.org/documents/my%20file.html and jar:file:/c:/my%20sources/src.zip!/mypackage/MyClass.html are examples of valid URIs.


getLabel

String getLabel()
Returns the label of this help resource.

Returns:
the label

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire