Re: [xwiki-devs] [Discussion] Recent Changes macro name and parameters

Hi Vincent, On Tue, Nov 9, 2010 at 08:50, Vincent Massol &lt;vincent(a)massol.net&gt; wrote: > Hi Raluca, > > On Nov 9, 2010, at 8:39 AM, Raluca Stavro wrote: > >> On Tue, Nov 9, 2010 at 9:05 AM, Vincent Massol &lt;vincent(a)massol.net&gt; > wrote: >>> >>> On Nov 9, 2010, at 7:46 AM, Raluca Stavro wrote: >>> >>>> On Mon, Nov 8, 2010 at 6:27 PM, Ecaterina Moraru (Valica) >>>> &lt;valicac(a)gmail.com&gt; wrote: >>>>> On Mon, Nov 8, 2010 at 17:34, Raluca Stavro <

>> wrote: >>>>> >>>>>> Hello, >>>>>> >>>>>> I am working on http://jira.xwiki.org/jira/browse/XE-741 and I

>>>>>> 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

>>>>>> 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

> need >>>>> to change the styling and position for it when we finish to

> 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? >>>> It depends on the needs. Does everybody think that this parameter is >>>> needed? I tend to think that we don't need it anymore now that we

>>>> so many filters. >>>> I would be +1 to remove this parameter. >>> >>> We definitely need to *not* show minor by default and have the ability > for users to see them if they need to. This is an important feature we

> and that we need to keep. We need it back before tomorrow to have it in

> 2.6 final as otherwise we'll have a feature regression from the previous > Recent Changes feature. >>> >>> Raluca why do you say: "I tend to think that we don't need it anymore > now that we have so many filters.". Do we have a filer that can be used

> not show minor modifications? >> I was thinking about 'events' parameter. Users can use this parameter >> in order to increase the number of sub-entries to show, so this way >> major versions would be displayed at one point. What is not clear for >> me is the reason why we have to hide minor versions. Minor versions >> could contain important changes, and hiding them by default would cut >> part of the information. > > The definition of "minor" is that it doesn't appear in any reporting by > default (recent activity, RSS feeds, email notifications, etc). I'll say

> differently; the user checks the "minor" box when he *doesn't want* that

> change appears in reporting (usually because he's making small changes

> a typo fix). > > So if you question this parameter you're questioning the need for the

> modification feature itself. And I really don't think we should drop

> feature. > > So I'd really be against removing this feature (hidden by default, can

> shown if needed) from the Recent Activity report. > > Now I'm open to define where that toggle is located and how to activate

One issue I currently have with this is that when a comment gets added to

page, the modification is considered a minor change. With the current

Changes implementation, it means that the page that got the comment is

displayed on the wiki homepage. It looks quite bad during a demo. So either that needs to be fixed, or I'm in favor of showing minor edits

default.

Guillaume > With the new design, displaying more items does not agglomerate the > interface. >> So, if this is really needed and it is considered as a regression, it >> will be back by tomorrow. >> >>> >>> BTW feature-wise (and for later), I think we need a way to see older > activity with a button "show more" at the bottom. >> Yes, this is in the plan. > > cool > > Thanks > -Vincent > >> Raluca. >> >>> >>> Thanks >>> -Vincent >>> >>>>>> * '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

>>>>>> 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

>>>>>> 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_.' >>>> Right. >>>> >>>>> 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

>>>>>> each page entry. >>>>>> -> you are welcome to add naming proposals. >>>>>> >>>>> >>>>> +1 subentries >>>>> >>>>> * 'modifications' (boolean: false by default) - Whether to show

>>>>>> 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.

> has a >>>>> limited scope (page edit events) and contains usefull information. >>>> AFAIK, it was requested by Vincent. Let's see what the others think >>>> about this parameter. >>>> >>>> Raluca. >>>> >>>>> >>>>> Example: >>>>> {{activity entries='3' subentries='3' authors='XWiki.Admin' > tags='xwiki' >>>>> spaces='Main'/ } } >>>>> >>>>> Thanks, >>>>> Caty >>>>> >>>>> >>>>>> Raluca. >>>>>> >>>>>> >>>>>>> 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-721and > 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

> for >>>>>> the moment, in the 2.6 trunk, as is, but I would like to discuss

> 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 >>>>>> planned for 2.6. >>>>>>> >>>>>>> No need for "recent", "activity" is enough. It's about the

> 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,

> true): >>>>>> showDiff, showDifferences, diff, differences >>>>>>> I don't like too much diff* >>>>>>> What about "actions"? It's more than just the difference link,

> 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 >>>>>>> >>>>>>>> * tags of documents to show chages for (comma separated list):

> tags >>>>>>> +1 tags >>>>>>> >>>>>>>> * spaces of documents to show changes for (comma separated list): > space, >>>>>> spaces >>>>>>> +1 spaces >>>>>>> >>>>>>>> * authors of documents to show changes for (comma separated

>>>>>> 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