Opened 13 years ago

Last modified 7 years ago

#8277 closed enhancement

Integrate help pages into plugin — at Version 6

Reported by: Ryan J Ollos Owned by: EmeCas
Priority: high Component: TracHoursPlugin
Severity: normal Keywords:
Cc: Trac Release: 0.11

Description (last modified by Ryan J Ollos)

The help pages should be integrated into the plugin and installed with the plugin.

Change History (6)

comment:1 Changed 13 years ago by Ryan J Ollos

Priority: normal → high
Status: new → assigned

comment:2 Changed 12 years ago by Ryan J Ollos

Status: assigned → new

comment:3 Changed 8 years ago by Ryan J Ollos

Owner: Ryan J Ollos deleted

comment:4 in reply to:  description Changed 7 years ago by EmeCas

Owner: set to EmeCas
Status: new → assigned

Replying to Ryan J Ollos:

The help pages should be integrated into the plugin and installed with the plugin. The help pages should be linked from the repository to the TracHoursPlugin project wiki page.

Can you please provide links as example about what you meant exactly, as well as a reference to a plugin that's integrating/installing the help pages in that way.

Thanks

Last edited 7 years ago by Ryan J Ollos (previous) (diff)

comment:5 Changed 7 years ago by Ryan J Ollos

WorkLogPlugin might be a good example of adding help. See WorkLogSetupParticipant​.

Regarding help links, I haven't looked at the plugin in a while but suggest confirming that it has standard help links at the bottom of each page, like the following example from the ticket page: 

      <div id="help" i18n:msg="">
        <strong>Note:</strong> See
        <a href="${href.wiki('TracTickets')}">TracTickets</a> for help on using
        tickets.
      </div>
Last edited 7 years ago by Ryan J Ollos (previous) (diff)

comment:6 Changed 7 years ago by Ryan J Ollos

Description: modified (diff)
Note: See TracTickets for help on using tickets.