Application to manage a hierarchy of folders and files. It embeds viewers for many known file types, such as office and PDF.

Description

This application lets your organize your files inside XWiki using a tree hierarchy of folders. It supports all standard operations like move, rename, copy, delete on both files and folders. You can use drag & drop to upload new files and to modify the folder hierarchy. A wide range of files types can be viewed or played (in case of audio and video files) directly from the wiki. This includes PDF and office documents.

Home Page

On the application home page there is a splitter with the tree of folders on the left and the file live table on the right. To get started you should create a folder. Right click on the root node and select 'New Folder'. Type the folder name then press Enter. Next you can upload a file in the folder you have just created. Select the folder in the tree and on the right, above the empty table, click on 'New File'. Browse the file system to select the desired file or drag and drop it on the dedicated area. Click 'Back' after the file is uploaded and you should see the file in the live table.

Folder Tree

The folder tree lists the root folders and some special nodes:

• Orphan Folders: the folders that don't have the home page (we call it the drive) as their parent. Normally you shouldn't have orphan folders, but in case you do you can easily fix this by dragging them either into the root of the tree or in any of the non-orphan folders.
• All Files: this is a meta node that gives you quick access to the list of all files found on the drive (the application space).
• Orphan Files: the list of files that don't have a parent folder. Normally you shouldn't have orphan files, but in case you do you can easily fix this by moving them to an existing folder.
• Active Jobs: the list of 'file system' jobs that are currently running. You have to know that whenever you perform a modification like deleting a folder or moving some files a job is triggered that runs in the background to perform that operation. Most of the operations are performed instantly so you don't get to see the active jobs, but sometimes if you do large batch operations this view can be used to check the progress. Also, some jobs may require you to answer some questions. For instance, when you move a folder you may need to specify whether to overwrite or not an existing file. This question will be asked on the Active Jobs view.

You can organize the folders by drag and drop or you can use the context menu to create new folders or to rename them. When you select a folder the file live table gets updated to list only the files from that folder.

File Live Table

The file live table lists the files associated with the currently selected node in the tree (e.g. the files from the selected folder). If you whish to copy or move some files you have to select them, click on the Cut or Copy button from above the live table, then select the target folder from the tree and click on the Paste button from above the live table.

File Upload

To upload a new file in the current folder you have to click on the New File button from above the live table.

Below the drop zone you can see the previous uploads. This includes finished uploads, uploads in progress and even canceled uploads. You can clear the list of uploads. After you upload your files you can go back to the list view which should include the new files.

Folder View

The tree context menu has an entry to open the folder. This will take you to the folder view, which lists the subfolders and the files. You can navigate up and down the tree hierarchy by clicking on the subfolders or on the parent entry ('..'), or by using the breadcrumb.

File View

Clicking on a file link from the file live table will take you to the file view. Here you can view or play the file. Most of the standard file types are supported:

• in case of text files the Code Macro is used to display the file content using highlighting specific for each file type.
• in case of image file the image is displayed inline.
• in case of audio and video files the file is played using the JW Player, when present, or if the browser supports HTML5 audio/video playback then the native players are used.
• in case of PDF files the PDF Viewer is used, when present.
• in case of office files the Office Viewer is used, but you need to connect your wiki to an office server first.

Recent Files Macro

Starting with version 2.0RC2 there is a macro available to list the files that have been recently uploaded. You can add this macro as a gadget in a dashboard.

The following macro parameters are available:

Migration from Older Versions

Starting with version 2.0-milestone-1 the File Manager has a new way to organize the files and folders, which is not compatible with older versions. Fortunately, after you upgrade the File Manager you'll get on the File Manager home page a warning message and a button to migrate your files from the old structure to the new one.

Contribute

• Issues
• Translations
• Pull requests

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

Set the language ressource

Version 1.1 is untested with XWiki prior to version 4.5. You can try it or use version 1.0 attached as a XAR to this page.
If you are using XWiki 4.2 or a version below, you will have to set the right language ressource: 

• Click on the "administration" link at the top right corner
• In the administration menu, click on "Localization"
• Scroll in this menu until you see "Internationalization Document Bundles"
• In that field, copy-paste the following text : "FileManager.Translation"
• Save the page.

Configure Office Importer

If you want to be able to display OpenOffice/LibreOffice documents, make sure to configure the Office Importer.
Learn how to do it.

Add the PDF Viewer Macro

If you want to display PDF documents, make sure to install the PDF Viewer Macro first. You can either install it with the Extension Manager or download it from here. The installation is automatic with version 1.1.

Release Notes

v2.0.8

This version includes the following:

v2.0.7

This version includes the following:

v2.0.6

This version includes the following:

v1.1

New version with:

• compatibility with 4.5+
• small ui fixes
• added an extension point to add extensions on the home page
• set pages hidden
• set dependency to pdf viewer
• proper release in maven

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-filemanager-ui 2.0.8):

• org.xwiki.contrib:application-filemanager-api 2.0.8
• org.xwiki.platform:xwiki-platform-rendering-macro-velocity 5.4.4
• org.xwiki.platform:xwiki-platform-rendering-macro-include 5.4.4
• org.xwiki.rendering:xwiki-rendering-macro-html 5.4.4
• org.xwiki.platform:xwiki-platform-localization-source-wiki 5.4.4
• org.xwiki.platform:xwiki-platform-sheet-ui 5.4.4
• org.xwiki.platform:xwiki-platform-search-solr-ui 5.4.4
• org.xwiki.platform:xwiki-platform-jodatime 5.4.4
• org.xwiki.platform:xwiki-platform-rendering-macro-code 5.4.4
• org.xwiki.platform:xwiki-platform-office-macro 5.4.4
• org.xwiki.contrib:xwiki-macro-pdfviewer 1.5
• org.xwiki.contrib:macro-jwplayer 2.1.1