You are here

README.txt in File Entity Browser 8

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended Modules
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

The File Entity Browser module provides a default Entity Browser for files,
using Masonry and Imagesloaded.

The purpose of this module is to bring back the Media Library experience from
Drupal 7, without requiring users to standardize on contributed projects like
File Entity and Media Entity.

 * For a full description of the module visit:
   https://www.drupal.org/project/file_browser

 * To submit bug reports and feature suggestions, or to track changes visit:
   https://www.drupal.org/project/issues/file_browser


REQUIREMENTS
------------

This module requires the following modules:

 * Entity Browser - https://www.drupal.org/project/entity_browser
 * Entity Embed - https://www.drupal.org/project/entity_embed
 * Dropzonejs - https://www.drupal.org/project/dropzonejs
 * Embed - https://www.drupal.org/project/embed

This module requires the following libraries:

 * imagesLoaded library - https://github.com/desandro/imagesloaded
 * Masonry library - https://github.com/desandro/masonry/
 * dropzone.min.js library - https://github.com/enyo/dropzone


RECOMMENDED MODULES
-------------------

This module introduces a common repository for libraries in sites/all/libraries
resp. sites/<domain>/libraries for contributed modules.

 * Libraries API - https://www.drupal.org/project/libraries


INSTALLATION
------------

Install the File Entity Browser module as you would normally install a
contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further
information.

If you maintain a composer.json file for your Drupal project, you can require
this module and its dependencies! A fully complete example can be found here:

 * example composer.json file -
   https://gist.github.com/mortenson/a5390d99013b5b8c0254081e89bb4d47


CONFIGURATION
-------------

    1. Download the required libraries in the libraries directory.
       a. Download https://github.com/desandro/imagesloaded/archive/v3.2.0.zip
          and extract the download to /libraries/imagesloaded (or any libraries
          directory if you're using the Libraries module).
       b. Download https://github.com/desandro/masonry/archive/v3.3.2.zip and
          extract the download to /libraries/masonry (or any libraries directory
          if you're using the Libraries module).
       c. Download https://github.com/enyo/dropzone/archive/v4.3.0.zip and
          extract the download to /libraries/dropzone (or any libraries
          directory if you're using the Libraries module).
    2. Navigate to Adminstration > Extend and enabled the File Entity Browser
       and its dependencies.

Please note:
The example sub-module "File Browser Example" includes a Custom Block/Content
Type that uses File Browser components for File, Image, and File Entity
Reference fields. Enable the example module if you'd like to quickly see how
Entity Browser integration with File Browser can work.


MAINTAINERS
-----------

 * Samuel Mortenson (samuel.mortenson) -
   https://www.drupal.org/u/samuelmortenson

Supporting organization:
 * Acquia - https://www.drupal.org/acquia

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Recommended Modules
  6. * Installation
  7. * Configuration
  8. * Maintainers
  9. INTRODUCTION
  10. ------------
  11. The File Entity Browser module provides a default Entity Browser for files,
  12. using Masonry and Imagesloaded.
  13. The purpose of this module is to bring back the Media Library experience from
  14. Drupal 7, without requiring users to standardize on contributed projects like
  15. File Entity and Media Entity.
  16. * For a full description of the module visit:
  17. https://www.drupal.org/project/file_browser
  18. * To submit bug reports and feature suggestions, or to track changes visit:
  19. https://www.drupal.org/project/issues/file_browser
  20. REQUIREMENTS
  21. ------------
  22. This module requires the following modules:
  23. * Entity Browser - https://www.drupal.org/project/entity_browser
  24. * Entity Embed - https://www.drupal.org/project/entity_embed
  25. * Dropzonejs - https://www.drupal.org/project/dropzonejs
  26. * Embed - https://www.drupal.org/project/embed
  27. This module requires the following libraries:
  28. * imagesLoaded library - https://github.com/desandro/imagesloaded
  29. * Masonry library - https://github.com/desandro/masonry/
  30. * dropzone.min.js library - https://github.com/enyo/dropzone
  31. RECOMMENDED MODULES
  32. -------------------
  33. This module introduces a common repository for libraries in sites/all/libraries
  34. resp. sites//libraries for contributed modules.
  35. * Libraries API - https://www.drupal.org/project/libraries
  36. INSTALLATION
  37. ------------
  38. Install the File Entity Browser module as you would normally install a
  39. contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further
  40. information.
  41. If you maintain a composer.json file for your Drupal project, you can require
  42. this module and its dependencies! A fully complete example can be found here:
  43. * example composer.json file -
  44. https://gist.github.com/mortenson/a5390d99013b5b8c0254081e89bb4d47
  45. CONFIGURATION
  46. -------------
  47. 1. Download the required libraries in the libraries directory.
  48. a. Download https://github.com/desandro/imagesloaded/archive/v3.2.0.zip
  49. and extract the download to /libraries/imagesloaded (or any libraries
  50. directory if you're using the Libraries module).
  51. b. Download https://github.com/desandro/masonry/archive/v3.3.2.zip and
  52. extract the download to /libraries/masonry (or any libraries directory
  53. if you're using the Libraries module).
  54. c. Download https://github.com/enyo/dropzone/archive/v4.3.0.zip and
  55. extract the download to /libraries/dropzone (or any libraries
  56. directory if you're using the Libraries module).
  57. 2. Navigate to Adminstration > Extend and enabled the File Entity Browser
  58. and its dependencies.
  59. Please note:
  60. The example sub-module "File Browser Example" includes a Custom Block/Content
  61. Type that uses File Browser components for File, Image, and File Entity
  62. Reference fields. Enable the example module if you'd like to quickly see how
  63. Entity Browser integration with File Browser can work.
  64. MAINTAINERS
  65. -----------
  66. * Samuel Mortenson (samuel.mortenson) -
  67. https://www.drupal.org/u/samuelmortenson
  68. Supporting organization:
  69. * Acquia - https://www.drupal.org/acquia