Current development on JAMWiki is primarily focused on maintenance rather than new features due to a lack of developer availability. If you are interested in working on JAMWiki please join the jamwiki-devel mailing list.

Tech:OpenSearch

ktip.png This page (and all pages in the Tech: namespace) is a developer discussion about a feature that is either proposed for inclusion in JAMWiki or one that has already been implemented. This page is NOT documentation of JAMWiki functionality - for a list of documentation, see Category:JAMWiki.
Status of this feature: NOT IMPLEMENTED.
Contents

Description[edit]

From Wikipedia: "OpenSearch is a collection of technologies that allow publishing of search results in a format suitable for syndication and aggregation."

In short you get a rss-feed as an result of a search request.

This enables you to integrate search results from JAMWiki into a search infrastructure.

Author(s)[edit]

Tobias

Status[edit]

Implemented and published in SVN as branch tokaefer

Three new servlets:

OpenSearchDescriptionServlet
This servlet creates the describing XML structure of the OpenSearch api.
OpenSearchResultFeedServlet
This servlet creates the RSS/Atom feed for a search request
OpenSearchSuggestionServlet
This servlet generates a JSON array, that contains any matching Wiki-Page (Topic) for a search.


The OpenSearchDescriptionServlet enables JAMWiki to be integrated in any modern Brwoser that that understands the OpenSearch api. Therefore the JSP-Page top.jsp has been edited to integrate this:

<head>
...
<link rel="search" type="application/opensearchdescription+xml" 
href="<jamwiki:link value="Special:OpenSearchDescription" />" 
title="<f:message key="common.sitename" />" />
...
</head>

Comments[edit]

Hi Tobias - thanks for starting this! I've added you to the Sourceforge project so you should be able to create your own branch in Subversion and begin work. At this point we're pretty close to the 0.6.2 release, so please don't make any commits to trunk unless they are obvious cleanups or bugfixes, but you're welcome (and encouraged!) to commit anything you'd like on your own Subversion branch. Let me know if you have any questions or issues. -- Ryan 20-Nov-2007 07:37 PST

Your are welcome. It is just some kind of a self-serving task for me. Because we (Rainer and me) are trying to integrate the JAMWiki as close as possible into the Liferay portal server. And using the the OpenSearch api with JAMWiki enables us to integrate the JAMWiki search into the portal servers search infrastructure. -- Tobias 21-Nov-2007 00:23 PST
I just came arcoss an issue: To generate the result feed I use the OpenSearch module (see) for the ROME feed tool kit (see). The module is not in the Maven repository, so I'll have put in into the project. Since I'm not very familiar with Maven I don't know any other solution. Maybe some has an advice for me about this issue. -- Tobias 21-Nov-2007 00:53 PST
I'm still getting up-to-speed on Maven, so I can't provide too much insight - User:mikegr and User:RegisDecamps did the Maven conversion and might be able to help. That said, you may want to look at how the bliki parser is being pulled in to JAMWiki via the pom.xml, which is similar to what you need; obviously the longer term solution would to be to try and get the OpenSearch module hosted in a public Maven repository, something I have no idea how to do :) -- Ryan 21-Nov-2007 22:14 PST
I came across the solution for the bliki parser by my own. But nervertheless thanks ;). -- Tobias 21-Nov-2007 22:58 PST