You are here

README.txt in Media Directories 8

Same filename in this branch
  1. 8 README.txt
  2. 8 modules/media_directories_ui/README.txt
Same filename and directory in other branches
  1. 3.x modules/media_directories_ui/README.txt
INTRODUCTION
============
Alternative UI for Media Directories module, providing classical file browsing interface.


REQUIREMENTS
============
- Drupal Core 8.8.3+
- Entity browser
- jsTree library
  o Download jsTree from https://github.com/vakata/jstree
  o Extract it as is, rename "jstree-X.Y.Z" to "jstree", so the assets are at:
    /libraries/jstree/dist/jstree.min.js


NOTES
============
Upload widget uses code from core with some overrides.
We don't use separate library builder or state service, at least for now, in the future
it should use core classes instead of duplicating them. The main reason for this is
that it forces library view, but we really don't need it, and working around of it at first was a bit difficult.

To select multiple items, hold ctrl key while clicking.


ROADMAP
=============
- CKEditor and field widget integration (need to migrate existing code).
- Check if other custom media types are working or if they don't, find out how to make them work.
- Need to review permissions, add settings.
- We need some kind of preview functionality, maybe some UI changes are needed.
- Quick file upload without type selection (match first media type which allows this file type).
- I'm not sure if upload widget should be inside modal, maybe we could just display it inside file listing area.
- jstree library need to be installed manually.
- Coding standards and code cleanup.
- Maybe we can drop entity browser requirement (required only for ckeditor integration).

File

modules/media_directories_ui/README.txt
View source
  1. INTRODUCTION
  2. ============
  3. Alternative UI for Media Directories module, providing classical file browsing interface.
  4. REQUIREMENTS
  5. ============
  6. - Drupal Core 8.8.3+
  7. - Entity browser
  8. - jsTree library
  9. o Download jsTree from https://github.com/vakata/jstree
  10. o Extract it as is, rename "jstree-X.Y.Z" to "jstree", so the assets are at:
  11. /libraries/jstree/dist/jstree.min.js
  12. NOTES
  13. ============
  14. Upload widget uses code from core with some overrides.
  15. We don't use separate library builder or state service, at least for now, in the future
  16. it should use core classes instead of duplicating them. The main reason for this is
  17. that it forces library view, but we really don't need it, and working around of it at first was a bit difficult.
  18. To select multiple items, hold ctrl key while clicking.
  19. ROADMAP
  20. =============
  21. - CKEditor and field widget integration (need to migrate existing code).
  22. - Check if other custom media types are working or if they don't, find out how to make them work.
  23. - Need to review permissions, add settings.
  24. - We need some kind of preview functionality, maybe some UI changes are needed.
  25. - Quick file upload without type selection (match first media type which allows this file type).
  26. - I'm not sure if upload widget should be inside modal, maybe we could just display it inside file listing area.
  27. - jstree library need to be installed manually.
  28. - Coding standards and code cleanup.
  29. - Maybe we can drop entity browser requirement (required only for ckeditor integration).