You are here

README.txt in Node Gallery 6.2

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 6 README.txt
NODE GALLERY MODULE
-------------------


CONTENTS
-------- 
 * Description
 * Features
 * Requirements
 * Contributed Modules
 * Un-Install Notes
 * Items Created at Install
 * Installation
 * Create a Gallery
 * Edit a Gallery
 * Additional Configurations
 * Edit a Gallery Relationship and Configurations
 * Create a Gallery Relationship
 * Handbook Links
 * Drupal Links
 * Credits
 

DESCRIPTION
-----------
  The node gallery image management system provides administrators with a
  flexible and powerful image gallery. Administrators can designate the content
  type to be used for the "Gallery" node, and the content type to be used for
  the "Image" node.  Since the "Image" and the "Gallery" are both node or
  content types, they can use many of Drupal's contributed modules to enhance
  the galleries.  Upon installation, the required settings are automatically
  created so users can start posting galleries right away. Website users can
  upload "Images" into a "Gallery", edit them within the "Gallery" and delete
  them if needed.


FEATURES
--------
 - Naturally integrated with Drupal Taxonomy, Comments, Path, Pathauto, 
   Views, Token, VotingApi, Fivestar, CCK(Content Construction Kit),
	 Custom breadcrumbs, ImageCache, ImageAPI, Nodewords
	 and many other contributed modules.
 - Use Drupal's core batch system to do operations such as uploading, editing
   etc.
 - Theme or customize galleries with CSS and tpl.php files included with the
   system. 
 - Everything you can do with nodes you can do to your gallery and images.
 - Unlimited user albums
 - Set image size, maximum number of images and upload limits for each Drupal
   role.
 - Set image storage location and use custom tokens to help if desired. 
 - 4 custom tokens included to enhance and control the galleries.
 - Lightbox2 contributed module integration with lighbox2 slide show.
 - Titles, Descriptions, Captions and Image counts.
 - Drag handle image sorting and field sorting for submission forms.
 - Previous/Next pagers


REQUIREMENTS
------------
 * ImageCache module	http://drupal.org/project/ImageCache
 * ImageAPI module	http://drupal.org/project/ImageAPI


CONTRIBUTED MODULES
-------------------
 * Lightbox2 module	http://drupal.org/project/lightbox2
	 
ADD-ON MODULES
-------------------
 * Node_gallery_access module http://drupal.org/project/node_gallery_access
	 Control gallery access to public, private or password.
	

IMPORTANT UN-INSTALL NOTES
--------------------------
  The three ImageCache presets created by the Node Gallery module
  will be deleted if you disable the Node Gallery module, so it is recommended
  that you only use these presets with Node Gallery. However, if you modify the
  Node Gallery presets, they will be saved into the system and continue to exist
  without regard to the Node Gallery module being enabled.


ITEMS CREATED AT INSTALL TIME
-----------------------------
  1. Two node types; one for galleries and one for gallery images.
  
  2. Three ImageCache presets; for cover, display, and thumbnail.
  
  3. One node gallery relationship; linking the gallery node with the
     gallery image nodes.


INSTALLATION
------------
  1. Download node_gallery, ImageAPI, and ImageCache.
  
  2. Unzip or unpack the modules on your computer.
  
  3. Upload the module folders with all the contents (as is) to the
  sites/all/modules folder.
  
  4. Goto: Administer > Site configuration > Clean URLs
  Enable clean URLs (required for ImageCache to work).
  
  5. Goto: Administer > Site building > Modules
  Enable Node Gallery, ImageAPI, ImageAPI GD2, ImageCache, ImageCache UI,
  Node Gallery Lightbox2 Integration (if needed), and Node Gallery Access (if
  needed).
  
  6. Save the settings to install (updates the database).
  
  7. Goto: Administer > User management > Permissions
  Configure the Permissions for:
  -ImageCache module- 
      view ImageCache node-gallery-cover 
      view ImageCache node-gallery-display 
      view ImageCache node-gallery-thumbnail
  -node module-
      access content 
      administer nodes(use with caution) 
      create node_gallery_gallery content 
      create node_gallery_image content 
      delete any node_gallery_gallery content 
      delete any node_gallery_image content 
      delete own node_gallery_gallery content 
      delete own node_gallery_image content 
      edit any node_gallery_gallery content 
      edit any node_gallery_image content 
      edit own node_gallery_gallery content 
      edit own node_gallery_image content
  - node_gallery module -
      view node gallery  
  
  At this point, users can create galleries.


CREATE A GALLERY
----------------
   1. Goto: Create content > Gallery

   2. Name the gallery

   3. Provide a description for the gallery if desired.

   4. Click "Save"

   5. Click "Upload some images!"

   6. Browse and choose images.

   7. Click "Submit Files"

   8. Add a caption to each image if desired.

   9. Choose a cover image using the radio buttons on the right.

  10. Drag sort the order of images.

  11. Click "Submit"

  12. View your gallery.


EDIT A GALLERY
--------------
   1. Login and Goto: your gallery

   2. Click: Edit gallery, Upload images, Manage images or Delete Gallery


ADDITIONAL CONFIGURATIONS
-------------------------
   Configurations for a gallery relationship.
	(See the next section below, Edit a gallery relationship.)
	
   Configure the number of Albums on gallery list pages and the
 	number of images on each thumbnail page.
	Goto: Administer > Site configuration > Node gallery > Common settings

   Configure Gallery or Album submission form.
	Goto: Administer > Content management > Content types > Edit gallery

   Configure Gallery Image submission form.
	Goto: Administer > Content management > Content types > Edit gallery image

   Configure node gallery access.
	Goto: Administer > Site building > Modules > List
	Enable Node Gallery Access module to use this function.
		
   Customize galleries with css, views or tpl.php files.
	The node gallery handbook has more information about views and css.

   Customize paths and/or URLs with 4 custom node_gallery Tokens.
	[parent-node-gallery-path]	The path of the parent Gallery. 
	[parent-node-gallery-path-raw]	Unfiltered path of the parent Gallery.
	[parent-node-gallery-title]	The title of the parent Gallery. 
	[parent-node-gallery-title-raw]	Unfiltered title of the parent Gallery.
		
   Customize the ImageCache presets.
	Goto: Administer > Site building > ImageCache > List

	Add new, Configure, Edit and/or Delete the Presets as desired for
 	each part of the gallery. Add new presets or reuse existing
 	presets when Adding Gallery Relationships.

   Customize Lightbox settings.
	Goto: Administer > Site configuration > Lightbox2	

   GD2 image quality setting.
	Goto: Administer > Site configuration > ImageAPI > Configure


EDIT A GALLERY RELATIONSHIP AND/OR CONFIGURATIONS
-------------------------------------------------
  1. Goto: Site configuration > Node gallery > List
  	Click "Edit" next to the gallery relationship which will open the
 	first configuration page.

  2. The first configuration page has the content type settings.
	Select the content types to be used for the "Gallery" and the
 	"Image" types. 

	To edit the gallery configurations, go to the
	bottom of the page and click next. Clicking "Next" will
	open the second configuration page.
	
  3. The second configuration page has the detailed gallery
 	configurations.
	
	Gallery Type Name:
		The name to show on create content page.
	
	Gallery Directory:
		Set the directory to hold images inside sites/default/files
		 - sites/default/files/[name or token]/[name or token] -

	Default Cover Image:
    		Specify a default cover image to show when there
		 are no images in the gallery.
	
	Number of uploads:
    		Select the number of upload buttons(fields)
		for images on each upload page. Use caution when
		adding more than 4 or 5 as php.ini settings may
		need to be changed.

	Fields:
    		Specify the fields to show(check boxes).
    		Title, caption, revision info, comment settings, path settings.

	Choose the content you want to display:
    		Specify the description text to be used when displaying image pages.
    		Choose gallery description (or) image description.

	Image Comment Setting:
    		Specify the comment setting to use. (Image or gallery)
		 as per setting in the content type.

	Images Sizes:
    		Select which ImageCache Preset to use for each
		 image display(cover, thumbnail, display).
	
	Original Image Display:
    		Set the option to allow viewing full sized image
		 disabled, with a link or lightbox2 pop-up.

	Teaser setting:
    		Specify how to display the gallery and image
		 when viewing the node as a teaser.
	
	Gallery Landing Page Setting:
    		Choose thumbnails or thumbnails that open a lightbox2 gallery.
	
    -- Image Upload Limitation Default Settings: --

	Default permitted file extensions:
    		Specify allowed file types ( jpg jpeg png )
		 (do not use a dot, just a space between each)

	Maximum resolution for uploaded images:
    		Specify (width x height) in pixels. (use 0 for no limit,
		 if there is trouble with uploads check this)

	Default maximum file size per upload:
    		Specify a number in MB (calculated after 
		ImageCache Preset re-sizes the files)

	Default total file size per user:
    		Specify a number in MB (combined total size of all
		 files a user is allowed to have in the system)

	Default total file number per user:
    		Specify a number. (combined total number of files
	  	each user is allowed to have in the system)

   -- Image Upload Limitation Settings for user roles: --
		note: This will not be visible until permissions have been set.
		Each user role will have the following settings.

       Default maximum file size per upload:
          	Specify a number in MB (calculated after ImageCache
		 Preset resize's the files)

       Default total file size per user:
          	Specify number in MB (combined total size of all files
		 a user is allowed to have in the system)

       Default total file number per user:
          	Specify a number (combined total number of files each user
		is allowed to have in the system) 	
	

	SUBMIT AFTER CHANGING SETTINGS


CREATE A NEW GALLERY RELATIONSHIP
---------------------------------
  1. Create a content type for the gallery 
	 	WARNING: do not re-use a gallery content type,
	 	as it will over write the relationship that uses it.

  2. Create an image content type -or- plan to re-use an existing one.

  3. Create 3 image cache presets or plan on re-using existing ones.
	 	one for cover, thumbnail and image.

  4. Set permissions for the new and/or re-used content types.

  5. Set permissions for the 3 new and/or re-used ImageCache presets.

  6. Goto: Administer > Site configuration > Node Gallery > Add a
 	Gallery Relationship

  7. Select the gallery and image content types. Click "Next"

  8. Configure the new gallery relationship. (as in the above section)

  9. The Image content type needs to be removed from the create content list.
	Goto: Administer > Site building > Menus
	Click on the Navigation menu to open it.
	Locate the Image content type and un-check it and "Save" 
 
   A new custom made node gallery has been created.


HANDBOOK LINKS
--------------
 Node Gallery Handbook		http://drupal.org/node/544050

 Install Node Gallery		http://drupal.org/node/544242

 Create & Edit a Gallery	http://drupal.org/node/544530

 Configure Node Gallery		http://drupal.org/node/544642

 Add a Gallery Relationship	http://drupal.org/node/544710

 Style, Views & Theming		http://drupal.org/node/544748

 FAQ for Node Gallery		http://drupal.org/node/544760

 Trouble shooting node_gallery	http://drupal.org/node/584170

 Websites Using Node Gallery	http://drupal.org/node/547788


DRUPAL LINKS
------------
 Project Page	http://drupal.org/project/node_gallery

 Drupal Forum	http://drupal.org/forum/22

 Issue Queue	http://drupal.org/project/issues/node_gallery 


CREDITS
-------
 Authored by Wilson Wu(wilson98); < martic98@gmail.com >

 Co-maintained by Kevin Montgomery(Kmonty); New Eon Media < http://neweonmedia.com >


END OF FILE
-----------

File

README.txt
View source
  1. NODE GALLERY MODULE
  2. -------------------
  3. CONTENTS
  4. --------
  5. * Description
  6. * Features
  7. * Requirements
  8. * Contributed Modules
  9. * Un-Install Notes
  10. * Items Created at Install
  11. * Installation
  12. * Create a Gallery
  13. * Edit a Gallery
  14. * Additional Configurations
  15. * Edit a Gallery Relationship and Configurations
  16. * Create a Gallery Relationship
  17. * Handbook Links
  18. * Drupal Links
  19. * Credits
  20. DESCRIPTION
  21. -----------
  22. The node gallery image management system provides administrators with a
  23. flexible and powerful image gallery. Administrators can designate the content
  24. type to be used for the "Gallery" node, and the content type to be used for
  25. the "Image" node. Since the "Image" and the "Gallery" are both node or
  26. content types, they can use many of Drupal's contributed modules to enhance
  27. the galleries. Upon installation, the required settings are automatically
  28. created so users can start posting galleries right away. Website users can
  29. upload "Images" into a "Gallery", edit them within the "Gallery" and delete
  30. them if needed.
  31. FEATURES
  32. --------
  33. - Naturally integrated with Drupal Taxonomy, Comments, Path, Pathauto,
  34. Views, Token, VotingApi, Fivestar, CCK(Content Construction Kit),
  35. Custom breadcrumbs, ImageCache, ImageAPI, Nodewords
  36. and many other contributed modules.
  37. - Use Drupal's core batch system to do operations such as uploading, editing
  38. etc.
  39. - Theme or customize galleries with CSS and tpl.php files included with the
  40. system.
  41. - Everything you can do with nodes you can do to your gallery and images.
  42. - Unlimited user albums
  43. - Set image size, maximum number of images and upload limits for each Drupal
  44. role.
  45. - Set image storage location and use custom tokens to help if desired.
  46. - 4 custom tokens included to enhance and control the galleries.
  47. - Lightbox2 contributed module integration with lighbox2 slide show.
  48. - Titles, Descriptions, Captions and Image counts.
  49. - Drag handle image sorting and field sorting for submission forms.
  50. - Previous/Next pagers
  51. REQUIREMENTS
  52. ------------
  53. * ImageCache module http://drupal.org/project/ImageCache
  54. * ImageAPI module http://drupal.org/project/ImageAPI
  55. CONTRIBUTED MODULES
  56. -------------------
  57. * Lightbox2 module http://drupal.org/project/lightbox2
  58. ADD-ON MODULES
  59. -------------------
  60. * Node_gallery_access module http://drupal.org/project/node_gallery_access
  61. Control gallery access to public, private or password.
  62. IMPORTANT UN-INSTALL NOTES
  63. --------------------------
  64. The three ImageCache presets created by the Node Gallery module
  65. will be deleted if you disable the Node Gallery module, so it is recommended
  66. that you only use these presets with Node Gallery. However, if you modify the
  67. Node Gallery presets, they will be saved into the system and continue to exist
  68. without regard to the Node Gallery module being enabled.
  69. ITEMS CREATED AT INSTALL TIME
  70. -----------------------------
  71. 1. Two node types; one for galleries and one for gallery images.
  72. 2. Three ImageCache presets; for cover, display, and thumbnail.
  73. 3. One node gallery relationship; linking the gallery node with the
  74. gallery image nodes.
  75. INSTALLATION
  76. ------------
  77. 1. Download node_gallery, ImageAPI, and ImageCache.
  78. 2. Unzip or unpack the modules on your computer.
  79. 3. Upload the module folders with all the contents (as is) to the
  80. sites/all/modules folder.
  81. 4. Goto: Administer > Site configuration > Clean URLs
  82. Enable clean URLs (required for ImageCache to work).
  83. 5. Goto: Administer > Site building > Modules
  84. Enable Node Gallery, ImageAPI, ImageAPI GD2, ImageCache, ImageCache UI,
  85. Node Gallery Lightbox2 Integration (if needed), and Node Gallery Access (if
  86. needed).
  87. 6. Save the settings to install (updates the database).
  88. 7. Goto: Administer > User management > Permissions
  89. Configure the Permissions for:
  90. -ImageCache module-
  91. view ImageCache node-gallery-cover
  92. view ImageCache node-gallery-display
  93. view ImageCache node-gallery-thumbnail
  94. -node module-
  95. access content
  96. administer nodes(use with caution)
  97. create node_gallery_gallery content
  98. create node_gallery_image content
  99. delete any node_gallery_gallery content
  100. delete any node_gallery_image content
  101. delete own node_gallery_gallery content
  102. delete own node_gallery_image content
  103. edit any node_gallery_gallery content
  104. edit any node_gallery_image content
  105. edit own node_gallery_gallery content
  106. edit own node_gallery_image content
  107. - node_gallery module -
  108. view node gallery
  109. At this point, users can create galleries.
  110. CREATE A GALLERY
  111. ----------------
  112. 1. Goto: Create content > Gallery
  113. 2. Name the gallery
  114. 3. Provide a description for the gallery if desired.
  115. 4. Click "Save"
  116. 5. Click "Upload some images!"
  117. 6. Browse and choose images.
  118. 7. Click "Submit Files"
  119. 8. Add a caption to each image if desired.
  120. 9. Choose a cover image using the radio buttons on the right.
  121. 10. Drag sort the order of images.
  122. 11. Click "Submit"
  123. 12. View your gallery.
  124. EDIT A GALLERY
  125. --------------
  126. 1. Login and Goto: your gallery
  127. 2. Click: Edit gallery, Upload images, Manage images or Delete Gallery
  128. ADDITIONAL CONFIGURATIONS
  129. -------------------------
  130. Configurations for a gallery relationship.
  131. (See the next section below, Edit a gallery relationship.)
  132. Configure the number of Albums on gallery list pages and the
  133. number of images on each thumbnail page.
  134. Goto: Administer > Site configuration > Node gallery > Common settings
  135. Configure Gallery or Album submission form.
  136. Goto: Administer > Content management > Content types > Edit gallery
  137. Configure Gallery Image submission form.
  138. Goto: Administer > Content management > Content types > Edit gallery image
  139. Configure node gallery access.
  140. Goto: Administer > Site building > Modules > List
  141. Enable Node Gallery Access module to use this function.
  142. Customize galleries with css, views or tpl.php files.
  143. The node gallery handbook has more information about views and css.
  144. Customize paths and/or URLs with 4 custom node_gallery Tokens.
  145. [parent-node-gallery-path] The path of the parent Gallery.
  146. [parent-node-gallery-path-raw] Unfiltered path of the parent Gallery.
  147. [parent-node-gallery-title] The title of the parent Gallery.
  148. [parent-node-gallery-title-raw] Unfiltered title of the parent Gallery.
  149. Customize the ImageCache presets.
  150. Goto: Administer > Site building > ImageCache > List
  151. Add new, Configure, Edit and/or Delete the Presets as desired for
  152. each part of the gallery. Add new presets or reuse existing
  153. presets when Adding Gallery Relationships.
  154. Customize Lightbox settings.
  155. Goto: Administer > Site configuration > Lightbox2
  156. GD2 image quality setting.
  157. Goto: Administer > Site configuration > ImageAPI > Configure
  158. EDIT A GALLERY RELATIONSHIP AND/OR CONFIGURATIONS
  159. -------------------------------------------------
  160. 1. Goto: Site configuration > Node gallery > List
  161. Click "Edit" next to the gallery relationship which will open the
  162. first configuration page.
  163. 2. The first configuration page has the content type settings.
  164. Select the content types to be used for the "Gallery" and the
  165. "Image" types.
  166. To edit the gallery configurations, go to the
  167. bottom of the page and click next. Clicking "Next" will
  168. open the second configuration page.
  169. 3. The second configuration page has the detailed gallery
  170. configurations.
  171. Gallery Type Name:
  172. The name to show on create content page.
  173. Gallery Directory:
  174. Set the directory to hold images inside sites/default/files
  175. - sites/default/files/[name or token]/[name or token] -
  176. Default Cover Image:
  177. Specify a default cover image to show when there
  178. are no images in the gallery.
  179. Number of uploads:
  180. Select the number of upload buttons(fields)
  181. for images on each upload page. Use caution when
  182. adding more than 4 or 5 as php.ini settings may
  183. need to be changed.
  184. Fields:
  185. Specify the fields to show(check boxes).
  186. Title, caption, revision info, comment settings, path settings.
  187. Choose the content you want to display:
  188. Specify the description text to be used when displaying image pages.
  189. Choose gallery description (or) image description.
  190. Image Comment Setting:
  191. Specify the comment setting to use. (Image or gallery)
  192. as per setting in the content type.
  193. Images Sizes:
  194. Select which ImageCache Preset to use for each
  195. image display(cover, thumbnail, display).
  196. Original Image Display:
  197. Set the option to allow viewing full sized image
  198. disabled, with a link or lightbox2 pop-up.
  199. Teaser setting:
  200. Specify how to display the gallery and image
  201. when viewing the node as a teaser.
  202. Gallery Landing Page Setting:
  203. Choose thumbnails or thumbnails that open a lightbox2 gallery.
  204. -- Image Upload Limitation Default Settings: --
  205. Default permitted file extensions:
  206. Specify allowed file types ( jpg jpeg png )
  207. (do not use a dot, just a space between each)
  208. Maximum resolution for uploaded images:
  209. Specify (width x height) in pixels. (use 0 for no limit,
  210. if there is trouble with uploads check this)
  211. Default maximum file size per upload:
  212. Specify a number in MB (calculated after
  213. ImageCache Preset re-sizes the files)
  214. Default total file size per user:
  215. Specify a number in MB (combined total size of all
  216. files a user is allowed to have in the system)
  217. Default total file number per user:
  218. Specify a number. (combined total number of files
  219. each user is allowed to have in the system)
  220. -- Image Upload Limitation Settings for user roles: --
  221. note: This will not be visible until permissions have been set.
  222. Each user role will have the following settings.
  223. Default maximum file size per upload:
  224. Specify a number in MB (calculated after ImageCache
  225. Preset resize's the files)
  226. Default total file size per user:
  227. Specify number in MB (combined total size of all files
  228. a user is allowed to have in the system)
  229. Default total file number per user:
  230. Specify a number (combined total number of files each user
  231. is allowed to have in the system)
  232. SUBMIT AFTER CHANGING SETTINGS
  233. CREATE A NEW GALLERY RELATIONSHIP
  234. ---------------------------------
  235. 1. Create a content type for the gallery
  236. WARNING: do not re-use a gallery content type,
  237. as it will over write the relationship that uses it.
  238. 2. Create an image content type -or- plan to re-use an existing one.
  239. 3. Create 3 image cache presets or plan on re-using existing ones.
  240. one for cover, thumbnail and image.
  241. 4. Set permissions for the new and/or re-used content types.
  242. 5. Set permissions for the 3 new and/or re-used ImageCache presets.
  243. 6. Goto: Administer > Site configuration > Node Gallery > Add a
  244. Gallery Relationship
  245. 7. Select the gallery and image content types. Click "Next"
  246. 8. Configure the new gallery relationship. (as in the above section)
  247. 9. The Image content type needs to be removed from the create content list.
  248. Goto: Administer > Site building > Menus
  249. Click on the Navigation menu to open it.
  250. Locate the Image content type and un-check it and "Save"
  251. A new custom made node gallery has been created.
  252. HANDBOOK LINKS
  253. --------------
  254. Node Gallery Handbook http://drupal.org/node/544050
  255. Install Node Gallery http://drupal.org/node/544242
  256. Create & Edit a Gallery http://drupal.org/node/544530
  257. Configure Node Gallery http://drupal.org/node/544642
  258. Add a Gallery Relationship http://drupal.org/node/544710
  259. Style, Views & Theming http://drupal.org/node/544748
  260. FAQ for Node Gallery http://drupal.org/node/544760
  261. Trouble shooting node_gallery http://drupal.org/node/584170
  262. Websites Using Node Gallery http://drupal.org/node/547788
  263. DRUPAL LINKS
  264. ------------
  265. Project Page http://drupal.org/project/node_gallery
  266. Drupal Forum http://drupal.org/forum/22
  267. Issue Queue http://drupal.org/project/issues/node_gallery
  268. CREDITS
  269. -------
  270. Authored by Wilson Wu(wilson98); < martic98@gmail.com >
  271. Co-maintained by Kevin Montgomery(Kmonty); New Eon Media < http://neweonmedia.com >
  272. END OF FILE
  273. -----------