Parameter Misnomers

I wonder if &summarize isn’t a misnomer that should be deprecated... I just caught myself wondering why &limit wasn’t returning more results then took a quick pop over to the doc site to realize it’s &summarize. It’s not always Summarizing after all...

Should &limit become &queryLimit and should &summarize become &return or &results? Or something like that...

I was thinking of renaming it &show but I forgot about it in the heat of trying to finish 2.0. I’d be happy to make this change in 2.0.1 (still provide backwards compatibility via the new config file). Anyone else have another good idea for a name?

&number
&quantity

just a thought.

Quote from: Mark at Mar 14, 2007, 08:38 PM

I was thinking of renaming it &show but I forgot about it in the heat of trying to finish 2.0. I’d be happy to make this change in 2.0.1 (still provide backwards compatibility via the new config file). Anyone else have another good idea for a name?

I think &show and &limit are fine.

What about display?

(I made the change in SVN so that &summarize is now &show. That does not mean I’m not open to suggestions.)

I think "display" could be misunderstood in a "per page" meaning and could get in conflict with pagination. What about &get?

Because you ’get’ a certain number of docs...

How about &howManyItemsOnThisSummaryPageAtATimeRegardlessOfPaginationAndNotRelatedToTheDatabaseQueryLimit?

&howManyItemsOnThisSummaryPageAtATimeReg ardlessOfPaginationAndNotRelatedToTheDa tabaseQueryLimit?

THAT´S IT

Now that I think on it more, I think &show might get confused with paging too: "Show me five results at a time..."

But I can’t decide on the best choice for &summarize ... either &get or &return would be my two choices ("results" falls victim to the pagination connotation as well). I wonder if "get" might be confused with a form get, or if the MODx-practice of "returning" things in snippets would make for a good argument for using &return.

I do think &limit should become &queryLimit, just for clarity’s sake.

I don’t think either &get or &return would work. However, Feedburner uses the following phrase on their BuzzBoost service "Number of items to display:". Personally, think display makes more sense than show. Because you are displaying 3 items...