<
From version < 737.1 >
edited by Silvia Macovei
on 2020/09/11 14:23
To version < 738.1 >
edited by Silvia Macovei
on 2020/09/11 14:25
>
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,75 +1,7 @@
1 -{{extensionToc/}}
1 +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.
2 +You can use drag & drop to upload new files and to modify the folder hierarchy.
3 +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.
2 2  
3 -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.
4 -
5 -== Home Page ==
6 -
7 -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.
8 -
9 9  {{image reference="HomePage.png"/}}
10 10  
11 -=== Folder Tree ===
12 12  
13 -The folder tree lists the root folders and some special nodes:
14 -
15 -* 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.
16 -* 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).
17 -* 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.
18 -* 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.
19 -
20 -{{image reference="TreeContextMenu.png"/}}
21 -
22 -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.
23 -
24 -=== File Live Table ===
25 -
26 -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.
27 -
28 -{{image reference="Livetable.png"/}}
29 -
30 -=== File Upload ===
31 -
32 -To upload a new file in the current folder you have to click on the New File button from above the live table.
33 -
34 -{{image reference="Upload.png"/}}
35 -
36 -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.
37 -
38 -== Folder View ==
39 -
40 -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.
41 -
42 -{{image reference="FolderView.png"/}}
43 -
44 -== File View ==
45 -
46 -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:
47 -
48 -* in case of text files the [[Code Macro>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro]] is used to display the file content using highlighting specific for each file type.
49 -* in case of image file the image is displayed inline.
50 -* in case of audio and video files the file is played using the [[JW Player>>http://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro]], when present, or if the browser supports HTML5 audio/video playback then the native players are used.
51 -* in case of PDF files the [[PDF Viewer>>http://extensions.xwiki.org/xwiki/bin/view/Extension/PDF%20Viewer%20Macro]] is used, when present.
52 -* in case of office files the [[Office Viewer>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro]] is used, but you need to connect your wiki to an office server first.
53 -
54 -{{image reference="FileView.png"/}}
55 -
56 -== Recent Files Macro ==
57 -
58 -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.
59 -
60 -{{code language="none"}}
61 -{{fileManager.recentFiles/}}
62 -{{/code}}
63 -
64 -{{image reference="recentFilesMacro.png"/}}
65 -
66 -The following macro parameters are available:
67 -
68 -|=Name|=Description|=Default Value|=Since
69 -|limit|The maximum number of files to list.|5|2.0RC2
70 -
71 -== Migration from Older Versions ==
72 -
73 -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.
74 -
75 -{{image reference="migration.png"/}}
Store.Code.PayingAppsClass[0]
Documentation
... ... @@ -1,0 +1,76 @@
1 += Topics =
2 +
3 +{{toc start="2"/}}
4 +
5 +== Home Page ==
6 +
7 +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.
8 +
9 +{{image reference="HomePage.png"/}}
10 +
11 +=== Folder Tree ===
12 +
13 +The folder tree lists the root folders and some special nodes:
14 +
15 +* 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.
16 +* 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).
17 +* 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.
18 +* 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.
19 +
20 +{{image reference="TreeContextMenu.png"/}}
21 +
22 +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.
23 +
24 +=== File Live Table ===
25 +
26 +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.
27 +
28 +{{image reference="Livetable.png"/}}
29 +
30 +=== File Upload ===
31 +
32 +To upload a new file in the current folder you have to click on the New File button from above the live table.
33 +
34 +{{image reference="Upload.png"/}}
35 +
36 +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.
37 +
38 +== Folder View ==
39 +
40 +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.
41 +
42 +{{image reference="FolderView.png"/}}
43 +
44 +== File View ==
45 +
46 +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:
47 +
48 +* in case of text files the [[Code Macro>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Code%20Macro]] is used to display the file content using highlighting specific for each file type.
49 +* in case of image file the image is displayed inline.
50 +* in case of audio and video files the file is played using the [[JW Player>>http://extensions.xwiki.org/xwiki/bin/view/Extension/JW%20Player%20Macro]], when present, or if the browser supports HTML5 audio/video playback then the native players are used.
51 +* in case of PDF files the [[PDF Viewer>>http://extensions.xwiki.org/xwiki/bin/view/Extension/PDF%20Viewer%20Macro]] is used, when present.
52 +* in case of office files the [[Office Viewer>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Office%20Macro]] is used, but you need to connect your wiki to an office server first.
53 +
54 +{{image reference="FileView.png"/}}
55 +
56 +== Recent Files Macro ==
57 +
58 +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.
59 +
60 +{{code language="none"}}
61 +{{fileManager.recentFiles/}}
62 +{{/code}}
63 +
64 +{{image reference="recentFilesMacro.png"/}}
65 +
66 +The following macro parameters are available:
67 +
68 +|=Name|=Description|=Default Value|=Since
69 +|limit|The maximum number of files to list.|5|2.0RC2
70 +
71 +== Migration from Older Versions ==
72 +
73 +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.
74 +
75 +{{image reference="migration.png"/}}
76 +
XWiki SAS Copyright © 2024