SpaceIndex Macro
Last modified by Thomas Mortagne on 2026/02/26 15:33
 | Lists the documents in a space. |
| Type | XAR |
| Category | |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility | Requires XWiki >= 3.0M1. Starting with XWiki 7.2+ you should prefer using the Document Tree Macro or Documents Macro since the notion of spaces has been removed from the UI (see Content Organization). |
Table of contents
Description
Displays the documents in a space, in a list with links.
Usage
In your page, type:
{{spaceindex space="<space name here>" /}}Parameter definition
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| space | yes | any string | none | The name of the space to display the list of documents for. If missing, the current space will be used. |
| count | yes | number | 100 | The maximum number of documents to display. If all documents should be displayed, pass 0. |
| sort | yes | creationDate,modificationDate,docName | creationDate | Sorting the list by the selected field (creationDate, modificationDate or docName). |
Example
{{spaceindex space="Sandbox" /}}Will result in:
Note that the option to create a new page is only available if the user has the permission to create pages.
