Reworked extensively the search page UI, and rationalized some of the query
parameters. Here are a list of the current capabilities:
Parameter
Applies
Meaning
query
Optional
An enumeration of the query type. Currently supported values are "mashup",
"comment", "activity", "toprated".
scope
Optional
A username within which to search (the author of the mashup, the author of a
comment, the originator of some activity) When absent, results from all
users are returned. Applies to all query types.
for
Optional
When blank, return all qualifying mashups. Applies to the "mashup" and
"comments" query types.
tags
Optional (default false)
true|false: whether to search for tags with the value of "for". Applies to
the "mashup" query type.
titles
Optional (default false)
true|false: whether to search titles containing the value of "for" .
Applies to the "mashup" query type.
descriptions
Optional (default false)
true|false: whether to search descriptions containing the value of "for" .
Applies to the "mashup" query type.
period
Optional (default 7)
Number of days back to include in the recent activity search. Applies to
the "activity" query type.
activity
Optional (default "all")
all | mashup | comment | tag | rating: type of activity to include.
Applies to the "activity" query type.
controls
Optional (default true)
true|false: whether to show the advanced search controls in an expanded
state. When using the search page to show the results of a query (e.g. a
query link), typically the controls=false. When the page is accessed for
purposes of creating a query, controls=true (or omitted.)
format
Optional
rss|atom: whether to format the results as an RSS or ATOM feed instead of an
HTML page.
Jonathan Marsh - <http://www.wso2.com> http://www.wso2.com -
<http://auburnmarshes.spaces.live.com> http://auburnmarshes.spaces.live.com
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On
Behalf Of Jonathan Marsh
Sent: Friday, November 30, 2007 4:19 PM
To: [email protected]
Subject: RE: [mashup-dev] Search.jsp query param docs
Perhaps also allowing "for" to appear on comments queries? This would help
you find a comment where you remember some phrase but not where the comment
appeared.
Jonathan Marsh - <http://www.wso2.com> http://www.wso2.com -
<http://auburnmarshes.spaces.live.com> http://auburnmarshes.spaces.live.com
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On
Behalf Of Jonathan Marsh
Sent: Friday, November 30, 2007 3:10 PM
To: [email protected]
Subject: [mashup-dev] Search.jsp query param docs
Thought I'd better document the existing query params as a reference as we
extend the searching capability. I also want to clean up the query params
as there are some inconsistent usages.
Parameter
Applies
Meaning
query
Optional
An enumeration of the query type. Currently supported values are
"allmashups", "mymashups", "topmashups", "mytopmashups", and "custom".
for
Required for "custom" queries. One of tags, titles, descriptions must be
true.
String to search for within tags, titles, descriptions.
tags
Optional (default false)
true|false: whether to search for tags with the value of "for"
titles
Optional (default false)
true|false: whether to search titles containing the value of "for"
descriptions
Optional (default false)
true|false: whether to search descriptions containing the value of "for"
scope
Required for "mymashups" and "mytopmashups". Optional for "custom".
Ignored otherwise.
A username with which to limit the scope of the search.
controls
Optional (default true)
true|false: whether to show the advanced search controls in an expanded
state. When using the search page to show the results of a query (e.g. a
query link), typically the controls=false. When the page is accessed for
purposes of creating a query, controls=true (or omitted.)
format
Optional
rss|atom: whether to format the results as an RSS or ATOM feed instead of an
HTML page.
I haven't documented the Activity Search parameters because what's in the UI
and what's in the code doesn't seem to match. And I'm about to propose we
unify that with the "query" param anyway.
Suggested changes:
1) Drop the "mymashups" and "mytopmashups" query types. Instead use
"allmashups" and "topmashups" with the scope parameter (this is how "custom"
works now.
2) Add "activity" to the query type enumeration. Add a new optional
parameter "period" which will take values like 30 (30 days), 180 (six
months), etc. to filter the activity queries. The existing "scope"
parameter, if specified, can limit the search to activities by a particular
user. Activity queries will show changes to mashups including creation and
deletion, and rating, tagging, and commenting activity.
3) Add "comments" to the query type enumeration. Add a new optional
parameter "mashup" which will name a mashup (path?) to filter the results.
Allow the parameters "period" and "scope" to apply to this query type.
Thoughts?
Jonathan Marsh - <http://www.wso2.com> http://www.wso2.com -
<http://auburnmarshes.spaces.live.com> http://auburnmarshes.spaces.live.com
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
