Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Is there a preference key to set "Link with Contents" to "yes"?
Is there a preference key to set "Link with Contents" to "yes"? [message #474916] Thu, 18 December 2008 14:24 Go to next message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
The product customization documentation doesn't mention a preference key
to control the "Link with Contents" button. Can you identify the
preference key?

Why is this button not enabled by default? It's a nice feature.

Thanks,
Mike
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #474920 is a reply to message #474916] Thu, 18 December 2008 22:40 Go to previous messageGo to next message
Lee Anne Kowalski is currently offline Lee Anne KowalskiFriend
Messages: 54
Registered: July 2009
Member
Mike Melton wrote:
> The product customization documentation doesn't mention a preference key
> to control the "Link with Contents" button. Can you identify the
> preference key?
>
> Why is this button not enabled by default? It's a nice feature.
>
> Thanks,
> Mike
>

Hi Mike,

I'm not sure what you are trying to do, or where you are seeing the
'Link with Contents' button not enabled default. (I mean, I see it
enabled by default).

Just to make sure we are talking about the same thing, I assume the
"Link with Contents" button is that icon button that appears when I am
looking at:
- Left hand side of the help system/infocenter
- Contents (aka Table of Contents) tab is active
- Contents label appears leftmost in bold text (situated above the ToC tree)
- A set of icon buttons appear 'rightmost' on the same line as the
Contents label.
- Going left to right of those buttons, and hovering over each to see
their hover text, I see: "Print Topics", "Collapse All", "Link with
Contents", "Maximize".

Are you asking why this set of icon buttons changes depending on whether
you have the Contents, Index, or Search tab active for the left hand frame?

Note: above the right hand (topic page) frame is a set of icon buttons
also. One of those is "Show in Table of Contents", and it does the same
thing as "Link with Contents" does (as far as I know). I mean, clicking
that button has the same result of synchronizing the topic in the right
hand side with its location in the ToC.

Is there some other type of behavior that you are looking for?

Best regards,
Lee Anne
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #474963 is a reply to message #474920] Fri, 19 December 2008 13:34 Go to previous messageGo to next message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Thanks, Lee Anne.

We want to keep the Contents and view frames synchronized by default. When
you are viewing the TOC, if you click the "Link to Contents" button, the
frames synchronize automatically. (If you click links in the view pane,
the Contents frame updates to show the location of the topic in the TOC.)
This button and feature is turned off by default (in our implementations).
We'd like to know if there's a way to turn on this feature (and button) by
default.
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #474965 is a reply to message #474963] Fri, 19 December 2008 16:08 Go to previous messageGo to next message
Lee Anne Kowalski is currently offline Lee Anne KowalskiFriend
Messages: 54
Registered: July 2009
Member
Oh, now I see what you mean. :-) I use Firefox to view the Eclipse help
infocenter and toggle=on makes a subtle change to outline the icon
button with a black line. It is just subtle enough that I didn't
immediately notice it was working as a toggle switch.

What I am noticing now is that once I've clicked that button on the
Eclipse infocenter (at eclipse.org), and close my browser, and then
return to the site, that it is *still* toggled on. I mean, whatever I
had it set at when I shut down my browser, it is retained when I return
to the running infocenter.

That implies to me that the setting is being held in a cookie for me, so
that it is set when I return to the infocenter. If that is the case,
then it is allowing different infocenter visitors to set it as they
want, and have their setting retained.

Are you primarily interested in the infocenter implementation, or the
standalone help, or the "with Eclipse" help situation?

If it's primarily the infocenter implementation, then I'm wondering
about the use case description. Is it that you want the option to force
"Link to Contents" to be On for all users to the infocenter, such that
the users cannot turn it off?

--Lee Anne


Mike Melton wrote:
> Thanks, Lee Anne.
>
> We want to keep the Contents and view frames synchronized by default.
> When you are viewing the TOC, if you click the "Link to Contents"
> button, the frames synchronize automatically. (If you click links in the
> view pane, the Contents frame updates to show the location of the topic
> in the TOC.) This button and feature is turned off by default (in our
> implementations). We'd like to know if there's a way to turn on this
> feature (and button) by default.
>
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #474968 is a reply to message #474965] Fri, 19 December 2008 21:05 Go to previous messageGo to next message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Lee Anne Kowalski wrote:

> Are you primarily interested in the infocenter implementation, or the
> standalone help, or the "with Eclipse" help situation?

We are primarily interested in the infocenter implementation.

> If it's primarily the infocenter implementation, then I'm wondering
> about the use case description. Is it that you want the option to force
> "Link to Contents" to be On for all users to the infocenter, such that
> the users cannot turn it off?

No, that's not quite the case. We would like Link to Contents toggled on
by default, instead of off; however, we also want users to be able to
change it, if they want.
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #474970 is a reply to message #474968] Mon, 22 December 2008 02:50 Go to previous messageGo to next message
Lee Anne Kowalski is currently offline Lee Anne KowalskiFriend
Messages: 54
Registered: July 2009
Member
Hi Mike,

I was hoping Chris Goldthorpe would chime in on this thread. I
understand what you mean now. I think you want something that'll let you
tell the infocenter "Have Link to Contents be toggled on, unless a
visitor has set it turned off".

I'm pretty sure that such a parameter (either startup or customization)
does not exist at the present time.

I recommend that you open a request for enhancement in Eclipse's
Bugzilla, and describe the use case scenario that you want to achieve
(as you did here in this thread).

Hope this helps,
Lee Anne

Mike Melton wrote:
> Lee Anne Kowalski wrote:
>
>> Are you primarily interested in the infocenter implementation, or the
>> standalone help, or the "with Eclipse" help situation?
>
> We are primarily interested in the infocenter implementation.
>
>> If it's primarily the infocenter implementation, then I'm wondering
>> about the use case description. Is it that you want the option to
>> force "Link to Contents" to be On for all users to the infocenter,
>> such that the users cannot turn it off?
>
> No, that's not quite the case. We would like Link to Contents toggled on
> by default, instead of off; however, we also want users to be able to
> change it, if they want.
>
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #474971 is a reply to message #474970] Mon, 22 December 2008 19:20 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
I just saw a bug was opened on this, there was no preference in 3.4, I
added one for 3.5 and also changed the default to be true.
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #475113 is a reply to message #474971] Wed, 11 February 2009 09:58 Go to previous messageGo to next message
Lukas Myslivec is currently offline Lukas MyslivecFriend
Messages: 4
Registered: July 2009
Junior Member
Hi Chris,

could you please post the link to the bug related to this topic?
and could you please name the parameter name, i have tryed to find it but
didn't succeed.

thanks a lot
/lukas
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #475114 is a reply to message #475113] Wed, 11 February 2009 17:41 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
Sure, the new preference is org.eclipse.help.base/advanced.syncDefault
and the bug is Bug 259499 – [Webapp] In Infocenter, add a parameter that
toggles "Link with Contents".
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #622711 is a reply to message #474916] Thu, 18 December 2008 22:40 Go to previous message
Lee Anne Kowalski is currently offline Lee Anne KowalskiFriend
Messages: 54
Registered: July 2009
Member
Mike Melton wrote:
> The product customization documentation doesn't mention a preference key
> to control the "Link with Contents" button. Can you identify the
> preference key?
>
> Why is this button not enabled by default? It's a nice feature.
>
> Thanks,
> Mike
>

Hi Mike,

I'm not sure what you are trying to do, or where you are seeing the
'Link with Contents' button not enabled default. (I mean, I see it
enabled by default).

Just to make sure we are talking about the same thing, I assume the
"Link with Contents" button is that icon button that appears when I am
looking at:
- Left hand side of the help system/infocenter
- Contents (aka Table of Contents) tab is active
- Contents label appears leftmost in bold text (situated above the ToC tree)
- A set of icon buttons appear 'rightmost' on the same line as the
Contents label.
- Going left to right of those buttons, and hovering over each to see
their hover text, I see: "Print Topics", "Collapse All", "Link with
Contents", "Maximize".

Are you asking why this set of icon buttons changes depending on whether
you have the Contents, Index, or Search tab active for the left hand frame?

Note: above the right hand (topic page) frame is a set of icon buttons
also. One of those is "Show in Table of Contents", and it does the same
thing as "Link with Contents" does (as far as I know). I mean, clicking
that button has the same result of synchronizing the topic in the right
hand side with its location in the ToC.

Is there some other type of behavior that you are looking for?

Best regards,
Lee Anne
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #622741 is a reply to message #474920] Fri, 19 December 2008 13:34 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Thanks, Lee Anne.

We want to keep the Contents and view frames synchronized by default. When
you are viewing the TOC, if you click the "Link to Contents" button, the
frames synchronize automatically. (If you click links in the view pane,
the Contents frame updates to show the location of the topic in the TOC.)
This button and feature is turned off by default (in our implementations).
We'd like to know if there's a way to turn on this feature (and button) by
default.
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #622745 is a reply to message #474963] Fri, 19 December 2008 16:08 Go to previous message
Lee Anne Kowalski is currently offline Lee Anne KowalskiFriend
Messages: 54
Registered: July 2009
Member
Oh, now I see what you mean. :-) I use Firefox to view the Eclipse help
infocenter and toggle=on makes a subtle change to outline the icon
button with a black line. It is just subtle enough that I didn't
immediately notice it was working as a toggle switch.

What I am noticing now is that once I've clicked that button on the
Eclipse infocenter (at eclipse.org), and close my browser, and then
return to the site, that it is *still* toggled on. I mean, whatever I
had it set at when I shut down my browser, it is retained when I return
to the running infocenter.

That implies to me that the setting is being held in a cookie for me, so
that it is set when I return to the infocenter. If that is the case,
then it is allowing different infocenter visitors to set it as they
want, and have their setting retained.

Are you primarily interested in the infocenter implementation, or the
standalone help, or the "with Eclipse" help situation?

If it's primarily the infocenter implementation, then I'm wondering
about the use case description. Is it that you want the option to force
"Link to Contents" to be On for all users to the infocenter, such that
the users cannot turn it off?

--Lee Anne


Mike Melton wrote:
> Thanks, Lee Anne.
>
> We want to keep the Contents and view frames synchronized by default.
> When you are viewing the TOC, if you click the "Link to Contents"
> button, the frames synchronize automatically. (If you click links in the
> view pane, the Contents frame updates to show the location of the topic
> in the TOC.) This button and feature is turned off by default (in our
> implementations). We'd like to know if there's a way to turn on this
> feature (and button) by default.
>
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #622752 is a reply to message #474965] Fri, 19 December 2008 21:05 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Lee Anne Kowalski wrote:

> Are you primarily interested in the infocenter implementation, or the
> standalone help, or the "with Eclipse" help situation?

We are primarily interested in the infocenter implementation.

> If it's primarily the infocenter implementation, then I'm wondering
> about the use case description. Is it that you want the option to force
> "Link to Contents" to be On for all users to the infocenter, such that
> the users cannot turn it off?

No, that's not quite the case. We would like Link to Contents toggled on
by default, instead of off; however, we also want users to be able to
change it, if they want.
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #622757 is a reply to message #474968] Mon, 22 December 2008 02:50 Go to previous message
Lee Anne Kowalski is currently offline Lee Anne KowalskiFriend
Messages: 54
Registered: July 2009
Member
Hi Mike,

I was hoping Chris Goldthorpe would chime in on this thread. I
understand what you mean now. I think you want something that'll let you
tell the infocenter "Have Link to Contents be toggled on, unless a
visitor has set it turned off".

I'm pretty sure that such a parameter (either startup or customization)
does not exist at the present time.

I recommend that you open a request for enhancement in Eclipse's
Bugzilla, and describe the use case scenario that you want to achieve
(as you did here in this thread).

Hope this helps,
Lee Anne

Mike Melton wrote:
> Lee Anne Kowalski wrote:
>
>> Are you primarily interested in the infocenter implementation, or the
>> standalone help, or the "with Eclipse" help situation?
>
> We are primarily interested in the infocenter implementation.
>
>> If it's primarily the infocenter implementation, then I'm wondering
>> about the use case description. Is it that you want the option to
>> force "Link to Contents" to be On for all users to the infocenter,
>> such that the users cannot turn it off?
>
> No, that's not quite the case. We would like Link to Contents toggled on
> by default, instead of off; however, we also want users to be able to
> change it, if they want.
>
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #622758 is a reply to message #474970] Mon, 22 December 2008 19:20 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
I just saw a bug was opened on this, there was no preference in 3.4, I
added one for 3.5 and also changed the default to be true.
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #623226 is a reply to message #474971] Wed, 11 February 2009 09:58 Go to previous message
Lukas Myslivec is currently offline Lukas MyslivecFriend
Messages: 4
Registered: July 2009
Junior Member
Hi Chris,

could you please post the link to the bug related to this topic?
and could you please name the parameter name, i have tryed to find it but
didn't succeed.

thanks a lot
/lukas
Re: Is there a preference key to set "Link with Contents" to "yes"? [message #623228 is a reply to message #475113] Wed, 11 February 2009 17:41 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
Sure, the new preference is org.eclipse.help.base/advanced.syncDefault
and the bug is Bug 259499 – [Webapp] In Infocenter, add a parameter that
toggles "Link with Contents".
Previous Topic:How to configure the index tab
Next Topic:Infocenter web app: configuring logging in JBoss 4.2.1
Goto Forum:
  


Current Time: Sat Dec 20 18:38:08 GMT 2014

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

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