Ticket #5715 (closed defect: wontfix)

Opened 4 years ago

Last modified 7 months ago

No documentation on WikiMacros page

Reported by: rjollos Assigned to: rjollos
Priority: high Component: WikiStatsPlugin
Severity: normal Keywords: macro description
Cc: Trac Release: 0.11

Description

There is no documentation for this plugin on the WikiMacros page for an instance of Trac where the macro is installed. It would be nice to add a short entry describing how to use each macro. See attached screen capture.

Screen capture showing no documentation on WikiMacros page

Attachments

UserStatsMacroNoDocs.png (30.4 kB) - added by rjollos on 08/25/09 10:27:33.
Screen capture showing no documentation on WikiMacros page

Change History

08/25/09 10:27:33 changed by rjollos

  • attachment UserStatsMacroNoDocs.png added.

Screen capture showing no documentation on WikiMacros page

01/01/10 00:09:03 changed by rjollos

  • component changed from UserStatsMacro to WikiStatsPlugin.

01/25/10 04:17:12 changed by anonymous

  • owner changed from pedro to Rottenchester.

12/16/10 08:24:42 changed by rjollos

  • priority changed from normal to high.
  • owner changed from Rottenchester to rjollos.
  • status changed from new to assigned.

02/09/12 18:45:31 changed by rjollos

  • status changed from assigned to new.

(follow-up: ↓ 6 ) 03/02/12 01:27:06 changed by hasienda

  • keywords set to macro description.

For various reasons I'm aggressively rebuilding WikiStatsPlugin functionality inside AccountManagerPlugin (see #9852).

For what it's worth, please take a look at it's embedded macro descriptions. Comments welcome.

(in reply to: ↑ 5 ; follow-up: ↓ 7 ) 03/02/12 02:23:57 changed by rjollos

Replying to hasienda:

For various reasons I'm aggressively rebuilding WikiStatsPlugin functionality inside AccountManagerPlugin (see #9852).

Thanks for doing that, I think it will be a very nice addition to the AccountManagerPlugin. I'm going to follow though on the adoption for this plugin, fix the remaining open issues and mark it as soon to be deprecated, in order to direct attention to the AccountManagerPlugin.

For what it's worth, please take a look at it's embedded macro descriptions. Comments welcome.

It is looking very good. I've never liked that the WikiStatsPlugin has a macro named Stats, feeling that it is too generic of a name. Perhaps ProjectStats, or TracStats? Off hand, I'd prefer ProjectStats. This would also prevent a collision in the case that both macros are installed. Or are you aiming for backward compatibility with this plugin?

(in reply to: ↑ 6 ) 03/02/12 22:02:32 changed by hasienda

Replying to rjollos:

Replying to hasienda:

For various reasons I'm aggressively rebuilding WikiStatsPlugin functionality inside AccountManagerPlugin (see #9852).

Thanks for doing that, I think it will be a very nice addition to the AccountManagerPlugin. I'm going to follow though on the adoption for this plugin, fix the remaining open issues and mark it as soon to be deprecated, in order to direct attention to the AccountManagerPlugin.

Great you like it. But for the other part I hoped to discourage you enough at least to not take #3874. After reading the code I think it's worth to keep the idea. The implementation is a bit too straight-forward, i.e. can't make use of new caching capability in Trac 0.12, and more. I'll try my best to warrant depreciation of this fine plugin in favor of the new AcctMgr wiki macro suite.

... Comments welcome.

It is looking very good. I've never liked that the WikiStatsPlugin has a macro named Stats, feeling that it is too generic of a name. Perhaps ProjectStats, or TracStats? Off hand, I'd prefer ProjectStats. This would also prevent a collision in the case that both macros are installed. Or are you aiming for backward compatibility with this plugin?

Yes, I'd like to take the hurdle of supplying backwards-compatibility for someone with hundreds of existing macro invocations. OTOH, replacing just the name and keeping a compatible parameter set could be an acceptable compromise. I confess, that I liked the old short name for shortness, but it's truly unspecific wording and absence of CamelCase is unsatisfying. I trust you for the choice in general: Stats will become ProjectStats for AcctMgr offerings soon.

Btw, I did look at TracStatsPlugin the first time after you mentioned it here, great stuff. But external site and requirement of a GitHub account has nearly scared me away from creating an issue. Hope we'll gain more on the t-h.o side to convince people to a least to mirror their repositories here again.

07/23/12 21:44:42 changed by rjollos

Should we deprecate this plugin, close all of the open tickets and direct users to the AccountManagerPlugin? I think that comment:7 is suggesting this approach.

My thinking is:

  • If a user wants this macro but not the account manager features, they can install AccountManagerPlugin and only enable the macros.
  • One of the macros depends on AccountManagerPlugin anyway.
  • I have too much to maintain and I'm trying to dump things that have no value. Let's drive users towards the AccountManagerPlugin.

Thoughts?

07/23/12 23:18:02 changed by hasienda

I'll try to make WikiMacros inside of AccountManagerPlugin as independent as possible from the other modules and will seek graceful degradation, if possible.

More elaborated statistics certainly involve heavy data processing (see my related comments to #3874). So for me it feels better to move to AccountManager or even TracStatsPlugin for that purpose, than to maintain a somewhat half-hearty and not portable hack.

IMHO depreciation with pointing to alternative and in parts already superior solution would be a reasonable decision.

10/18/12 21:18:13 changed by rjollos

  • status changed from new to closed.
  • resolution set to wontfix.

This plugin is deprecated, and a notice has been posted to the WikiStatsPlugin page with more details. Please comment here if you have any concerns.

10/19/12 17:14:31 changed by hasienda

Fine for me.

Add/Change #5715 (No documentation on WikiMacros page)




Change Properties
Action