header

Purpose

Matches documents that contain arguments within heading sections.

Syntax

header([number],term1,term2…​)

Arguments

Accepts several arguments:

  1. The first optional argument number indicates required header level and accepts values from 1 to 6 (1 corresponds the highest section level and 6 to the lowest one).

    The header level may be also set using named parameter level which accepts the same values. If the header level is not specified, all headers are matched.

  2. The other arguments specify the terms to search for.

Returned Value

Documents matching the query.

Examples

header(survey) matches word survey within headings;

header(1, survey) = header(survey, level:=1) matches the word survey within headings of the first level;

header() matches all headings;

header(1) = header(level:=1) matches all headings of the first level;

header(2, survey, result) = header(survey, result, level:=2) matches the words survey or result within headings of the second level.