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.

(Article introduction updated to CKFinder 2.1 Help)
(Basic Operations section updated to CKFinder 2.1 Help)
Line 11: Line 11:
 
== Basic Operations ==
 
== Basic Operations ==
  
=== Opening a Folder ===
+
=== Opening (Expanding) a Folder ===
 +
In order to open a folder and expand its subfolders, click the plus icon ([[Image:Ckfinder_plus_sign.gif]]) in front of the folder name. If the plus icon is not present, the folder does not contain any subfolders.
  
To open a folder, revealing its "children" folders, simply click in the plus sign ([[Image:Ckfinder plus sign.gif|Image:Ckfinder_plus_sign.gif]]) in front of it. If the plus sign is not present, the folder doesn't have children folders to be displayed. 
+
[[Image:CKFinder_folder_expand.png|frame|center|Collapsed folder]]
  
See "Under Request Loading" below in this page to better understand how folders are load.
 
  
=== Closing a 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 ([[Image:Ckfinder_minus_sign.gif]]) in front of the folder name.
 +
 
 +
[[Image:CKFinder_folder_collapse.png|frame|center|Expanded folder with its subfolders]]
  
To close a folder, hiding its children folders, simply click in the minus sign ([[Image:Ckfinder minus sign.gif|Image:Ckfinder_minus_sign.gif]]) in front of it.
 
  
 
=== Selecting a Folder ===
 
=== 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.
 +
 +
[[Image:CKFinder_folder_select.png|frame|center|Selected CKFinder folder]]
  
To select a folder, making it the "current folder" in CKFinder, simply click in the folder name, or in its icon. The selected folder will have a different background color.
 
  
 
== Advanced Operations ==
 
== Advanced Operations ==

Revision as of 12:31, 20 September 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 may be achieved on a folder by using its "Context Menu". The following options are available:

Image:Ckfinder_context_menu.gif

Note: Some context menu buttons may be disabled, depending on CKFinder settings enforced by your system administrator.

Creating Folders

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 files names due to limitations in the systems where CKFinder runs. For instance, the following characters cannot be used on folders and files names: \ / : * ? " < > |

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.

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: \ / : * ? " < > |

Attention: 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.

Deleting Folders

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.

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

 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 opening a folder:

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.