Search Space

Skip to main content
assistive.skiplink.to.breadcrumbs
assistive.skiplink.to.header.menu
assistive.skiplink.to.action.menu
assistive.skiplink.to.quick.search

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Document Properties Marker

override	false

Doctype	property	hide
Name	search-space


Short Description	List of spaces to include in downstream searches. Use `@all` to refer to all spaces.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
property	Audience

hide

Tags

Identifier

Component

Name List

doctype	component
property	Component

Mandatory


Type	List of space keys

Default Value

Value Range

Implementation

Iteration

Iteration


value	filled

hide

Sort Key

hide

Section

show-title	false
title	Description

List of spaces to include in downstream searches. The search space is typically exported. This is useful for project spaces with component spaces. The Display Table Macro and Display List Macro support search spaces.

Use @all to refer to all spaces. Typically search spaces defining no constraints on the search space should not be exported (use space-local).

Note Box
The Name List Macro does not rely on search spaces. This macro checks the delegate space only.

Since version 1.10 authors may exclude spaces from being added to the search space. Use '!' to remove the space from the closure.

Example Box

Code Block

language	text
title	All Spaces, except Test Space A & B

@all, !TESTSPACEA, !TESTSPACEB

Also since version 1.10 authors may use space labels to include or exclude a set of spaces attached to this label. Use the '#' to select spaces by a space label.

Example Box

Code Block

language	text
title	Exclude Spaces labelled with 'test'

@all, !#test

Code Block

language	text
title	List Test Spaces, but not Test Space A

#test, !TESTSPACEA

Since version 1.10 the token @self refers to the own space.

...