Specifies a searchable index of documents called a search collection.
The following table describes subelements for the SEARCHCOLLECTION element.
Table 2–25 SEARCHCOLLECTION Subelements
Element |
Required |
Description |
---|---|---|
zero or one |
Optional display name that can be used while displaying searchable collections to the end user. |
|
zero or one |
Contains a text description of the collection. |
|
zero or more |
Contains name-value pairs to pass extra configuration information to the search engine. |
The following table describes attributes for the SEARCHCOLLECTION element.
Table 2–26 SEARCHCOLLECTION Attributes
Attribute |
Default |
Description |
---|---|---|
name |
none |
Specifies unique identifier for this collection. Should be a legal XML ID type. |
path |
none |
Specifies a file system location for storing search collection meta data. |
uri |
none |
Specifies a URI for the indexable collection of documents. |
docroot |
none |
Specifies a file system path for the collection of documents. |
enabled |
true |
Specifies whether a collection can be searched. Legal values are yes, no, true, false, on, off, 1, and 0. |