8 Nov
2010
8 Nov
'10
5:27 p.m.
On Mon, Nov 8, 2010 at 17:34, Raluca Stavro <raluca.morosan(a)xwiki.com>wrote;wrote:
Hello,
I am working on http://jira.xwiki.org/jira/browse/XE-741 and I would
need a final list of macro and parameter names. These would be the
current namings:
Macro name:
* recentactivity
-> to be replaced with 'activity'
+1
Parameter names:
* 'showRss' (boolean: false by default) -
Whether to show activity
rss links or not.
-> to be replaced with 'rss'
+1 for false, because the output does not reflect the content of the
activity macro. We will make it default when this is fixed and we also need
to change the styling and position for it when we finish to implement the
filters.
* 'showMinor' (boolean: false by default): -
Whether to show
modifications that create minor versions or not.
-> to be replaced with 'minor'
from what I know the current implementation doesn't have this case
implemented. Raluca are you gonna implement it? or we remove the param?
* 'tag' (comma separated list): - Comma
separated list of tags to
display activity for.
-> to be replaced with 'tags'
+1
* 'space' (comma separated list): - Comma
separated list of spaces
to display the recent activity for.
-> to be replaced with 'spaces'
-> also remove 'recent' from the macro description
+1
* 'author' (comma separated list): - Comma separated list of authors
whose modifications to show.
-> to be replaced with 'authors'
+1
* 'changesNb' (number: 30 by default): -
Number of activity to show.
-> to replace the description with 'Number of pages to display the activity
of.'
-> to be replaced with 'pages' or 'entries' or some other name that
would fit better; you are welcome to add naming proposals.
-> to replace '30' with '20', now that each entry (page) contains a
number of sub-entries (activity events) and there will be a way to
'show more' entries (Facebook style)
'Number of _entries_ to display the activity _for_.'
should be entries/items because when we extend to add also applications
events, pages will be deprecated.
+1 entries
New macro parameters to be added:
* 'events' (number: 10 by default): - Number of events to show for
each page entry.
-> you are welcome to add naming proposals.
+1 subentries
* 'modifications' (boolean: false by default) - Whether to show 'see
modifications' link on 'edited the page'
events.
-> other naming proposals: 'diff', 'differences', 'actions'
you're talking about 'see changes'
Actually I don't know why we need a parameter to display this link. It has a
limited scope (page edit events) and contains usefull information.
Example:
{{activity entries='3' subentries='3' authors='XWiki.Admin'
tags='xwiki'
spaces='Main'/ } }
Thanks,
Caty
Raluca.
planned for 2.6.
On Oct 20, 2010, at 4:05 PM, Anca Luca wrote:
>Hi devs,
>
>I've been working on http://jira.xwiki.org/jira/browse/XE-721 and it's
done on my local. This is the recent changes macro based on the current
implementation (not the activity stream one), but the idea is that we'll
rewrite it to display recent activity in the future. I will commit it for
the moment, in the 2.6 trunk, as is, but I would like to discuss here the
name of the macro and its parameters:
Macro
name:
recentchanges, changes, activity, recentactivity
+1 for "activity" to be
in line with the upcoming recent activity feature
No need for "recent", "activity" is enough. It's about the
activity of the
wiki.
>Parameters:
>* rss link should be shown at the bottom of the changes table (boolean):
showRss, rss
+1 rss (default true)
>* minor changes are shown or not (boolean, default false): showMinor,
minor
+1 minor
>* shows "see modifications" link next to entries (boolean, default true):
showDiff, showDifferences, diff, differences
I don't like too much diff*
What about "actions"? It's more than just the difference link, there could
be
other actions, as in the {{spaces/}} macro for example.
>* number of changes to show (number, 0 means
"all", defaults to 30):
changesNb, changesCount, number, count, limit
+1 count
spaces
* tags of documents to show chages for (comma
separated list): tag, tags
+1 tags
>* spaces of documents to show changes for (comma separated list): space, +1 spaces
>* authors of documents to show changes for (comma separated list):
author,
authors
+1 authors
Note that the types cannot be enforced since it's a wiki macro, I put them
there just for orientation.
I'd go for activity rss minor diff count tags
spaces authors .
Thanks -Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs