Skip to main content



      Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Any restrictions on using html anchors in toc.xml?
Any restrictions on using html anchors in toc.xml? [message #471292] Thu, 13 December 2007 13:00 Go to next message
Eclipse UserFriend
We use both html files and html anchors in the Eclipse toc.xml file. For
example, the "Using a busy cursor" page has an entry in the toc that
references cursormgr_5.html, and two entries in the TOC that reference
anchors in cursormgr_5.html:

<topic label="Using a busy cursor" href="html/cursormgr_5.html"/>
<topic label="Setting a busy cursor"
href="html/cursormgr_5.html#157743" />
<topic label="Using the showBusyCursor property"
href="html/cursormgr_5.html#149626" />
</topic>

This works fine, except when you hit "Print selected topics and all
subtopics" and it prints the cursormgr_5.html page three times.

I have never found anything to say that anchors are prohibited in the toc,
and we have been using them for several versions of Eclipse. But, with the
addition of the "Print selected topics and all subtopics" feature, we are
now rethinking it.

Are there any restrictions that people are aware of when using anchors in
the toc?

Thanks,

Stephen Gilson
Re: Any restrictions on using html anchors in toc.xml? [message #471293 is a reply to message #471292] Thu, 13 December 2007 13:43 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

I did a search in Bugzilla for the word "anchor" in
Eclipse-Platform-User Assistance, with status=UCONFIRMED or NEW and this
is the resulting query:
https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advan ced&short_desc_type=allwordssubstr&short_desc=anchor &classification=Eclipse&product=Platform&compone nt=User+Assistance&long_desc_type=allwordssubstr&lon g_desc=&bug_file_loc_type=allwordssubstr&bug_file_lo c=&status_whiteboard_type=allwordssubstr&status_whit eboard=&keywords_type=allwords&keywords=&bug_sta tus=UNCONFIRMED&bug_status=NEW&emailtype1=substring& amp;email1=&emailtype2=substring&email2=&bugidty pe=include&bug_id=&votes=&chfieldfrom=&chfie ldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+ same+sort+as+last+time&field0-0-0=noop&type0-0-0=noo p&value0-0-0=

Result is "5 bugs found"

Two are marked [Intro]. The other three are marked either [Help} or
[Webapp], which would be related to your TOC question.

But none of them mention symptoms in the printing function.

They are:
210813 0 [Webapp] Synchronize with TOC broken for any duplicate
filename in different subfolders contributed to a TOC topic anchor
184787 0 [Help] Breadcrumbs broken by anchors in <topic href="...">
194688 0 [Webapp] Help keyboard navigation loses focus when selecting
a TOC item that targets an anchor on currently displayed page

#210813 comments say that it is fixed for 3.4

#184787 comments say that it is a difficult issue to solve (symptoms in
the breadcrumbs when there are anchors) and that's where the comments end.

#194688 has no comments on it, other than the initial bug opening.

Bug #184787 mentions two other bugs that mention anchors/hrefs, but they
don't involve the printing function.

The description of the href attribute of a <topic> can be found in the
Eclipse 3.3 help:
http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse. platform.doc.isv/reference/extension-points/org_eclipse_help _toc.html

But all of the examples are of hrefs that do not themselves have
additional #anchor portions. I don't easily find any documented
restrictions that say use of the #anchor type of URL is not allowed in
the href attribute of a <topic>. Which leads me to say that the symptom
you are seeing is a bug.

Best regards,
Lee Anne


Stephen Gilson wrote:
> We use both html files and html anchors in the Eclipse toc.xml file. For
> example, the "Using a busy cursor" page has an entry in the toc that
> references cursormgr_5.html, and two entries in the TOC that reference
> anchors in cursormgr_5.html:
>
> <topic label="Using a busy cursor" href="html/cursormgr_5.html"/>
> <topic label="Setting a busy cursor"
> href="html/cursormgr_5.html#157743" />
> <topic label="Using the showBusyCursor property"
> href="html/cursormgr_5.html#149626" />
> </topic>
>
> This works fine, except when you hit "Print selected topics and all
> subtopics" and it prints the cursormgr_5.html page three times.
> I have never found anything to say that anchors are prohibited in the
> toc, and we have been using them for several versions of Eclipse. But,
> with the addition of the "Print selected topics and all subtopics"
> feature, we are now rethinking it.
>
> Are there any restrictions that people are aware of when using anchors
> in the toc?
>
> Thanks,
>
> Stephen Gilson
>
Re: Any restrictions on using html anchors in toc.xml? [message #471294 is a reply to message #471293] Thu, 13 December 2007 14:07 Go to previous message
Eclipse UserFriend
Thanks Lee Anne,

I filed a bug on this: https://bugs.eclipse.org/bugs/show_bug.cgi?id=212918

Stephen
Re: Any restrictions on using html anchors in toc.xml? [message #605418 is a reply to message #471292] Thu, 13 December 2007 13:43 Go to previous message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

I did a search in Bugzilla for the word "anchor" in
Eclipse-Platform-User Assistance, with status=UCONFIRMED or NEW and this
is the resulting query:
https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advan ced&short_desc_type=allwordssubstr&short_desc=anchor &classification=Eclipse&product=Platform&compone nt=User+Assistance&long_desc_type=allwordssubstr&lon g_desc=&bug_file_loc_type=allwordssubstr&bug_file_lo c=&status_whiteboard_type=allwordssubstr&status_whit eboard=&keywords_type=allwords&keywords=&bug_sta tus=UNCONFIRMED&bug_status=NEW&emailtype1=substring& amp;email1=&emailtype2=substring&email2=&bugidty pe=include&bug_id=&votes=&chfieldfrom=&chfie ldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+ same+sort+as+last+time&field0-0-0=noop&type0-0-0=noo p&value0-0-0=

Result is "5 bugs found"

Two are marked [Intro]. The other three are marked either [Help} or
[Webapp], which would be related to your TOC question.

But none of them mention symptoms in the printing function.

They are:
210813 0 [Webapp] Synchronize with TOC broken for any duplicate
filename in different subfolders contributed to a TOC topic anchor
184787 0 [Help] Breadcrumbs broken by anchors in <topic href="...">
194688 0 [Webapp] Help keyboard navigation loses focus when selecting
a TOC item that targets an anchor on currently displayed page

#210813 comments say that it is fixed for 3.4

#184787 comments say that it is a difficult issue to solve (symptoms in
the breadcrumbs when there are anchors) and that's where the comments end.

#194688 has no comments on it, other than the initial bug opening.

Bug #184787 mentions two other bugs that mention anchors/hrefs, but they
don't involve the printing function.

The description of the href attribute of a <topic> can be found in the
Eclipse 3.3 help:
http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse. platform.doc.isv/reference/extension-points/org_eclipse_help _toc.html

But all of the examples are of hrefs that do not themselves have
additional #anchor portions. I don't easily find any documented
restrictions that say use of the #anchor type of URL is not allowed in
the href attribute of a <topic>. Which leads me to say that the symptom
you are seeing is a bug.

Best regards,
Lee Anne


Stephen Gilson wrote:
> We use both html files and html anchors in the Eclipse toc.xml file. For
> example, the "Using a busy cursor" page has an entry in the toc that
> references cursormgr_5.html, and two entries in the TOC that reference
> anchors in cursormgr_5.html:
>
> <topic label="Using a busy cursor" href="html/cursormgr_5.html"/>
> <topic label="Setting a busy cursor"
> href="html/cursormgr_5.html#157743" />
> <topic label="Using the showBusyCursor property"
> href="html/cursormgr_5.html#149626" />
> </topic>
>
> This works fine, except when you hit "Print selected topics and all
> subtopics" and it prints the cursormgr_5.html page three times.
> I have never found anything to say that anchors are prohibited in the
> toc, and we have been using them for several versions of Eclipse. But,
> with the addition of the "Print selected topics and all subtopics"
> feature, we are now rethinking it.
>
> Are there any restrictions that people are aware of when using anchors
> in the toc?
>
> Thanks,
>
> Stephen Gilson
>
Re: Any restrictions on using html anchors in toc.xml? [message #605419 is a reply to message #471293] Thu, 13 December 2007 14:07 Go to previous message
Eclipse UserFriend
Thanks Lee Anne,

I filed a bug on this: https://bugs.eclipse.org/bugs/show_bug.cgi?id=212918

Stephen
Previous Topic:Re: URL org.eclipse.ui.intro not found
Next Topic:Question about standalone help
Goto Forum:
  


Current Time: Fri May 16 14:25:16 EDT 2025

Powered by FUDForum. Page generated in 0.05804 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top