Dropfiles documentation

Introduction

Dropfiles is a Joomla extension used to manages all your files and categorize them in a smart way. The file manager is completed by a theme pack and a connection to cloud services (all included).

Dropfiles-main

Main advantages:

  • Add a file in 3 clicks from editor
  • 4 responsive themes with icons
  • Apply a theme per category
  • Files & category AJAX ordering
  • Use Dropfiles from any text editor
  • Theme display parameters
  • Update files in one click
  • HTML5 multi uploader
  • Use Joomla file access rights
  • Remote download
  • File importer from server

 

I. DROPFILES INSTALL

1.1 Install

Our component is Joomla 3.x compatible. All the features and 3rd party integrations are included in all memberships.
In order to install our component you have to download the extension .zip file and use standard Joomla installer.

image7

 

Then click on Browse > Upload and Install button, component, modules and plugins will be installed activated by default.

 

1.2 Update & automatic updater

In order to update the extension you can install a new version over the old one by downloading the ZIP file from JoomUnited or use the automatic updater (recommended).

image9

 

The automatic updater, which push the update notification, is embedded in the Joomla extension you've installed. So you'll get notified like any other extension in the dashboard or using the menu: Extension > Manage > Update menu.

 

Login to your account to update

You need to login to your JoomUnited account to update all your JoomUnited Joomla extensions. In order to login access the main configuration of the component then click on the Live update tab. At the bottom, you'll find a login button. 

image10

 

Enter your JoomUnited credentials, the same you use to login here @ www.joomunited.com

image11

 

The button will turn orange, congrats! you can now update all the JoomUnited extensions on this website! If your membership is expired you'll get a renew link and a text that explain that.

image12

 

Note: one single login will allow you to update all the JoomUnited extensions (regarding your membership). Login won't expire unless you disconnect it.

II. DROPFILES COMMON USE

The main idea of Dropfiles is to set display parameters, size, and file format allowed in the component then manage files and categories directly from articles or any WYSIWYG editor. Dropfiles works on every Joomla WYSIWYG editor, both for frontend and backend. For example you can use it in a custom Joomla module.

2.1 Manage files from article

When Dropfiles is installed you have an editor plugin that is displayed bellow you editor. Click on it to open the main Dropfiles view. Click on it to open the file manager.

editor-button-for-files

 

It's exactly the same interface as if you're loading the component view using the menu Components > Dropfiles

dropfiles-load

From the interface you got on the left part the category management, on the center part your files and on the right part the files and category settings.

dropfiles-interface

 

 

2.2 Manage file categories

In order to create a category, click on New category in the left column

new-file-category

 

Note: a default category is already created during the component install

 

The category accordion manager can be loaded open or closed using a global parameters. To change the state you can click on the +/- buttons on the left side.

category-accordion

 

To order the categories you can use drag’n drop feature by clicking on the left "hamburger" icon and moving it. Move it from top to bottom to order categories or from left to right to define category levels (category or subcategory)

move-category

 

On the right size of the screen you can see category and theme options of the theme. 

themes-selection

 

You can define a theme per category or setup a default theme for all the categories from the dropfiles settings. In order to do that use the setting 

theme-per-category

 

Note that when browsing category level the theme will remain the parent one. So the end user won’t be disturb during navigation on frontend.

 

Depending of the theme you’ve selected you have display options. It helps to display or hide some of the theme elements on frontend, for example display/hive file size, file hits number...

file-display-options

 

Once you’re done with the category parameters, you can click on Save button at the bottom of the right column to save the theme preference.

save-settings

 

If've you've chosen to setup the catrgory theme paramaters in the component options you'll find the same settings, menu Components > Dropfiles > Options

global-option-theme

 

 

2.2 Manage files

To add files in a category, you can drag’n drop files in the center part or click on Select files button

upload-files

 

Then select one or some file to upload. The uploader is HTML 5 powered so you can send big files they will be uploaded.

The only limit you’ll have will be defined by your server configuration, especially the upload_max_filesize and post_max_size values.

 

A file ordering can be done using drag'n drop, just drag the file on the dashed line to define it's new position in the file category.

order-file-dragndrop

 

You can also order all the files from a category or by clicking on the column title then save the ordering. For example, here I've ordered files by size. Once you made the ordering you’ll at the right side, in category options the ordering fields become green.

order-all-file-category

You have also the option to click on the column title to order file by:

  • Type
  • Title
  • Description
  • File size
  • Date
  • Version
  • Hits

 

The column top right option checkbox helps you to clean the backend interface to focus on the main files parameters you have ie. show only file title and version for example.

column-info

 

Finally, in order to insert a file category in your editor, click on Insert this category in the right column.

add-file-category

 

File category will be materialized in your article by a grey area with a Dropfiles icon.

Already done, you’ve added your first Dropfiles category!!
The first time you insert your category, save your article to see the result on frontend. To open again the category and reload the configuration you’ve done, click on it and click back on the dropfiles button.

open-categories-editor

 

 

2.3 Copy Cut Paste files

Once a file has been uploaded to Dropfiles, you can select it by clicking on it. You can select several files by maintaining CTRL.

The first method to move or copy files is to use drag'n drop. Drag'n drop alone will move the file, drag'n drop + MAJ will copy the files

file-copy-move

 

You can also use the top right buttons

copy-paste-buttons

 

2.4 Manage single file

Manage a single file has never been as simple as a click on a file, then file option will be loaded at the right side.

single-file-parameter

 

Dropfiles allows you to define:

  • File publication state
  • File title
  • Description: HTML editor can be activated through an option)
  • File date of creation
  • File date of modification
  • File publish up and down
  • File version
  • File hits
  • File tags (used i the search engine)
  • Single user file view: select a single user that will be able to view the file
  • File new version upload :upload a new file to upoad it and keep all file information

 

To add a single file, not a category, simply click on it then insert this file to add it in your editor.

single-file-content

 

Note that from the option, menu Components > Dropfiles > Options > Single file, you can define the frontend download button design.

 

single-file-management

 

 

 

2.5 Update a file

In order to update a file, open Dropfiles, click on the file of your choice, then use the Send a new version bloc to replace the file.

file-update-process

 

You can change file format, size or whatever, all will be detected and updated. You have also a file version history manager so you can download and restore an old file version.

file-versionning

 

2.6 Remote file download

The remote download is the possibility to add a distant (not hosted on your server) downloadable file among others. It has to be activated trough the component component configuration.

Remote-file

 

Once it's activated a new button called Add remote file will be added. Then you need to define a title, a remote URL (the link to the file) ex. https://www.mywebsite.com/file.zip and a file format (to apply the proper icon to the file).

Once the file is added, you can edit all it's information like any other file.

remote-file-settings

 

2.7 Email notifications

This feature helps you know if any changes or actions has been made on your files. There are 3 main parameters for notification:

  • Notify category owner: the user owner of the category that contains the file will be notified
  • Notify file owner: the user owner of the file will be notified
  • Notify Joomla super admin: users in super admin group will be notified

notify-feature


 

Users and/or admin will receive a notification email if a file is added, edited, deleted or download. Each type of notification can be activated separatelly. and you can add several custom emails.

notification-form

 

There are some supported tags you can use in the Email content: {category}, {username}, {website_url}, {file_name}. The Email content is only some HTML, you can create your own if you want.


 

2.8 A custom icon on files

You can replace the file default icons by your own (PDF icon by a document preview for example). First, you enable Custom icon feature from the Dropfiles options.

enable-custom-icon

 

Next, in the Dropfiles component, click on a file to change its icon. At the bottom right panel, you can select icon you like from your images

custom-icon


 

Or upload a new one.

upload-icon

 

III. FILE SEARCH ENGINE

3.1 Dropfiles search engine

Dropfiles got it's own search engine, apart from the Joomla search engine. The search engine view can be called from a menu element. Use Menu > New > Dropfiles > Search file

new-search-menu

 

Then you'll be able to setup all the search engine elements.

  • The default search file category on page load
  • Search field display only or search engine + filters
  • The file tags as checkbox or as search box: the tag can be added on file from the file edition
  • Default tags
  • Creation date range filters
  • Update date range filters
  • Number of results per page

File-search-and-filtering

 

 

3.2 Dropfiles Joomla search plugin

Dropfiles also got a Joomla search plugin. As files added in articles can be searched by the Joomla default search engine.

joomla-search

 

 

VI. DROPFILES PARAMETERS

4.1 Main parameters

To access to Dropfiles parameters, go in Component > Dropfiles > Options

main-parameters

 

In option, you can define:
 

  • Allowed extensions: the file format you want to authorize on your website to be uploaded/downloaded
  • The viewer type, Dropfiles includes a file viewer
  • Viewer format: witch file format you want to enable the viewer
  • The max upload file size: it's set by your server php.ini value. You can define a lower limit here
  • The file importer activation: activate a server explorer to import files in Dropfiles categories
  • The SEO URL, it adds a prefix to the file links
  • Close categories: the option to load categories accordion open or closed by default
  • Load theme in category: load the theme selection and theme option in each file category
    If it's set to No, the default theme settings from the options apply
  • Add remote file: the possibility to add remote files among other (not hosted on your server)
  • Use WYSIWYG editor: load a full text editor for file description
  • Single user restriction: add the possibility to select a single Joomla user to access to a file
  • Category restriction: apply file access restriction on file category using Joomla User group or Joomla access level

 

3.2 File importer

Dropfiles has a unique file importer available for Joomla. To enable it you should go in Component > Dropfiles and click on Options. Then set “File importer” to Yes.

Note that the importer will be only available in Dropfiles component in the backend for security reason, because it will display all server folders.

 

Then on the right part of your screen you’ll see the listing of your server files with 3 tools that allow you to Select, Unselect and Import files.

importer

 

To import files, choose the category on the left part then select the desired files and click on Import.

 

3.3 ACL file permission

Dropfiles is Joomla user group and access levels to restric file access. In the file restriction documentation we can separate the persmission to view or download a file and the permission to manage the files.

First, to setup who is allowed to view or download the files you need to define in the component main paramaters wether you want to restrict access by Joomla access level or Joomla user group. By default it's Joomla user group.

Then in the category settings (right column) you can allow a group to download files from a category or not. If a user is not allowed, he won't even see the category on frontend.

file-user-group

 

To setup who is allowed to view or download the files an additional parameter is available, still in the main parameters of the component: single user access. This is the possibility to restrict the access to a file or a category of files for a single Joomla user.

This user can be selected from the Joomla user list in the category settings or in the single file settings.

single-file-user

 

Finally to setup the file permission regarding file management, you can access to the configuration still in the settings but in the Permissions tab. Each Joomla user group you have will be listed with the Dropfiles permissions.

For example if you want all users from the Administrator group to access and edit only their own files, set “Edit” to denied and edit own to “Allowed”. You can also restrict:

  • The global configuration access
  • The main Dropfiles interface access 
  • The files creation (upload)
  • The files deletion
  • All file edition
  • Own user file edition

file-permission

 

 

Super admin user will always have access to all files and categories.

 

 

3.4 File category themes

Dropfiles includes a pack of themes. A theme can be set for each category or as a global setting. That's why you have theme settings in the component options and also in the file categories. The category configuration override the default configuration.

Default theme

default-file-theme

 

Tree theme

tree-file-theme

 

Google Drive like theme

GDD-file-theme

 

Table theme

table-file-theme

 

 

IV. DROPFILES TIPS ANS TRICKS

4.1 Load a category in a HTML custom module

 

Dropfiles is built to be used in every WYSIWYG editor field, you just need to have content plugin to be called. Most of the time it’s activated by default.

It’s not the case in the Joomla HTML custom module, you need to activate it like above.

In the option tab you need to set the option Prepare content to Yes

custom-module

 

4.2 Override a Dropfiles theme

You can customize and add theme to Droppics, but we don't use the standard MVC Overrides but the Joomla default plugin system.

Droppics themes are in fact plugins and they are located in the folder /plugins/dropfilesthemes

You'll have to copy one plugin, change the name of the plugin to create your new plugin (pluginname.xml and the class name of the plugin). Then install it through Joomla standard installer, it should be shown in the list of themes. You can then do all changes you want in this theme, it will not be affected by updates.

 

 

V. GOOGLE DRIVE INTEGRATION

5.1 Create a Google drive App


The Google Drive is included in the main Dropfiles package.

First, you need a Google dev App to connect your website to Google Drive. Go to https://console.developers.google.com/project and create a new project.

image79

Then setup a project name (no space, no accent)

image31

 
Then wait few seconds for the project creation…

image62

 

If it's the first time you're using the Google Drive API, you'll need to activate it

enable-drive-api

 

From the left menu, click on “API Manager”

image53


Then on the left menu “Credentials” >> “New credentials” >> OAuth client ID (if asked, add a name to your OAuth consent screen).

image55


Now, the most important step.

  • Select “Web application” and add a name of your choice.
  • Authorized JavaScript origin: https://your-domain.com (replace by your domain name, no slash, no www.)
  • Authorized redirect URIs: http://your-domain.com/administrator/index.php?option=com_dropfiles&task=googledrive.authenticate (put your domain name)
This is the backend Dropfiles URL + &task=googledrive.authenticate

 

image30

 

Then… voilà! You got your ID and Secret to add in the Dropfiles configuration

image57

 


5.2 Login to Google Drive in Dropfiles


Then go back in WordPress admin and click on the menu Options > Google Drive. Paste your

  • Client ID
  • Client secret

Then save the configuration and click on the Google Drive connection button

google-drive-credential

 

Finally, login to your google account by clicking on Google Drive button

If you haven’t made any mistake you should validate the authorization in a new window like bellow

image68

 
Connection should be a success ☺

image29

 

Then you can create Google drive folders and upload files in it!

new-drive

 


5.3 How it works? What can I do with GG Drive?

How it works? 

Dropfiles will generate a root folder on your Google Drive with the site name

image23


All the categories and sub categories added in Dropfiles will added under this folder.

 

What are the sync directions?

It works in both directions! You can add a file from Google Drive and see it Dropfiles or add a file in Dropfiles and see it in Google Drive. It also means you can manage WordPress files from your desktop using Google Drive sync software. That’s crazy! Yes we know ☺

Note that if you remove a file from Google Drive you have to empty your trash to erase it from Google Drive.

drive-sync

 

 

V. DROPBOX INTEGRATION

5.1 Create a Dropbox App


The Dropbox integration is distributed as a separate Add-on. You need to install this add-on (plugin) additionally to Dropfiles. The addon includes integration for Google Drive too.

First you need a Dropbox App to connect your website to a Dropbox account. Go to https://www.dropbox.com/developers and create a new app. 

create-dropbox-app

 

Then setup an app type "Dropbox API", "Full dropbox" and an app name

File categories from Dropfiles will be added as folders @ the root of your Dropbox account (great for a dedicated Dropbox account). If you select "App folder" all folders/files will be stored under a single folder (avoid the mess in your Dropbox account).

 

dropbox-app-info

 

 
Then you're almost done, your app is created and you got your App key and secret

app-created

 


5.2 Login to Dropbox in Dropfiles


Then go back in WordPress admin and click on the menu Dropfiles > Configuration > Dropbox. Paste your

  • App key
  • App secret

 

Then save the configuration and click on the Dropbox connection button

app-key-secret

 

You'll have to validate the access authorization for app access, just click allow.

allow-dropbox-app

 

Finally, an authorization code will be generated and you'll have to copy it in Dropfiles configuration. Then press Connect Dropbox

 

copy-code

 
Connection should be a success ☺ 

connected

 

You can now create folders, sub folders in Dropbox and in Dropfiles, everything will be sync!

new-dropbox-folder

 


5.3 How it works? What can I do with Dropbox?

How it works? 

Dropbox can sync folders/subfolders and files on your Dropfiles interface and the same is possible on the other way (from Dropfiles to Dropbox).

dropbox-web


What are the sync directions?

It works in both directions! You can add a file from Dropbox and see it Dropfiles or add a file in Dropfiles and see it in Dropbox. It also means you can manage Dropfiles files from your desktop using Dropbox sync software. That’s crazy! Yes we know ☺

 

wpfd-dropbox-folder