search (Domino DTD)

Represents a search query used to select a document set.

Containment Hierarchy

Contains: %searches;

Syntax

<!ELEMENT search ( (%searches;)* )>

Content

(%searches;)*

Optionally may contain any number of the contents of the %searches; entity.

Attributes

<!ATTLIST search


type	(%search.types;)	#REQUIRED
folder	%tstring;	#IMPLIED
field	%string;	#IMPLIED
contains	%boolean;	#IMPLIED
value	%string;	#IMPLIED
all	%boolean;	#IMPLIED

all

If true, searches for notes that contain all of the specified words, which limits the notes returned. If false, which is the default, searches for notes that contain any of the specified words. This attribute is only evaluated if the type attribute value equals multiplewords.

contains

If true, which is the default, searches for notes that contain the specified data. If false, searches for notes that do not contain the specified data. This attribute is only evaluated if the type attribute equals byauthor, byfield, or infolder.

field

Field name. Specifies the field to search when the type attribute equals byfield.

folder

Translatable name of the folder to search when the type attribute equals infolder.

type

Type of search. See the %search.types; entity for a list of options.

value

Text value to search for when the type attribute equals byfield. Always specify a text string for the value; Lotus Notes handles any necessary data conversions when searching document fields.

Defined entities for <search> element

The %searches; entity lists the elements that specify particular types of searches.

Syntax:

<!ENTITY % searches "datechoice | formchoice | formfieldschoice | name | word ">

The %search.types; entity defines the types of searches that can be performed.

Syntax:

<!ENTITY % search.types "byauthor | bydate | byfield | byformnames | byform | infolder | multiplewords ">

byauthor

Searches for the authors of documents. Set the contains attribute to true and provide one or more <name> elements to search against.

bydate

Searches for dates of documents. Provide a <datechoice> element to search against.

byfield

Searches for specific fields. Provide a field name to search for in the field attribute, or a value to search for in the value attribute. You can also set the contains attribute to true or false in addition to supplying the value or field name.

byform

Searches for specific forms. Provide a <formfieldschoice> element to search against.

byformnames

Searches for one or more forms. Provide one or more <formchoice> elements to search against.

infolder

Searches for documents in a specific folder. Set the contains attribute to true and provide a folder name in the folder attribute.

multiplewords

Searches for specific words. Provide one or more <words> elements to search against. You can also use the all attribute to limit or widen the search.