Index Application
 | An Index of all pages, attachments, orphans and deleted pages and attachments found in the wiki. |
| Type | XAR |
| Category | |
| Developed by | |
| 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
The Page Index is available in the drawer menu (that you can active by clicking on the top right icon):
Before the creation of the drawer menu in XWiki 7.2, there were 2 Indexes available by default:
- One for the whole wiki which can be accessed by navigating directly to the Main.AllDocs page or more easily when using the Colibri Skin by selecting the "Document Index" entry of the "Wiki" menu:
- Another for the current space which can be accessed by navigating directly to the Main.SpaceIndex page (you'll need to pass in parameter the name of the space for which you wish to see information about, e.g. .../Main/SpaceIndex?space=Sandbox) or more easily when using the Colibri Skin by selecting the "Document Index" entry of the "Space" menu:
Features
Table View of all Pages
Lists all pages found in the wiki in a filterable table view and allows performing actions on them: view, edit, delete, change access rights:
Tree View of all Pages
Lists all pages found in the wiki in a tree view:
You can search for specific pages and attachments. The tree will expand to show the corresponding node (v6.4.1+).
Pinned Pages
XWiki 16.4.0+
If the default sort order (based on the translated page title) doesn't suit you, you can order the pages manually using the dedicated "Pinned Pages" administration section.
This administration section is available for any nested page but also in the wiki administration where you can pin top level pages. The list of pinned pages for a given parent page is saved in that page's preferences. The list of top level pinned pages is saved in the wiki preferences. Pinned pages are displayed first, before the rest of the child pages. This means you get a mix of manual and automatic ordering: the pinned pages are manual ordered and displayed first, followed by the rest of the child pages ordered automatically (e.g. by their title). The administration section allows you to:
- select a new page to pin from the suggested child pages
- remove a page from the list
- reorder the list of pinned pages with drag & drop
- use the left / right arrow keys to insert or delete anywhere in the list of pinned pages
The list of pinned child pages is updated automatically when a page is moved, renamed or deleted. When you move a page to a different parent page (or to the top level), it's "pinned" state is not preserved on the new location.
The page tree macro, the navigation panel, the breadcrumb trees and in general any page tree displayed in XWiki should (by default) take into account the pinned pages, unless it has custom configuration that removes the pinned child pages filter.
Note that for the top level pages, you can also use the Navigation Panel administration section to reorder (and thus pin) the pages.
XWiki 16.4.7+, 16.10.5+, 17.2.0+ It's now also possible for users with edit rights to organize the navigation panel and pin pages through the children view.
All Attachments
Lists all attachments found in the wiki using a live table. You can filter and sort the attachments by mime type, file name, location, file size, last modification date and author.
All Deleted Pages
Lists all deleted pages found in the wiki and allows restoring them from the trash or deleting them forever from the trash:
To restore a single deleted page, find the page from the list and click the "restore page" icon.
Permanently delete all pages
Starting with XWiki 10.11RC1 it is now possible to permanently delete all pages that have been already deleted, in order to clean the recycle bin.
Restoring a Page Translation
in order to be able to restore a deleted page translation, the main page (default translation) needs to be first restored or recreated. To do that you have 2 options:
- browse through the deleted pages, find and restore a default translation of the page OR
- click on the disabled restore button of the translation and you will be redirected to the location of the default page where you can re-create it.
After clicking on the button to restore a translation, if the wiki is multilingual, you will be redirected to the restored page in the language of the translation you have just restored.
Restoring an Entire Batch
the Deleted Batch ID column allows you to filter or sort pages that were deleted together. Clicking on a page's batch ID will take you to the page's restore screen that will allow you to either restore just that page or the entire batch of pages that were deleted together with it.
Keep in mind that what you are seeing is the current state of the deleted batch. Some pages might have been restored in the meantime and others may have been deleted from the recycle bin. You will only see the deleted pages from that batch that are still inside the recycle bin.
The process can be observed in the following screens:
The log is displayed only for advanced users.
If a page from the batch was recreated in the meantime (i.e. not restored, but a new page was created in the location of a deleted one) then the restore operation will report as failed, even if all the other pages may have been successfully restored. An advanced user can inspect the log to see which page from the batch failed to restore.
Note: The batch ID is also displayed and accessible when viewing a deleted page and seeing the recycle bin entries for that page. On that screen, clicking on the batch ID will take you through the above described process.
Restoring page after recreation
XWiki 14.4.2+, 14.5+
If a page was recreated, meaning that a page was created in the location of the deleted one, possibly for adding a redirect to another page (see Page Lifecycle), then the replace operation will delete the recreated page before restoring the old version.
A confirmation modal is displayed before the action is applied.
All Deleted Attachments
Lists all deleted attachments found in the wiki and allows restoring them from the trash or deleting them forever from the trash:
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.3.0):
- org.xwiki.platform:xwiki-platform-livetable-ui 17.3.0
- org.xwiki.platform:xwiki-platform-index-tree-macro 17.3.0
- org.xwiki.platform:xwiki-platform-index-tree-ui 17.3.0
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 17.3.0
- org.xwiki.rendering:xwiki-rendering-macro-html 17.3.0
- org.xwiki.platform:xwiki-platform-rendering-macro-include 17.3.0
- org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 17.3.0
- org.xwiki.platform:xwiki-platform-livedata-macro 17.3.0
- org.xwiki.platform:xwiki-platform-livedata-livetable 17.3.0
- org.xwiki.platform:xwiki-platform-index-api 17.3.0
