Package: collective.geo.opensearch
Introduction============Collective.geo.Opensearch builds on collective.geo (Plone Maps) and collective.opensearch.Produce Spatial Open Search Feeds----------------------------------collective.geo.opensearch adds the possibility to add OpenSearchcompatible search results to your Plone site.* site wide: this is a simple copy of the plone search so all optionthat you may pass to the standard /search will be recognized as well.* for a collection/topic: You can search inside a topic, i.e. youdefine a 'base query' as a topic and additional parameters of the queryare applied additional.OpenSearch is a collection of simple formats for the sharing of search results.OpenSearch helps search engines and search clients communicate byintroducing a common set of formats to perform search requests andsyndicate search results. OpenSearch helps search engines and searchclients communicate by introducing a common set of formats to performsearch requests and syndicate search results. The OpenSearch descriptiondocument format can be used to describe a search engine so that it canbe used by search client applications. The OpenSearch response elementscan be used to extend existing syndication formats, such as RSS andAtom, with the extra metadata needed to return search resultscollective.geo.opensearch enables you to syndicate the search resultsof your plone site by formatting them in the RSS, Atom or KML formats,augmented with OpenSearch response elements.Implemented extensions and conventions~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~- opensearch- relevance- opensearch description for autodiscovery- suggestions so that browsers can autocomplete- response elements and first, previous, next, last links- georss (for Atom and RSS Results)Consume Open Search Feeds-------------------------collective.geo.opensearch adds a view to the link type that lets yousearch OpenSearch (or other searches that return RSS or Atom, prettymuch any other format feed parser supports and KML) compatible searchproviders within your site. The feeds do not need to implementthe opensearch extensions it suffices that they are valid feeds. Asthere is no way of knowing if the feed returns georss or KML you have tochoose 'Open Search Map View' manually for this link.You can combine several open search links as a metasearch. All OpenSearchlinks inside a folder will be queried and their results displayed whenyou change the view of a folder to 'Open Search Map View'Usage:------1) Display a map view of a georss RSS, Atom or KML search results~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Add a link content type that points to a remote (search) feed or KML.You have to choose 'Open Search Map View' manually for this link.georss feeds will be converted into a html search result and a kmlmap layer. kml sources will be passed on 'as is' (the descriptionis passed through htmllaundry) and the name and description of the placemarksdisplayed as search results.The view consits of a simple searchform, the map displaying the georssor kml information and the results of the query2) search multiple sources at once~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~To build a simple metasearch create a folder and add your query links to it.Change the view of the folder to 'Open Search Map View'.The view consist of a search form (currently only for full text search)which input will be applied to all open search links (i.e. any linkthat has 'Open Search Map View' set as its view). The results ofthe searches will be displayed as layers in the map and in tabs beneaththe form. The queries are executed asynchronously via AJAX, so you donot have to wait until the last query has finished.Abusing collective.geo.opensearch to Display miscelaneous Feeds and KMLs------------------------------------------------------------------------3) Display an abritary 'static' feed or a remote KML Files~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Allthough the main focus of this product is to produce and displaysearch feeds you may use it to display any valid feed. If the url of thelink you added does not contain the {searchTerm} parameter and 'Open Search Map View'(you have to select the view manually from the 'display' menu) isselected as the view of the link, the feed will be fetched regardless ofthe presence of a query parameter and its results will be displayed.The search form will not be displayed in the absence of the{searchTerms} parameter.4) Display multiple feeds or KMLs~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~Add your feeds to display to a folder (as in [2]) and select'Open Search Map View'as the display view of the folder All feeds that do not have a{searchTerm} parameter in their url will be fetched immediately,regardless if a search input was provided. The search form will only bedisplayed if at least one of the links inside the folder has a{searchTerm} parameter.5) Use collective.geo.opensearch to search inside your collections~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~As opensearch results are added to all collections you may use it as asearchform to search inside your collections. if you use a relativelink (e.g. /mycollection/SearchableText={searchTerms}) you have tochoose 'Open Search Map View' manually to display the search results.Known limitations issues and caveats------------------------------------- Currently only the {searchTerms} paramter for full text search is recognized and supported- add '<match path="regex:^.*/opensearchresults.html*" abort="1" />' to your deliverance/xdv/diazo rules- internal searches as described in [5] will always be executed as 'anonymous'- relative links in kml files will not be rewrittenDifferences between RSS/Atom and KML Search Results---------------------------------------------------The KML file will only return the content which is geo annotated.RSS and Atom feeds will return all content that matches the query withgeorss for the items which are geo annotated.- Code repository: https://github.com/collective/collective.geo.opensearch- Report bugs at https://github.com/collective/collective.geo.opensearch/issuesChangelog=========0.4 (2013/06/10)------------------ update for opnenlayers 2.120.3.1 (2011/06/17)------------------- added improvements about the Internationalization [macagua]- added support for Spanish localization for collective.geo.mapwidget domain [macagua]- Bugfix release0.3 (2011/05/20)----------------- remove unused registerTranslations0.2 (2011/05/19)----------------- fixes for compatibility with collective.opensearch 1.30.1 (2011/05/11)-------------------- Initial release