This documentation relates to the latest version of Confluence.
If you are using an earlier version, please go to the documentation home page and select the relevant version.

(outdated) Search Macro

Added by David Loeng, last edited by Rosie Jameson on Jun 17, 2007  (view change)
All Versions
Click for all versions
Confluence 2.9 Documentation

Index

This page is outdated. Please see new page.


 Search Confluence, and include the results in the page. The search macro behaves identically to Confluence's built-in site search.

Usage:
{search:my_query}
OR
{search:my_query|maxLimit=maxLimit}

Parameter Required Default Description
query yes none search query (what you enter in the search box)
maxLimit no none sets the maximum number of search results to return
type no all except mail sets the kind of content to search
spaceKey no none Limit the search to the contents of a particular space

Available types:

type parameter Will search:
all all content, including mail
page only pages
blogpost only news
mail only mail
attachment only attachments
comment only comments
userinfo only user profiles
spacedesc only space descriptions

Supplying no type will result in the search returning results from all content except mail.

Example:
{search:confluence|maxLimit=5}

gives:

Found 5 search result(s) for confluence.

confluence
null
Dec 31, 1969
Confluence rocks
Jan 11, 2008
Confluence Admin
Dec 31, 1969
BL Confluence
Dec 31, 1969
Confluence Trial
null
Dec 31, 1969
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (6)

 

  1. Feb 17, 2005

    Anonymous says:

    It would be nice to be able to control the output of the search macro. I would l...

    It would be nice to be able to control the output of the search macro. I would like it to output in a lot less verbose format, just a list of links would be enough for some cases.

    Would it be possible to modify the search macro to do this?

  2. Mar 03, 2005

    Anonymous says:

    I'd also like to be able to search by author. For example, I wanted to include ...

    I'd also like to be able to search by author. For example, I wanted to include on someone's profile page a list of the x most recent blog posts they'd made. I tried doing a search on their name (in both proper case and lowercase) as the key, restricted to blog posts, but that returned nothing.

  3. May 17, 2005

    Anonymous says:

    I'd also like to be able to sort by parameter, like most recently updated.

    I'd also like to be able to sort by parameter, like most recently updated.

  4. Jun 26, 2005

    Anonymous says:

    It would be most usefull for search results to show the relevant fragment of tex...

    It would be most usefull for search results to show the relevant fragment of text

  5. Sep 09, 2005

    Anonymous says:

    It would be useful to link to a description of the query syntax here. It would a...

    It would be useful to link to a description of the query syntax here. It would also be worth explaining what search looks at: just page titles, or contents too? The example above suggests that it only searches page titles, which is of limited use.

    1. Sep 10, 2005

      Charles Miller says:

      The query syntax (and results) are the same as you would get from the regular Co...

      The query syntax (and results) are the same as you would get from the regular Confluence site search. We'll be improving the documentation of the site search in due course, and linking to it from the search macro documentation.

      The search covers contents and titles (and various sundry metadata), but if the search term is contained in the title of a page, it will be 'boosted' higher in the search results.

Add Comment