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 2010/09/15 02:47:15 UTC
[Solr Wiki] Update of "VelocityResponseWriter" by ErickErickson
Dear Wiki user,
You have subscribed to a wiki page or wiki category on "Solr Wiki" for change notification.
The "VelocityResponseWriter" page has been changed by ErickErickson.
The comment on this change is: Updated to reflect that VRW is now part of Solr core..
http://wiki.apache.org/solr/VelocityResponseWriter?action=diff&rev1=29&rev2=30
--------------------------------------------------
See [[https://issues.apache.org/jira/browse/SOLR-620|SOLR-620]] for more information.
+ <!> Solr 1.5 (trunk) Skip to the section labeled 'Solr 1.5 (trunk)'! <!>
+
- = Instructions to use =
+ == Instructions to use, Solr 1.4 ==
These steps will get you up and running for the examples below:
+ * Download and install Solr 1.4.x
- * Check out Solr trunk: svn co https://svn.apache.org/repos/asf/lucene/dev/trunk
- * Build Solr: ant clean example
* Fire up Solr: cd example; java -Dsolr.solr.home=../contrib/velocity/src/main/solr/ -jar start.jar
* Index sample docs: cd example/exampledocs; java -jar post.jar *.xml
* Hit the examples below...
- = Sample Usage =
+ === Sample Usage ===
http://localhost:8983/solr/itas
. Renders browse.vm from conf/velocity. Faceted navigation included.
@@ -29, +30 @@
. Renders browse.vm, adding in explanation views per hit, and a Velocity context dump at the end.
- == Using the VelocityResponseWriter in Solr Core ==
+ ==== Using the VelocityResponseWriter in Solr Core ====
- The VelocityResponseWriter is still a contrib component. In order to use it with the core distributions the following steps need to be followed:
+ The VelocityResponseWriter is still a contrib component in Solr 1.4.x. In order to use it with the core distributions the following steps need to be followed:
The following jars need to be copied from contrib/velocity/src/main/solr/lib/ to $SOLR_HOME/lib:
@@ -80, +81 @@
}}}
Copy the .../contrib/velocity/src/main/solr/conf/velocity directory to $SOLR_HOME/conf/. This directory contains the Velocity templates that will be needed by the VelocityResponseWriter, and also a style sheet, main.css. The templates and style sheet can be edited to customize the display.
+ == Instructions to use, Solr 1.5 (trunk) ==
+ These steps will get you up and running for the examples below:
+
+ * Check out Solr trunk: svn co https://svn.apache.org/repos/asf/lucene/dev/trunk
+ * Build Solr: ant clean example
+ * Fire up Solr: cd example; java -jar start.jar
+ * Index sample docs: cd example/exampledocs; java -jar post.jar *.xml
+ * Hit the examples below...
+
+ === Sample Usage ===
+ http://localhost:8983/solr/browse
+
+ . Renders browse.vm from conf/velocity. Faceted navigation included.
+
+ [[http://localhost:8983/solr/browse?v.template.header=Custom%20Header|http://localhost:8983/solr/itas?v.template.header=Custom%20Header]]
+
+ . Renders browse.vm, but overrides the header.vm from conf/velocity with the specified value.
+
+ http://localhost:8983/solr/browse?debugQuery=true
+
+ . Renders browse.vm, adding in explanation views per hit, and a Velocity context dump at the end.
+
+
+ <!> Applies to both Solr 1.4 and 1.5 (trunk) <!>
+
== Options ==
* {{{v.template}}}: template name to use, without the .vm suffix. If not specified, "default"[.vm] will be used.
* {{{v.template.<name>}}}: overrides a file system template