Template:Search lists/doc

This is a template to search several lists (or other pages) at once, for example, on a "list of lists" page if a list has been split into several pages for size reasons. It is adapted from Search box. It currently does not have all the configuration options that Search box has, but if a reasonable case why why they could be added here is made, they could easily be included here as well.

Usage
This template should not be used without any parameters. If this is done, it will search all pages starting with "list of".

There are two main ways of specifying which articles this template should search. For simple cases, where all of the page titles to be searched are the same except for the very end,  can be used:

For more complex cases,  can be used. This can be used in conjunction with  (which may or may not be beneficial for performance). sets intitle for the search, and should usually be in quotes. It can also be a regular expression, although it has not been determined whether this is a bad idea. In most cases, a regex should not be necessary. These two examples search the same pages:

Parameters

 * prefix: A string of text that the titles of the target pages must begin with. This does not appear to be case-sensitive, and need not be surrounded by quotation marks.  It defaults to "List of", which would need to be overridden if the articles to search do not all begin with this string.
 * pattern: A string of text that must be in the titles of the target pages. For this text to be contiguous, use quotation marks.  For it to be a regex, surround it with / /.
 * break: If this is yes, there will be a line break between the search box and the button. By default, these are on the same line.
 * width: Can be used to change the width of the text field, in characters. The default is 22. Note: this is a bare number with no units.
 * label: Can be used to change the text on the search button. The default is "Search these lists".