Home » Eclipse Projects » Eclipse Platform » Displaying HTML content with HREFs to documentation plug-in???
| | | | |
Re: Displaying HTML content with HREFs to documentation plug-in??? [message #504054 is a reply to message #504047] |
Wed, 16 December 2009 18:02 |
Alex Le Messages: 649 Registered: July 2009 |
Senior Member |
|
|
AL wrote:
> Daniel Megert wrote:
>> AL wrote:
>>> AL wrote:
>>>> Hi,
>>>>
>>>> I have an IEditorPart from pluginA, which is a browser editor
>>>> displying HTML content like
>>>> org.eclipse.ui.internal.browser.WebBrowserEditor.
>>>>
>>>> My HTML content is below, basically referencing the content of HTML
>>>> files and icons in the documentation plug-in. The below HTML
>>>> content basically puts up a HELP icon. When clicked upon [the icon]
>>>> the toc.html will be displayed.
>>>>
>>>> The problem is that I see the icon and it works when clicked upon
>>>> only when I run my plug-in while developing within my workspace.
>>>> Once I deployed my pluginA and the documentation plugin and startup
>>>> a workspace to use the deployed plugins, the icon is not displayed
>>>> and clicking on the area does not get the toc.html of the
>>>> documentation plugin displayed. I know the problem has to do with
>>>> how the documentation plugin's files are referenced. Please
>>>> advise! Thanks!
>
>> Try to use "PLUGINS_ROOT" instead of "file:plugins". Also, use "/"
>> instead of "\".
>>
>
> That also does not work. :-(
>
> I have href="PLUGINS_ROOT/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html "
>
> neither
>
> href="file:plugins/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html
>
> Same for the HREF entry to the help.gif image file.
>
Read the eclipse documentation, it says the below, as per Dani's
suggestion to try "PLUGINS_ROOT", but still not working for me, as
mentioned above.
Cross plug-in referencing
The href argument can also refer to content from another plug-in. This
is done by using a special cross plug-in referencing notation that is
resolved by the help server:
<topic label="Ref1"
href="PLUGINS_ROOT/another_plugin_id/ref/ref1.html"/>
Here PLUGINS_ROOT will be resolved at runtime and replaced with the root
directory for the plugins. You can specify your own plug-in id for
another_plugin_id. For example, you could link to this chapter of the
programmer's guide using the following topic:
<topic label="Help Chapter in Platform Doc"
href="PLUGINS_ROOT/org.eclipse.platform.doc.isv/guide/help.html "/>
Prior to 3.2, references to documents in other plug-ins were made by
using '..' to go up to the plug-in level, then referencing the plug-in
Id followed by the HREF to the topic inside the plug-in. The recommended
way to do this now is to use PLUGINS_ROOT instead of '..'. Using this
variable avoids avoids these up/down trips in references, and can be
used for all the resource URLs in the help documents (images, links, CSS
files, java script files etc.)
Note: When referencing content from another plug-in, be sure to use the
plug-in's id, as declared in its plugin.xml file, not its directory
name. While these are often the same in practice, it's important to
check that you are using the id and not the directory name.
|
|
|
Re: Displaying HTML content with HREFs to documentation plug-in??? [message #504057 is a reply to message #504047] |
Wed, 16 December 2009 23:06 |
Alex Le Messages: 649 Registered: July 2009 |
Senior Member |
|
|
AL wrote:
> Daniel Megert wrote:
>> AL wrote:
>>> AL wrote:
>>>> Hi,
>>>>
>>>> I have an IEditorPart from pluginA, which is a browser editor
>>>> displying HTML content like
>>>> org.eclipse.ui.internal.browser.WebBrowserEditor.
>>>>
>>>> My HTML content is below, basically referencing the content of HTML
>>>> files and icons in the documentation plug-in. The below HTML
>>>> content basically puts up a HELP icon. When clicked upon [the icon]
>>>> the toc.html will be displayed.
>>>>
>>>> The problem is that I see the icon and it works when clicked upon
>>>> only when I run my plug-in while developing within my workspace.
>>>> Once I deployed my pluginA and the documentation plugin and startup
>>>> a workspace to use the deployed plugins, the icon is not displayed
>>>> and clicking on the area does not get the toc.html of the
>>>> documentation plugin displayed. I know the problem has to do with
>>>> how the documentation plugin's files are referenced. Please
>>>> advise! Thanks!
>
>> Try to use "PLUGINS_ROOT" instead of "file:plugins". Also, use "/"
>> instead of "\".
>>
>
> That also does not work. :-(
>
> I have href="PLUGINS_ROOT/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html "
>
> neither
>
> href="file:plugins/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html
>
> Same for the HREF entry to the help.gif image file.
>
Reading the Eclipse documentation, I found that it does say to use
"PLUGINS_ROOT". However, that only applies to a Help plug-in trying to
reference HTML from another documentation plug-in or plug-in. My use
case is a bit different in that it's the SWT browser widget [NOT a
plug-in] within an IEditorPart trying to references HTML from another
plug-in. Another tips?
Cross plug-in referencing
The href argument can also refer to content from another plug-in. This
is done by using a special cross plug-in referencing notation that is
resolved by the help server:
<topic label="Ref1"
href="PLUGINS_ROOT/another_plugin_id/ref/ref1.html"/>
Here PLUGINS_ROOT will be resolved at runtime and replaced with the root
directory for the plugins. You can specify your own plug-in id for
another_plugin_id. For example, you could link to this chapter of the
programmer's guide using the following topic:
<topic label="Help Chapter in Platform Doc"
href="PLUGINS_ROOT/org.eclipse.platform.doc.isv/guide/help.html "/>
Prior to 3.2, references to documents in other plug-ins were made by
using '..' to go up to the plug-in level, then referencing the plug-in
Id followed by the HREF to the topic inside the plug-in. The recommended
way to do this now is to use PLUGINS_ROOT instead of '..'. Using this
variable avoids avoids these up/down trips in references, and can be
used for all the resource URLs in the help documents (images, links, CSS
files, java script files etc.)
Note: When referencing content from another plug-in, be sure to use the
plug-in's id, as declared in its plugin.xml file, not its directory
name. While these are often the same in practice, it's important to
check that you are using the id and not the directory name.
|
|
|
Re: Displaying HTML content with HREFs to documentation plug-in??? [message #504424 is a reply to message #504057] |
Fri, 18 December 2009 20:31 |
Grant Gayed Messages: 2150 Registered: July 2009 |
Senior Member |
|
|
Hi,
In this context the file locations either have to be absolute, or can only
be relative if the document specifies a base attribute (base example:
http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.swt.sni ppets/src/org/eclipse/swt/snippets/Snippet137.java?view=co )
.. The location cannot point into a jar, so I think you need to use some
eclipse core calls to determine where on your filesystem the files that you
want to show have been auto-extracted to. For example, the lines below can
be used to show the about.html file from eclipse's shipped
org.eclipse.ant.core plugin.
Bundle bundle = Platform.getBundle("org.eclipse.ant.core");
URL url = bundle.getResource("about.html");
try {
URL fileURL = FileLocator.toFileURL(url);
System.out.println(fileURL.toExternalForm());
browser.setUrl(fileURL.toExternalForm());
} catch (IOException e1) {
e1.printStackTrace();
}
HTH,
Grant
"AL" <unbonnevie@yahoo.com> wrote in message
news:hgbp6i$mnc$3@build.eclipse.org...
> AL wrote:
> > Daniel Megert wrote:
> >> AL wrote:
> >>> AL wrote:
> >>>> Hi,
> >>>>
> >>>> I have an IEditorPart from pluginA, which is a browser editor
> >>>> displying HTML content like
> >>>> org.eclipse.ui.internal.browser.WebBrowserEditor.
> >>>>
> >>>> My HTML content is below, basically referencing the content of HTML
> >>>> files and icons in the documentation plug-in. The below HTML
> >>>> content basically puts up a HELP icon. When clicked upon [the icon]
> >>>> the toc.html will be displayed.
> >>>>
> >>>> The problem is that I see the icon and it works when clicked upon
> >>>> only when I run my plug-in while developing within my workspace.
> >>>> Once I deployed my pluginA and the documentation plugin and startup
> >>>> a workspace to use the deployed plugins, the icon is not displayed
> >>>> and clicking on the area does not get the toc.html of the
> >>>> documentation plugin displayed. I know the problem has to do with
> >>>> how the documentation plugin's files are referenced. Please
> >>>> advise! Thanks!
> >
> >> Try to use "PLUGINS_ROOT" instead of "file:plugins". Also, use "/"
> >> instead of "\".
> >>
> >
> > That also does not work. :-(
> >
> > I have
href="PLUGINS_ROOT/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html "
> >
> > neither
> >
> > href="file:plugins/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html
> >
> > Same for the HREF entry to the help.gif image file.
> >
>
> Reading the Eclipse documentation, I found that it does say to use
> "PLUGINS_ROOT". However, that only applies to a Help plug-in trying to
> reference HTML from another documentation plug-in or plug-in. My use
> case is a bit different in that it's the SWT browser widget [NOT a
> plug-in] within an IEditorPart trying to references HTML from another
> plug-in. Another tips?
>
>
> Cross plug-in referencing
>
> The href argument can also refer to content from another plug-in. This
> is done by using a special cross plug-in referencing notation that is
> resolved by the help server:
>
> <topic label="Ref1"
> href="PLUGINS_ROOT/another_plugin_id/ref/ref1.html"/>
> Here PLUGINS_ROOT will be resolved at runtime and replaced with the root
> directory for the plugins. You can specify your own plug-in id for
> another_plugin_id. For example, you could link to this chapter of the
> programmer's guide using the following topic:
>
> <topic label="Help Chapter in Platform Doc"
> href="PLUGINS_ROOT/org.eclipse.platform.doc.isv/guide/help.html "/>
> Prior to 3.2, references to documents in other plug-ins were made by
> using '..' to go up to the plug-in level, then referencing the plug-in
> Id followed by the HREF to the topic inside the plug-in. The recommended
> way to do this now is to use PLUGINS_ROOT instead of '..'. Using this
> variable avoids avoids these up/down trips in references, and can be
> used for all the resource URLs in the help documents (images, links, CSS
> files, java script files etc.)
>
> Note: When referencing content from another plug-in, be sure to use the
> plug-in's id, as declared in its plugin.xml file, not its directory
> name. While these are often the same in practice, it's important to
> check that you are using the id and not the directory name.
>
|
|
|
Re: Displaying HTML content with HREFs to documentation plug-in??? [message #504616 is a reply to message #504424] |
Mon, 21 December 2009 19:14 |
Alex Le Messages: 649 Registered: July 2009 |
Senior Member |
|
|
Grant Gayed wrote:
> Hi,
>
> In this context the file locations either have to be absolute, or can only
> be relative if the document specifies a base attribute (base example:
> http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.swt.sni ppets/src/org/eclipse/swt/snippets/Snippet137.java?view=co )
> . The location cannot point into a jar, so I think you need to use some
> eclipse core calls to determine where on your filesystem the files that you
> want to show have been auto-extracted to. For example, the lines below can
> be used to show the about.html file from eclipse's shipped
> org.eclipse.ant.core plugin.
>
> Bundle bundle = Platform.getBundle("org.eclipse.ant.core");
> URL url = bundle.getResource("about.html");
> try {
> URL fileURL = FileLocator.toFileURL(url);
> System.out.println(fileURL.toExternalForm());
> browser.setUrl(fileURL.toExternalForm());
> } catch (IOException e1) {
> e1.printStackTrace();
> }
>
> HTH,
> Grant
>
Hi Grant,
Same problem happens...The above works only when the plugins are not
deployed, but when deployed, the FileLocator.toFileURL.toExternalForm()
would return the path
"file:plugins/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html " rather the
absolute path the toc.html file, in the case of running in the Eclipse
workspace.
|
|
|
Re: Displaying HTML content with HREFs to documentation plug-in??? [message #504666 is a reply to message #504424] |
Tue, 22 December 2009 00:08 |
Alex Le Messages: 649 Registered: July 2009 |
Senior Member |
|
|
Grant Gayed wrote:
> Hi,
>
> In this context the file locations either have to be absolute, or can only
> be relative if the document specifies a base attribute (base example:
> http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.swt.sni ppets/src/org/eclipse/swt/snippets/Snippet137.java?view=co )
> . The location cannot point into a jar, so I think you need to use some
> eclipse core calls to determine where on your filesystem the files that you
> want to show have been auto-extracted to. For example, the lines below can
> be used to show the about.html file from eclipse's shipped
> org.eclipse.ant.core plugin.
>
> Bundle bundle = Platform.getBundle("org.eclipse.ant.core");
> URL url = bundle.getResource("about.html");
> try {
> URL fileURL = FileLocator.toFileURL(url);
> System.out.println(fileURL.toExternalForm());
> browser.setUrl(fileURL.toExternalForm());
> } catch (IOException e1) {
> e1.printStackTrace();
> }
>
> HTH,
> Grant
Ok, that did the trick! (I thought it didn't work at first, but it
does!) Thanks!
>
>
> "AL" <unbonnevie@yahoo.com> wrote in message
> news:hgbp6i$mnc$3@build.eclipse.org...
>> AL wrote:
>>> Daniel Megert wrote:
>>>> AL wrote:
>>>>> AL wrote:
>>>>>> Hi,
>>>>>>
>>>>>> I have an IEditorPart from pluginA, which is a browser editor
>>>>>> displying HTML content like
>>>>>> org.eclipse.ui.internal.browser.WebBrowserEditor.
>>>>>>
>>>>>> My HTML content is below, basically referencing the content of HTML
>>>>>> files and icons in the documentation plug-in. The below HTML
>>>>>> content basically puts up a HELP icon. When clicked upon [the icon]
>>>>>> the toc.html will be displayed.
>>>>>>
>>>>>> The problem is that I see the icon and it works when clicked upon
>>>>>> only when I run my plug-in while developing within my workspace.
>>>>>> Once I deployed my pluginA and the documentation plugin and startup
>>>>>> a workspace to use the deployed plugins, the icon is not displayed
>>>>>> and clicking on the area does not get the toc.html of the
>>>>>> documentation plugin displayed. I know the problem has to do with
>>>>>> how the documentation plugin's files are referenced. Please
>>>>>> advise! Thanks!
>>>> Try to use "PLUGINS_ROOT" instead of "file:plugins". Also, use "/"
>>>> instead of "\".
>>>>
>>> That also does not work. :-(
>>>
>>> I have
> href="PLUGINS_ROOT/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html "
>>> neither
>>>
>>> href="file:plugins/com.abc.eclipse.doc_plugin_1.0.0/html/toc.html
>>>
>>> Same for the HREF entry to the help.gif image file.
>>>
>> Reading the Eclipse documentation, I found that it does say to use
>> "PLUGINS_ROOT". However, that only applies to a Help plug-in trying to
>> reference HTML from another documentation plug-in or plug-in. My use
>> case is a bit different in that it's the SWT browser widget [NOT a
>> plug-in] within an IEditorPart trying to references HTML from another
>> plug-in. Another tips?
>>
>>
>> Cross plug-in referencing
>>
>> The href argument can also refer to content from another plug-in. This
>> is done by using a special cross plug-in referencing notation that is
>> resolved by the help server:
>>
>> <topic label="Ref1"
>> href="PLUGINS_ROOT/another_plugin_id/ref/ref1.html"/>
>> Here PLUGINS_ROOT will be resolved at runtime and replaced with the root
>> directory for the plugins. You can specify your own plug-in id for
>> another_plugin_id. For example, you could link to this chapter of the
>> programmer's guide using the following topic:
>>
>> <topic label="Help Chapter in Platform Doc"
>> href="PLUGINS_ROOT/org.eclipse.platform.doc.isv/guide/help.html "/>
>> Prior to 3.2, references to documents in other plug-ins were made by
>> using '..' to go up to the plug-in level, then referencing the plug-in
>> Id followed by the HREF to the topic inside the plug-in. The recommended
>> way to do this now is to use PLUGINS_ROOT instead of '..'. Using this
>> variable avoids avoids these up/down trips in references, and can be
>> used for all the resource URLs in the help documents (images, links, CSS
>> files, java script files etc.)
>>
>> Note: When referencing content from another plug-in, be sure to use the
>> plug-in's id, as declared in its plugin.xml file, not its directory
>> name. While these are often the same in practice, it's important to
>> check that you are using the id and not the directory name.
>>
>
>
|
|
|
Goto Forum:
Current Time: Fri Apr 26 19:41:38 GMT 2024
Powered by FUDForum. Page generated in 0.04312 seconds
|