Index Application
 | An Index of all pages, attachments, orphans and deleted pages and attachments found in the wiki. |
| Type | XAR |
| Category | |
| Developed by | XWiki Development Team |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
| Compatibility | Since 3.5M1 |
Table of contents
Description
The Index Application offers several features
- Page Index for the whole wiki. Displays items found in the wiki: pages, attachments, orphans, deleted pages, deleted attachments
- A macro to display all pages in a live table, based on some parameters
- XWiki 16.4.0+ The ability to pin pages to control the order of pages displayed in the tree
Accessing the Indexes
See View all the Pages on your wiki.
See View all the Pages on your wiki as an administrator.
Features
Table and Tree for Viewing of all Pages and View all Attachments
See Indexes.
Pinned Pages
See Pinned Pages.
XWiki 17.6.0+
Ordering of Special Characters
By default, XWiki uses "binary" ordering meaning that characters are ordered by Unicode code point. In the index trees, this ordering uses the lowercase version of the page title or page name. This means that for example accented characters won't appear next to their unaccented variants but at the end. Different database engines support different collations that allow controlling the sorting order and in particular where in the order accented characters appear. For example, MariaDB supports the collation utf8mb4_general_ci that uses Unicode rules to sort accented characters next to their unaccented variants. Depending on the database engine, there are also language-specific variants that allow fine-grained control, like if in German "Ö" should be the same as "O" regarding sorting order or if it should be treated as "Oe". Available collation names also depend on the configuration of the database. Please consult the documentation of the used database engine for details. You can configure the collation that is used for sorting index trees (also in the Document Tree Macro) by setting the index.sortCollation configuration option in xwiki.properties:
#-# [Since 17.6.0]
#-# Define the database collation used for sorting entries in index trees. This can be used to enable locale-based
#-# sorting like sorting accented characters at the same place or directly after their non-accented variants.
#-# When this is set to a non-empty value, the default lowercase transformation for sorting is removed to allow for
#-# locale-specific lowercase sort handling. Ensure you're using a case-insensitive collation if you want to keep
#-# case-insensitive sorting. Possible values depend on the used database engine and its configuration, a possible
#-# value for MariaDB is utf8mb4_general_ci. By default, no collation is configured.
# index.sortCollation=All Deleted Pages and Attachments
See additional tabs that you see as an administrator.
Permanently delete all pages
Restoring a Page
See Restore a Page.
Restoring an Entire Batch
See Restore an Entire Batch.
See Page Restore Limitations.
See Deleted Parent Pages.
Restoring page after recreation
See Page Replacement.
All Orphaned Pages
Lists all orphaned pages found in the wiki (i.e., pages that have no parent set).
Pages Macro
See the documentation page for the Pages Macro.
Spaces Macro
See the documentation page for the deprecated Spaces macro.
Space-level Index
The Space Index is completely similar to the Page Index but only lists information for the current space. For example for the Main space:
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-index-ui 17.8.0):
- org.xwiki.platform:xwiki-platform-livetable-ui 17.8.0
- org.xwiki.platform:xwiki-platform-index-tree-macro 17.8.0
- org.xwiki.platform:xwiki-platform-index-tree-ui 17.8.0
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 17.8.0
- org.xwiki.rendering:xwiki-rendering-macro-html 17.8.0
- org.xwiki.platform:xwiki-platform-rendering-macro-include 17.8.0
- org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 17.8.0
- org.xwiki.platform:xwiki-platform-livedata-macro 17.8.0
- org.xwiki.platform:xwiki-platform-livedata-livetable 17.8.0
- org.xwiki.platform:xwiki-platform-index-api 17.8.0
