You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2006/09/07 23:15:23 UTC

[Solr Wiki] Update of "XMLResponseFormat" by HossMan

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.

The following page has been changed by HossMan:
http://wiki.apache.org/solr/XMLResponseFormat

The comment on the change is:
taken from CoreQueryParameters

New page:
[[TableOfContents]]

= Overview =

The [http://incubator.apache.org/solr/docs/api/org/apache/solr/request/XMLResponseWriter.html XML Response Writer] is the most general purpose and reusable Response Writer currently provided with Solr.  It is the format used in most discussions and documentation about the response of Solr queries.

= Parameters =

The behavior of the XML Response Writer can be driven by the following query paramaters.

== version ==

The version parameter determines the XML protocol used in the response.  Clients are strongly encouraged to ''always'' specify the protocol version, so as to ensure that the format of the response they receive does not change unexpectedly if/when the Solr server is upgraded.

The default value is normally the latest supported, currently "2.1"

== stylesheet ==

The stylesheet parameter can be used to direct Solr to include a `<?xml-stylesheet type="text/xsl" href="..."?>` declaration in the XML response it returns.

The default behavior is not to return any stylesheet declaration at all.

Use of the stylesheet param is currently discuraged, as there is currently no way to specify external stylesheets, and no stylesheets are provided in the Solr distributions (it is a legacy param which will hopefully be revived and given new life at some point in the future)

== indent ==

If the indent parameter is used, and has a non-blank value, then Solr will make some attempts at indenting the XML response such that it will be easier to read by humans.

The default behavior is not to indent.