Index Application

Last modified by Admin on 2017/10/05 15:39

application_side_treeAn Index of all pages, attachments, orphans and deleted pages and attachments found in the wiki.
TypeXAR
Developed by

XWiki Development Team

Rating
Rate!
1 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Compatibility

Since 3.5M1

Installable with the Extension Manager

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
  • A deprecated macro to display all spaces based on some parameters
  • Page Index for a space (replaced by the siblings/children viewer in XWiki 7.2+).

Accessing the Indexes

The Page Index is available in the drawer menu (that you can active by clicking on the top right icon):

index-allpages-drawer.png

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:

    index-alldocs-menu.png

  • 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:

    index-spaceindex-menu.png

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:

index-alldocs-docs.png

Tree View of all Pages

Lists all pages found in the wiki in a tree view:

index-alldocs-tree.png

You can search for specific pages and attachments. The tree will expand to show the corresponding node (v6.4.1+).

index-alldocs-tree-finder.png

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.

attachmentIndex.png

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:

index-alldocs-deleteddocs.png

If this tab doesn't appear, you may not have sufficient administrative rights to see it.

To restore a single deleted page, find the page from the list and click the "restore page" icon.

Restoring a Page Translation

Starting with XWiki 6.2M2 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

Starting with XWiki 9.4RC1 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.

restore-failed-alreadyexists.png

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.

recyclebin-view-batchId.png

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:
index-alldocs-deletedattachments.png

If this tab doesn't appear, you may not have sufficient administrative rights to see it.
There's currently only one action on deleted attachments in this view: it's the ability to permanently delete it. If you wish to restore an attachment, you'll need to navigate to the history of the page it was attached to and rollback to a version before the attachment was deleted. In the future we'll need to implement a proper restore attachment action as we have for deleted pages.

All Orphaned Pages

Starting with XWiki 7.2 this tab is not visible unless you enable the Parent-Child Hierarchy Mode.

Lists all orphaned pages found in the wiki (i.e. pages that have no parent set).

index-alldocs-orphaned.png

Pages Macro

See the documentation page for the Pages Macro.

Spaces Macro

See the documentation page for the deprecated Spaces macro.

Space-level Index

This has been replaced by the siblings/children viewer in XWiki 7.2+

The Space Index is completely similar to the Page Index but only lists information for the current space. For example for the Main space:

index-spaceindex-docs.png

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:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. 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 9.8.1):

Tags:
Created by Vincent Massol on 2012/01/24 09:02
    

Get Connected