Edgewall Software

Ticket #2911 (new defect)

Opened 2 years ago

Last modified 8 weeks ago

There should be a way to disable the help links

Reported by: clee@… Owned by: osimons
Priority: low Milestone: 0.12
Component: general Version: 0.9.4
Severity: minor Keywords: help
Cc:

Description

I would like to see some sort of a way to disable the little informational "Note:" text at the bottom of pages like the Roadmap and the Newticket pages.

Something as simple as a small circular button with an 'x' inside it that stored a cookie or something would be fine with me.

Attachments

Change History

  Changed 2 years ago by cboos

  • owner changed from jonas to cboos
  • priority changed from normal to low
  • severity changed from normal to minor

| Something as simple as a small circular button with an 'x' inside it that stored a cookie or something would be fine with me.

I must lack coffee this morning, but I've no idea what you're talking about ... :)

A more concrete implementation for this would be a global TracIni setting

[trac]
help_notes = off

and the templates could output the Note: block conditionally:

  • trac/web/main.py

     
    6868    hdf['trac'] = { 
    6969        'version': __version__, 
    7070        'time': format_datetime(), 
    71         'time.gmt': http_date() 
     71        'time.gmt': http_date(), 
     72        'help_notes': env.config.getbool('trac', 'help_notes') 
    7273    } 
    7374    hdf['trac.href'] = { 
    7475        'wiki': env.href.wiki(), 
  • templates/roadmap.cs

     
    7777  </div><?cs 
    7878 /if ?> 
    7979 
     80<?cs if:help_notes ?> 
    8081 <div id="help"> 
    8182  <strong>Note:</strong> See <a href="<?cs 
    8283    var:trac.href.wiki ?>/TracRoadmap">TracRoadmap</a> for help on using the roadmap. 
    8384 </div> 
     85<?cs /if ?> 
    8486 
    8587</div> 
    8688<?cs include:"footer.cs"?> 

  Changed 2 years ago by cmlenz

  • summary changed from There should be a way to disable the "Note:"s to There should be a way to disable the help links
  • milestone set to 0.12

This should be part of the “Better help/documentation system” item that's planned for 0.12. I'm not in favor of adding extra conditionals cruft to every controller and template for this.

follow-up: ↓ 4   Changed 2 years ago by clee@…

So what I'm talking about is, currently, the 'Note:' text looks like this:

<strong>Note:</strong> This is an annoying note that you'll see every time you look at this page!

I would really like it if, for each 'Note', there was a small icon, maybe like the small circular 'X' icon in this image: http://www.maven.de/pics/dsl6k.png - clicking on the icon would set a cookie on your machine which would make that 'Note:' always hidden.

in reply to: ↑ 3 ; follow-up: ↓ 5   Changed 18 months ago by cboos

  • keywords help added

Replying to clee@c133.org:

So what I'm talking about is, currently, the 'Note:' text looks like this: <strong>Note:</strong> This is an annoying note that you'll see every time you look at this page!

This could probably removed from the output by a filter, the same way we filtered out the access keys in 0.11.

in reply to: ↑ 4   Changed 2 months ago by osimons

Replying to cboos:

This could probably removed from the output by a filter, the same way we filtered out the access keys in 0.11.

Like this in a site.html template:

<div py:match="div[@id='content']//div[@id='help']" py:attrs="select('@*')">
  <!-- All help notes are removed from this site... -->
</div>

With 0.11 and Genshi, I really see no need to add code to Trac to support the removal of these messages. I propose closing as wontfix.

  Changed 2 months ago by osimons

  • owner changed from cboos to osimons

I do hope that snippet doesn't remove unexpected things - please use with care :-)

  Changed 8 weeks ago by cboos

  • milestone changed from 0.13 to 0.12

Add/Change #2911 (There should be a way to disable the help links)

Author



Change Properties
<Author field>
Action
as new
as The resolution will be set. Next status will be 'closed'
to The owner will change. Next status will be 'new'
The owner will change to anonymous. Next status will be 'assigned'
 
Note: See TracTickets for help on using tickets.