You are here

Home » API reference » Workbench Media 7

README.txt in Workbench Media 7

Same filename and directory in other branches
  1. 7.2 README.txt

README file for Workbench Media.

File

README.txt
View source 
  1. /**

  2.  * @file

  3.  * README file for Workbench Media.

  4.  */

  5. 

  6. Workbench Media

  7. Workbench integration for the File, File Entity, and Media modules.

  8. 

  9. CONTENTS

  10. --------

  11. 

  12. 1.  Introduction

  13. 1.1   Use-case

  14. 1.2   Examples

  15. 2.  Installation

  16. 3.  Permissions

  17. 4.  Configuration

  18. 5.  Using the module

  19. 6.  Troubleshooting

  20. 7.  Developer notes

  21. 7.1   API documentation

  22. 7.2   Database schema

  23. 8.  Feature roadmap

  24. 

  25. 

  26. ----

  27. 1.  Introduction

  28. 

  29. Workbench Media provides integration with the File, File Entity, and Media

  30. modules for Workbench and its suite of modules.

  31. 

  32. Workbench Media provides some basic file management within the Workbench

  33. framework; essentially, it allows users to see all files that have been

  34. uploaded to the site.

  35. 

  36. ----

  37. 1.1  Use-case

  38. 

  39. Media module is a solution for managing various media files including

  40. images, video, and audio.  The Media Workbench module allows a user to add

  41. media items without having to leave the Workbench.

  42. 

  43. A typical request from clients is to re-use files that have already been

  44. uploaded to a site.  Any type of file might be re-used: PDF, PNG, ZIP.

  45. 

  46. ----

  47. 1.2  Examples

  48. 

  49. To support large numbers of photo galleries or slideshows it's nice to provide

  50. a reverse lookup.  Create your photo gallery, then create media items and

  51. use a node reference field to choose which gallery will display the media item.

  52. 

  53. Adding a media item on its own requires having access to Find Content -> Media

  54. tab.  We wanted to simplify where content administrators need to go to add

  55. any content.

  56. 

  57. 

  58. ----

  59. 2.  Installation

  60. 

  61. Workbench and Media are required in order to install Workbench Media.

  62. 

  63. 

  64. ----

  65. 3.  Permissions

  66. 

  67. Permissions need to be set for Media and Workbench Media modules in order to

  68. make use of Workbench Media.

  69. 

  70. Workbench Media has one permission:

  71. 

  72.  -- Use the media add form

  73.  Allows the user to add media directly from the Create Content tab.

  74. 

  75. A typical permission setup so that a user can take advangate of Workbench Media

  76. looks like:

  77. 

  78.   Media Permissions

  79.    -- View media

  80.    -- Edit media

  81. 

  82.   Workbench

  83.    -- Access My Workbench

  84. 

  85.   Workbench Media

  86.    -- Use the media add form

  87. 

  88. A user needs the "Access My Workbench" permission which is a general

  89. Workbench permission setting.  If a user has Access My Workbench permission,

  90. then she can access Workbench Files.

  91. 

  92. 

  93. ----

  94. 4.  Configuration

  95. 

  96. There is no specific configuration for Workbench Media.

  97. 

  98. 

  99. ----

  100. 5.  Using the module

  101. 

  102. When viewing the Workbench, you can access media items in two ways.

  103. 

  104. Click the Create Content tab.  The Create Media list is at the top.  Click

  105. Upload Media.  From there you select a file to upload.  Click Save, and it is

  106. saved as a media item.

  107. 

  108. Media items are entities.  You can easily expand a media item to contain any

  109. important meta data you want to store with the uploaded file.  Learn more at

  110. http://drupal.org/project/media

  111. 

  112. Back in My Workbench, you can see media you have uploaded in the File List tab.

  113. 

  114. When viewing My Workbench, you will see that Workbench Media adds a tab

  115. called "File List".  Click this tab.

  116. 

  117. The File List tab provides a list of all files that have been uploaded to the

  118. site.  Typical web image file formats (like jpg, png, gif) will include a

  119. thumbnail of the image in the Type column.  Other file types like PDF display a

  120. icon representing the file type.

  121. 

  122. The list includes which nodes use the file, the URL as well as the filepath

  123. (e.g. public://filename.pdf).

  124. 

  125. 

  126. ----

  127. 6.  Troubleshooting

  128. 

  129. When I add media, I get a Permission Denied error when I click save.

  130.   -- Fix this by setting the "View media" and "Edit media" permissions for your

  131.   user role.

  132. 

  133. 

  134. ----

  135. 7.  Developer notes

  136. 

  137. The following section documents technical details of interest to developers.

  138. 

  139. ----

  140. 7.1   API documentation

  141. 

  142. Workbench Media does not offer an API.

  143. 

  144. ----

  145. 7.2   Database schema

  146. 

  147. Workbench Media does not create any tables during installation.

  148. 

  149. ----

  150. 8.  Feature roadmap

  151. 

  152. We think some of the changes made for Workbench Media may roll back into Media.

  153. Workbench Media has been merged with Workbench Files. Please see "tasks" in the

  154. Workbench Media issue queue for information on the current direction:

  155. http://drupal.org/project/issues/workbench_media?status=Open&categories=task