Ticket #349 (closed enhancement: fixed)

Opened 12 years ago

Last modified 12 years ago

Replace help displayed by panel question mark icon with Athena help

Reported by: geofft Owned by: rye
Priority: low Milestone: Fall 2009 Release
Component: -- Keywords:
Cc: Fixed in version:
Upstream bug:

Description

On at least -cluster machines, we should point people for Hermes and OLC for Athena help rather than to Ubuntu forums etc. The question-mark icon in the panel loads yelp's default front page; this should be configured to display some other Athena-specific text, and possibly link back to the original text.

Note that we don't want to affect yelp's functionality as a help browser for the rest of the system, just its home page.

Attachments

toc.xml Download (698 bytes) - added by rye 12 years ago.
Modified version of /usr/share/yelp/toc.xml
toc2html.xsl Download (9.0 KB) - added by rye 12 years ago.
Modified version of /usr/share/yelp/xslt/toc2html.xsl
debathena.xml Download (3.6 KB) - added by jdreed 12 years ago.
Sample front page

Change History

Changed 12 years ago by rye

Modified version of /usr/share/yelp/toc.xml

Changed 12 years ago by rye

Modified version of /usr/share/yelp/xslt/toc2html.xsl

comment:1 follow-up: ↓ 2 Changed 12 years ago by rye

The two attachments above are modified versions of /usr/share/yelp/toc.xml and /usr/share/yelp/xslt/toc2html.xsl, which together make yelp's default front page. The changes remove the pages in pretty much the same format, leave links to the Ubuntu pages on the left-hand sidebar and have (currently still very rudimentary and lacking) relevant Athena help text in the main portion of the page. I haven't figured out how to leave the old Ubuntu page as is and link to it from a new page, but this format with shinier and more useful text should suffice.

comment:2 in reply to: ↑ 1 Changed 12 years ago by rye

Also, it is in fact doable to remove the Ubuntu links from the left-hand bar (the relevant part is in <div class="leftbar"> in toc2html.xsl), and presumably using the same format we can put in links of our own if we want. If we do that, we would probably want to actually link to the old (Ubuntu) help page, which is something I personally don't know how to do, but someone with more XML/XSLT knowledge probably would.

Changed 12 years ago by jdreed

Sample front page

comment:3 Changed 12 years ago by jdreed

Oops, I should have opened this ticket sooner. After we were discussing this on zephyr a month ago, I started working on this. At the time, the plan was to divert the .desktop file which opened yelp, and change it to explicitly point at a URL, like  file:///usr/share/debathena-yelp-config/debathena.xml

I've attached a proof-of-concept version of that, which leaves the Ubuntu documentation in place and links to it. I think the Ubuntu docs probably shouldn't be more than one click away of the Yelp home page.

Since more of our docs are online, my idea for the Yelp page was really just to be a pointer to redirect people to the right place. I definitely don't want to duplicate a lot of content, because that just means more places to update it.

comment:4 Changed 12 years ago by jdreed

Note that to view the file, you must invoke yelp with a URL.

Doesn't work: yelp debathena.xml

Works: yelp  file:///path/to/debathena.xml

comment:5 Changed 12 years ago by broder

  • Status changed from new to proposed

Fix in proposed.

comment:6 Changed 12 years ago by broder

And I can confirm that this works on opus for the panel icon and for the help icon in the menu, so I'll plan to move this to production on Thursday.

comment:7 Changed 12 years ago by broder

  • Status changed from proposed to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.