Project

General

Profile

Bug #32799

Tooltips need a way to generate anchored links to the local User Guide

Added by Warren Block over 2 years ago. Updated over 2 years ago.

Status:
Done
Priority:
No priority
Assignee:
Timothy Moore II
Category:
GUI (new)
Severity:
Med High
Reason for Closing:
Reason for Blocked:
Needs QA:
Yes
Needs Doc:
Yes
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

In tooltips, we have static external links, but we also need to be able to link to anchors within the local User Guide.

Right now, we can use href="guide" attributes in the tooltip source, but this opens the user guide at the beginning rather than the specific section needed. We need to be able to link directly to an anchor in the user guide. My experiments with doing this in the source (href="guide/storage.html#encryption") did not work. Maybe there is another way, but we need to be able to link to specific anchors in the guide.

Including static HTML inside tooltips is also bad practice, making it difficult or impossible to style them.

Finally, the current links navigate the user away from their page in the UI. This loses their place and any information they already entered. Links should open in (preferably) a new window. A new tab also works, although those are not brought to the front by default.

tooltiplink.png (155 KB) tooltiplink.png Warren Block, 04/30/2018 07:17 AM
17079

Related issues

Has duplicate FreeNAS - Bug #32883: Linking to a section inside the embedded FreeNAS Guide?Closed2018-05-01

Associated revisions

Revision da01dda4 (diff)
Added by Dennis Mullen over 2 years ago

Add variable to guide route that can be changed dynamically from tooltips Ticket: #32799

Revision 9b5339fd (diff)
Added by Dennis Mullen over 2 years ago

Work on connecting to guide router with TooltipsService Ticket: #32799

Revision eaf38f11 (diff)
Added by Dennis Mullen over 2 years ago

Add an emitter and listener Ticket: #32799

Revision 8df12cbf (diff)
Added by Dennis Mullen over 2 years ago

Work on new service to handle tooltip calls to guide Ticket: #32799

History

#1 Updated by Dru Lavigne over 2 years ago

  • Has duplicate Bug #32883: Linking to a section inside the embedded FreeNAS Guide? added

#2 Updated by Erin Clark over 2 years ago

  • Assignee changed from Erin Clark to Dennis Mullen

#3 Updated by Dennis Mullen over 2 years ago

  • Status changed from Unscreened to Screened

#4 Updated by Timothy Moore II over 2 years ago

I've been working with Dennis and others on the UI team for this one and have a PR that may be a partial/short term solution to the problem (waiting review): https://github.com/freenas/webui/pull/739/files

#5 Updated by Dennis Mullen over 2 years ago

  • Status changed from Screened to In Progress

#6 Updated by Dru Lavigne over 2 years ago

  • Status changed from In Progress to Done
  • Target version changed from 11.2-BETA1 to Master - FreeNAS Nightlies
  • Needs Merging changed from Yes to No

#7 Updated by Dennis Mullen over 2 years ago

Tim did this one :)

#8 Updated by Dru Lavigne over 2 years ago

  • Assignee changed from Dennis Mullen to Timothy Moore II

Also available in: Atom PDF