![[Home]](/tavi.png)
TaviMacros/TitleSearch is a new macro as of version 0.24, and it provides opportunities to do searches in the page titles on the current site. This result can be shown in different styles, and can be used several places. One use is to make a index of the whole site, another is to list out all pages related to a given subject. An example of using this to list all child pages is given in (/IndexExample)?.
The basic use is to write [[TitleSearch <search-pattern>]] where search pattern can be constructed according to the following table:
| Pattern | Will return... |
| * | All pages |
| ^Tavi | All pages starting with Tavi |
| Tikki | All pages having Tikki within the page name |
| Pages$ | All pages ending with Pages |
| From version 0.26: | |
| (*)/Intro$ | All pages ending in Intro, but only the leading part will show as the link |
| ^Blog/200303*:(*) | I.e. if having pages named: ((Blog/20030301: Extending titlesearch)) this pattern would match all entries from March 2003, and display the title, 'Extending titlesearch' |
Note that all alphanumeric characters and / are allowed in the search pattern. A full UTF-8 version might be included in a future version. Further note that case matters. (As of version 0.26 the following characters are also allowed: :;-_ )
The result of the search can have different views. This is accomplished through the use of CurlyOptions, and the list of available options are:
| Option | Value | Description |
| delimiter | <string> | Uses <string> instead of ', ' between items |
| index | <number> | Changes the output to include headings (level 2) as shown on TitleSearch. The <number>, if present, indicates which character to use for changing headers. See example |
| class | <string> | Names the class used for the <ul>-list the results are presented in |
| class | prelist | A special class which displays the list as the old macros presented results |
| style | <string> | Appends <string> to a style-attribute of the resulting <ul>-list |
| list | - | Displays the search result as a list |
| oneline | - | Displays the search result as a line to be used within a paragraph |
The following examples uses ^TaviMacros/ as the search pattern. The starting line states the options used.
