OpenCms JSP standard taglib
Tag search


This tag provides support to generate search forms and result lists for a server-side handled Solr search. It takes an (XML or JSON) configuration file or a JSON configuration String and essentially exposes an object with the search results and also the necessary information to suitably build up your search form. It supports facets and highlighting.

If you do not specify a search index explicitly, the tag uses "Solr Offline" and "Solr Online", depending on the current project.

To get detailed information on the configuraiton options, just have a look at an XML content of type jsp-search-form or look up the JavaDoc of the JSON configuration parser org.opencms.jsp.search.config.parser.CmsJSONSearchConfigurationParser.


Tag Information
Tag Classorg.opencms.jsp.CmsJspTagSearch
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
vartruefalseorg.opencms.jsp.search.result.I_CmsSearchResultWrapperThe name of the variable that exposes an object of type org.opencms.jsp.search.result.I_CmsSearchResultWrapper, which gives you access to the search results and to a search form controller.
configFilefalsetruejava.lang.StringVFS-URI of the search form configuration file (either a JSON file or an XML content of type jsp-search-form.
fileFormatfalsefalsejava.lang.StringThe format of the configuration file. Valid values are "xml" (default) and "json".
configStringfalsetruejava.lang.StringInstead of a configuration file, the JSON config can be directly given as String.
addContentInfofalsetruejava.lang.Boolean

The tag allows for detection of changes on resources collected by the search tag (editing, creation, deletion). If addContentInfo is set to true, these changes are taken into account when publishing changes for the current web page.

This feature makes only sense if you use the tag to display (editable) lists of contents. By default, at most (the first) 200 list items are checked for changes. The default can be altered using the attribute contentInfoMaxItems

Default: false.

Hint:The attribute is ignored if contentInfoMaxItems is specified.

contentInfoMaxItemsfalsetruejava.lang.IntegerEnables detection of changed resources as described for addContentInfo. Additionally, sets the maximal number of investigated resources to the provided value.

Variables
NameTypeDeclareScopeDescription
From attribute 'var'org.opencms.jsp.search.result.I_CmsSearchResultWrappertrueNESTEDNo Description


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.