Folders Pane

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(Advanced Operations section updated to CKFinder 2.1 Help)
(Whitespace added)
 
(5 intermediate revisions by the same user not shown)
Line 35: Line 35:
  
 
[[Image:CKFinder_folder_menu.png|frame|center|Folder context menu]]
 
[[Image:CKFinder_folder_menu.png|frame|center|Folder context menu]]
 
  
 
* <strong>New Subfolder</strong> &ndash; creates a new subfolder in this parent folder.
 
* <strong>New Subfolder</strong> &ndash; creates a new subfolder in this parent folder.
Line 48: Line 47:
  
 
=== Creating Folders ===
 
=== Creating Folders ===
 +
In order to create a child folder inside an existing folder, choose the '''New Subfolder''' option from the context menu of the parent folder. Type the name of the new folder in the dialog window that will be displayed. Once you give the new folder a name and close the dialog window, the folder will be created.
 +
 +
[[Image:CKFinder_folder_new.png|frame|center|Creating a new folder in CKFinder]]
 +
  
To create a child folder inside an existing folder, just click the "New Subfolder" option in the context menu. A dialog box will appear, asking for the new folder name. Just type it and confirm.
+
Not all characters can be used in folder and file names due to limitations of the systems where CKFinder runs. Among the characters that cannot be used in folders and files names are: <code>\</code> <code>/</code> <code><nowiki>:</nowiki></code> <code><nowiki>*</nowiki></code> <code>?</code> <code>"</code> <code>&lt;</code> <code>&gt;</code> and <code><nowiki>|</nowiki></code>.
  
Not all characters can be used in folder and files names due to limitations in the systems where CKFinder runs. For instance, the following characters cannot be used on folders and files names: \ /&nbsp;: *&nbsp;? " &lt; &gt; |
 
  
 
=== Renaming Folders ===
 
=== Renaming Folders ===
  
To rename a folder, just click the "Rename" option in the context menu. A dialog box, containing the current folder name, will appear, asking for the new folder name. Just type it and confirm.
+
In order to rename a folder, choose the '''Rename''' option from its context menu or use the ''F2'' keyboard shortcut. Type the new folder name in the dialog window that will be displayed, overwriting the existing name. Once you enter the new folder name and close the dialog window, the folder will be renamed.
 +
 
 +
[[Image:CKFinder_folder_rename.png|frame|center|Renaming a folder in CKFinder]]
 +
 
 +
 
 +
As stated above, not all characters can be used in folder and file names due to limitations of the systems where CKFinder runs. Among the characters that cannot be used in folders and files names are: <code>\</code> <code>/</code> <code><nowiki>:</nowiki></code> <code><nowiki>*</nowiki></code> <code>?</code> <code>"</code> <code>&lt;</code> <code>&gt;</code> and <code><nowiki>|</nowiki></code>.
 +
 
 +
<note>'''Attention''': When you rename a folder, links or media insertions available on other pages and pointing to files or folders inside the renamed folder will be broken, and thus not available anymore. Because of that be careful when using this feature.</note>
  
Not all characters can be used in folder and files names due to limitations in the systems where CKFinder runs. For instance, the following characters cannot be used on folders and files names: \ /&nbsp;: *&nbsp;? " &lt; &gt; |
 
  
<span>'''Attention'''</span>: by renaming a folder, links or media insertions available in other pages, which point to files or folders inside the renamed folder, will be "broken", therefore not available anymore. So, be careful when using this feature.
+
=== Copying and Moving Files from Basket ===
 +
The '''Basket''' is a virtual placeholder that can be helpful if you want to perform batch operations on files. The copying and moving operations are described in the '''[[CKFinder_2.x/Users_Guide/CKFinder Interface/Folders Pane/Basket|Basket]]''' section of the User's Guide.
  
 
=== Deleting Folders ===
 
=== Deleting Folders ===
 +
In order to delete a folder, including all its contents, choose the '''Delete''' option from its context menu or use the ''Del'' key. A confirmation message will appear to ensure that this operation is what you really intend to do. Once you confirm the deletion, the folder will be removed.
 +
 +
<note>'''Attention''': This operation cannot be undone. Once you delete the folder and its contents, you will not be able to restore the removed files.
 +
</note>
 +
 +
 +
[[Image:CKFinder_folder_delete.png|frame|center|Deleting a folder in CKFinder]]
 +
  
To delete a folder, including its contents, just click the "Delete" option in the context menu. A confirmation message will appear to ensure that this operation is desired.
+
<note>'''Attention''': When you delete a folder, links or media insertions available on other pages and pointing to files or folders inside the deleted folder will be broken, and thus not available anymore. Because of that be careful when using this feature.</note>
  
'''<span>Attention</span>''': by deleting a folder, links or media insertions available in other pages, which point to files or folders inside the deleted folder, will be "broken", therefore not available anymore. So, be careful when using this feature.
 
  
== "Under Request" Loading ==
+
== "On Request" Loading ==
 +
The most important difference between CKFinder and the folders tree structures found in desktop operating systems is that in CKFinder the folders are loaded "on request". It means that the application does not load the entire folders tree structure at startup, but instead loads its small subset when the folder is being expanded. This feature is present in most advanced web applications like CKFinder and allows to save on bandwidth and loading time.
  
&nbsp;The most important difference between CKFinder and the folders tree found in operating systems, is that, in CKFinder, the folders are loaded "under request". It means that it doesn't load the entire folders tree at startup, but loads a small subset of them when "opening" the folder. This is a requirement on advanced web applications like CKFinder.
+
To indicate that folders are being loaded, the '''Loading...''' label may appear when you expand a folder:
  
To indicate that folders are being loaded, the "Loading..." label may appear when opening a folder: <br>
+
[[Image:CKFinder_folder_loading.png|frame|center|Folder loading in CKFinder]]
  
[[Image:Ckfinder under request.gif|Image:Ckfinder_under_request.gif]]
 
  
The label will automatically disappear once the folders load is completed. Once loaded, the label should not appear anymore for that folder.&nbsp;
+
The label will automatically disappear once all requested folders are loaded.

Latest revision as of 13:23, 7 October 2011

The Folders Pane contains the "tree view" of the folders that you can navigate. Folders are used to organize and categorize your files.

CKFinder Folders Pane


Folders display is called "tree view" because the folders hierarchy is represented like tree branches, with subfolders placed below and indented with regard to their parent items. The Folders Pane uses the same graphic representation that can be found in many modern operating systems.

Basic Operations

Opening (Expanding) a Folder

In order to open a folder and expand its subfolders, click the plus icon (Ckfinder plus sign.gif) in front of the folder name. If the plus icon is not present, the folder does not contain any subfolders.

Collapsed folder


See the "On Request Loading" section below if you require more information about the loading process in CKFinder.

Closing (Collapsing) a Folder

In order to close a folder and hide (collapse) its subfolders, click the minus icon (Ckfinder minus sign.gif) in front of the folder name.

Expanded folder with its subfolders


Selecting a Folder

In order to select a folder and make it the "current folder" in CKFinder, click the folder name or its icon. The selected folder will be highlighted with a different background color.

Selected CKFinder folder


Advanced Operations

Advanced operations can be performed on a folder by using its Context Menu. Depending on the circumstances, the following options may be available:

Folder context menu
  • New Subfolder – creates a new subfolder in this parent folder.
  • Rename – changes the name of the folder.
  • Copy Files from Basket – copies the files that were placed in the Basket to the selected folder.
  • Move Files from Basket – moves the files that were placed in the Basket to the selected folder.
  • Delete – permanently removes the folder.
important note

Note: Some context menu options may be disabled (and thus grayed out), depending on CKFinder settings enforced by your system administrator.


Creating Folders

In order to create a child folder inside an existing folder, choose the New Subfolder option from the context menu of the parent folder. Type the name of the new folder in the dialog window that will be displayed. Once you give the new folder a name and close the dialog window, the folder will be created.

Creating a new folder in CKFinder


Not all characters can be used in folder and file names due to limitations of the systems where CKFinder runs. Among the characters that cannot be used in folders and files names are: \ / : * ? " < > and |.


Renaming Folders

In order to rename a folder, choose the Rename option from its context menu or use the F2 keyboard shortcut. Type the new folder name in the dialog window that will be displayed, overwriting the existing name. Once you enter the new folder name and close the dialog window, the folder will be renamed.

Renaming a folder in CKFinder


As stated above, not all characters can be used in folder and file names due to limitations of the systems where CKFinder runs. Among the characters that cannot be used in folders and files names are: \ / : * ? " < > and |.

important note
Attention: When you rename a folder, links or media insertions available on other pages and pointing to files or folders inside the renamed folder will be broken, and thus not available anymore. Because of that be careful when using this feature.


Copying and Moving Files from Basket

The Basket is a virtual placeholder that can be helpful if you want to perform batch operations on files. The copying and moving operations are described in the Basket section of the User's Guide.

Deleting Folders

In order to delete a folder, including all its contents, choose the Delete option from its context menu or use the Del key. A confirmation message will appear to ensure that this operation is what you really intend to do. Once you confirm the deletion, the folder will be removed.

important note

Attention: This operation cannot be undone. Once you delete the folder and its contents, you will not be able to restore the removed files.


Deleting a folder in CKFinder


important note
Attention: When you delete a folder, links or media insertions available on other pages and pointing to files or folders inside the deleted folder will be broken, and thus not available anymore. Because of that be careful when using this feature.


"On Request" Loading

The most important difference between CKFinder and the folders tree structures found in desktop operating systems is that in CKFinder the folders are loaded "on request". It means that the application does not load the entire folders tree structure at startup, but instead loads its small subset when the folder is being expanded. This feature is present in most advanced web applications like CKFinder and allows to save on bandwidth and loading time.

To indicate that folders are being loaded, the Loading... label may appear when you expand a folder:

Folder loading in CKFinder


The label will automatically disappear once all requested folders are loaded.

This page was last edited on 7 October 2011, at 13:23.