7 Components: the Function Pages - Developers

Fig. 13.2
Format result
Tab. 13.5
200
��
��
��
Thus, all pages in all webs are displayed that have “Preferences” in
their title. Special information is excluded, with the exception of
categorization into webs. If that, too, is annoying, it can also be suppressed
using noheader="on".
And yet, the integration of the search into a page can go even farther.
Using formatted searches, you can determine which information
is shown on a page. This can even be taken to the point that you
only have certain passages displayed from the pages found. This can
be done with the parameter format, in which the desired display
can be determined. If, for example, you want to display the above
list of Preferences pages in a list, just include the format parameter:
format="···*·$web: $web.$topic "
The web and the link to the topic are displayed. Note that the header
is now automatically suppressed. This function can be individually
set (see below). As you can see, the web and the topic title were replaced
by variables that are appropriately filled in by the system.
There is a whole list of such variables; we have included a few in
Tab. 13.5.
Variable Function
$web Name of the web in which the topic found is located.
$topic Name of the topic found. Using the formalism
$topic(n, ...), the first n characters of
the topic title are displayed followed by three
13 Searching in TWiki