Modify

Opened 15 years ago

Closed 12 years ago

Last modified 11 years ago

#5715 closed defect (wontfix)

No documentation on WikiMacros page

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: high Component: WikiStatsPlugin
Severity: normal Keywords: macro description
Cc: Trac Release: 0.11

Description (last modified by Ryan J Ollos)

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 (1)

UserStatsMacroNoDocs.png (30.4 KB) - added by Ryan J Ollos 15 years ago.
Screen capture showing no documentation on WikiMacros page

Download all attachments as: .zip

Change History (13)

Changed 15 years ago by Ryan J Ollos

Attachment: UserStatsMacroNoDocs.png added

Screen capture showing no documentation on WikiMacros page

comment:1 Changed 15 years ago by Ryan J Ollos

Component: UserStatsMacroWikiStatsPlugin

comment:2 Changed 15 years ago by anonymous

Owner: changed from Pedro Paixao to RottenChester

comment:3 Changed 14 years ago by Ryan J Ollos

Owner: changed from RottenChester to Ryan J Ollos
Priority: normalhigh
Status: newassigned

comment:4 Changed 13 years ago by Ryan J Ollos

Status: assignednew

comment:5 Changed 13 years ago by Steffen Hoffmann

Keywords: macro description added

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.

comment:6 in reply to:  5 ; Changed 13 years ago by Ryan J Ollos

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?

comment:7 in reply to:  6 Changed 13 years ago by Steffen Hoffmann

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.

comment:8 Changed 12 years ago by Ryan J Ollos

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?

comment:9 Changed 12 years ago by Steffen Hoffmann

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.

comment:10 Changed 12 years ago by Ryan J Ollos

Resolution: wontfix
Status: newclosed

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.

comment:11 Changed 12 years ago by Steffen Hoffmann

Fine for me.

comment:12 Changed 11 years ago by Ryan J Ollos

Description: modified (diff)

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.