Access Keys:
Skip to content (Access Key - 0)

Adaptavist Documentation Move

This documentation is deprecated. Adaptavist's documentation has moved to a new location where it is maintained and updated. Please visit Adaptavist's new Documentation area.

search-box macro

Overview:

The {search-box} macro displays a search box on your page...

There are some occasions when you want to display a search box on your page and this macro offers the right balance between ease of use and flexibility.

Parameters:

Add the macro to your page as follows:

{search-box:space=s|all=true/false}
Parameter Required Default Notes
space Current Space The space to search. If omitted, the current space will be searched. If a valid space key is specified, that will be searched instead. (multiple spaces can be specified when separated by a comma)
all false If set to true, all spaces which the user has access to will be searched.


Examples:


Hints and Tips:

The search will only allow a user to search in spaces that they have sufficient privileges to view.

If you create a search-box to search a space that the user cannot view, the search will fail. Use the show-to macro or hide-from macro to remove the search box from users who cannot use it.

You can use advanced Search Query Syntax within the search box should more specific searching be required.

Frequently Asked Questions:

Q Can I display search results for a specific query on a page?
A Yes

See Also:



View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence