Issue Details (XML | Word | Printable)

Key: CONF-7621
Type: Improvement Improvement
Status: Resolved Resolved
Resolution: Fixed
Priority: Major Major
Assignee: Agnes Ro [Atlassian]
Reporter: Shannon Krebs
Votes: 2
Watchers: 4
Operations

If you were logged in you would be able to see more operations.
Confluence

Activity Plugin macro notation doco needs to be created

Created: 10/Jan/07 06:12 AM   Updated: 29/Jan/08 11:07 AM
Component/s: Documentation, Macros -- General
Affects Version/s: 2.3
Fix Version/s: 2.5.1

Time Tracking:
Not Specified

Issue Links:
Part
 

Participants: Adnan Chowdhury [Atlassian], Agnes Ro [Atlassian], Alain Moran (adaptavist.com), Edgar Vonk, Frank Stiller, Guy Fraser [Adaptavist.com], Mei Yan Chan [Atlassian], Patrick Masson and Shannon Krebs
Since last comment: 37 weeks, 1 day ago
Resolution Date: 02/May/07 11:49 PM
Labels:


 Description  « Hide
In the confluence 2.3 release notes it mentions that the activity plugin comes with {usage}, {popular} and {topusers} macros. These macros should have a help page so the appear in the notation guide (and specify any parameters that are applicable).

 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
Mei Yan Chan [Atlassian] added a comment - 11/Jan/07 03:48 AM
Hi Shannon,

Thanks for the suggestion as I believe this could be useful for other users too.

Regards,
Mei


Frank Stiller added a comment - 19/Jan/07 08:42 AM
Even by searching through the sourcecode of confluence 2.3 i couldnt find any hint. It seems it is one of the built-in macros which are not in the source-distribution.

The Tracking-Plugin from the confExt-Space seems currently broken for 2.3, it would be very good to have one statistics solution running.

So far i only guessed correctly that {usage:space=<space>} is working, but a few more parameters would be very helpfull.


Alain Moran (adaptavist.com) added a comment - 19/Apr/07 09:48 AM
I was asked by a client to do some digging and find out at least what the possible parameter names are, here are my results:

--------------8<-------------8<-------------8<-------------8<-------------8<-------------8<--------------

The following arguments are possible, however they will not all be active at the same time, I should imagine that setting different modes on the macros will activate different parts of the Abstract macro on which they are all based. (NB: args listed surrounded by underscores are 'dynamic' ones)

AbstractUsageMacro (all of the macros inherit from this)
columns - ["events", "spaces", "types"]
timespan - ["_from_,_to_"] (the default duration is "1d", so I assume you can specify durations as 1h, 1d, 1w etc)
event / events - ["view", "update", "create", "remove"]
type / types - ["page", "blogpost", "comment", "news", "space", "all"]
space / spaces - ["_spacekey_", "all"]
label / labels - [_list of labels_]
period - ["daily", "weekly", "monthly", "hourly", "minutely", "yearly", "minutely"]
max - [_integer_]

UsageMacro
cumulative - ["true", "false"]
forchart - ["true", "false"]
debug - ["true", "false"]

TopUsersMacro
display - some kind of list, defaults to ["title","count"], not sure what other values are possible)
debug - ["true", "false"]

PopularMacro
display - some kind of list, defaults to ["title","count"], not sure what other values are possible)
style - (appears to default to "table", not sure what other values are possible)
debug - ["true", "false"]

Those are the pieces of the jigsaw, good luck in putting them together :o


Agnes Ro [Atlassian] added a comment - 02/May/07 11:49 PM - edited
Fixed.

Help documentation has been included.

(usage plugin version: 0.7)


Edgar Vonk added a comment - 04/May/07 07:45 AM
Cool! However I do not see the usage plugin version 0.7 in my plugin repository browser? The latest version that I see is 0.5.

I am running Confluence 2.4.5.

Can I use version 0.7 of the plugin in Confluenc 2.4.5 or do I need to upgrade Confluence?

In the meantime: would it be possible to attach the documentation of the plugin to this issue maybe?

cheers,

Edgar


Agnes Ro [Atlassian] added a comment - 30/May/07 11:57 PM
Help Documentation: {usage:spaces=@all} {usage:spaces=dog,cat|types=page,blogpost} {usage:period=hourly|timespan=1d|events=create,view,update}

A macro to show usage statistics.

  • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
  • types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
  • events: - (optional) a comma-separated list of events to restrict content usage based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
  • columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
  • timespan: - (optional) restrict the timespan of popularilty from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for month. 1d (1 day) is used by default.
  • period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.
{popular:spaces=@all} {popular:spaces=dog,cat|types=page,blogpost} {popular:timespan=1m|events=create,view,update|max=20}

A macro to show popular content.

  • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
  • types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
  • labels: - (optional) a comma-separated list of labels to restrict content to.
  • display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
  • timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for month. 1w (1 week) is used by default.
  • events: - (optional) a comma-separated list of events to restrict content popularity based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
  • max: - (optional) the maximum number of popular content to display (10 by default).
  • style: - (optional) the style to display the popular content in (table by default). Allowed style values are 'list', 'table' and 'flat'.
{topusers:spaces=@all} {topusers:spaces=dog,cat|types=page,blogpost} {topusers:timespan=1w|period=daily|events=create,view,update|display=icon,title,count}

A macro to show active users.

  • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
  • display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
  • types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
  • events: - (optional) a comma-separated list of events to restrict top users based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
  • columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
  • timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for month. 1w (1 week) is used by default.
  • period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.

Agnes Ro [Atlassian] added a comment - 30/May/07 11:59 PM
It should be in the repository plugin once CONF-8176 is fixed.

Patrick Masson added a comment - 09/Jun/07 06:29 PM
Would the following: "{popular:spaces=mySpace|types=page,comment,attachment}," provide results for any page in 'mySpace' that was edited, commented on, or where an attachment is add?

Guy Fraser [Adaptavist.com] added a comment - 24/Jan/08 12:54 PM
I think they added it to the notation guide (Full Notation Guide link when editing a page in wiki markup) but it would certainly help if it was on the wiki

Adnan Chowdhury [Atlassian] added a comment - 28/Jan/08 10:18 PM