Index: openacs-4/packages/photo-album/www/doc/acs-admin-guide.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/photo-album/www/doc/acs-admin-guide.adp,v diff -u -r1.2 -r1.3 --- openacs-4/packages/photo-album/www/doc/acs-admin-guide.adp 26 Aug 2015 18:03:35 -0000 1.2 +++ openacs-4/packages/photo-album/www/doc/acs-admin-guide.adp 12 Sep 2016 06:08:01 -0000 1.3 @@ -11,21 +11,22 @@
Installation and Operation Notes
-Imagemagick The convert -and identify binaries must be installed within the location +Imagemagick The +convert and identify binaries must be installed within the location specified by the parameter ImageMagickPath. The user that the webserver is running under must have execute privileges for the files. A link to a download page for ImageMagick can be found in the design document.
-Image Storage Directory -The photo album store image binaries in the file system. The -webserver user must have read, write, and execute privileges for -the directory specified in the parameter PhotoDir. This directory -must be in the acs root directory for the server. The webserver -user must also have write privilege on any file created in this -directory or it will not be able to delete images.
-Permission Checks for -Serving Images The parameter CheckPermissionOnImageServeP +Image Storage +Directory The photo album store image binaries in the file +system. The webserver user must have read, write, and execute +privileges for the directory specified in the parameter PhotoDir. +This directory must be in the acs root directory for the server. +The webserver user must also have write privilege on any file +created in this directory or it will not be able to delete +images.
+Permission Checks for +Serving Images The parameter CheckPermissionOnImageServeP controls if images/index.vuh queries the database to check if user has read permission on a photo prior to serving it. Setting this to true will slow server performance because it causes an extra trip @@ -44,7 +45,8 @@
Photo Album | |||
---|---|---|---|
Prev | Chapter 4. -Developer's guide | +Developer's guide |
The display, grouping, and administration functionality of the +within the instance (as long as the subsite url isn't +changed).
The display, grouping, and administration functionality of the photo album package will be included in the initial release of the package. This is intended to be one part of a larger system that will allow bulk uploading and purchasing of photos. These two @@ -104,9 +105,9 @@ general system for storing and displaying user uploaded photos, which can be customized to any particular client application.
Not done. A google search for "photo album web application" -returns links for several shareware photo album applications. I did -not install or test any of these.
+Not done. A google search for "photo album web +application" returns links for several shareware photo album +applications. I did not install or test any of these.
The package uses/requires the convert and identify ImageMagick binaries to be installed on the host computer at the location specified in the ImageMagickPath @@ -266,7 +267,7 @@ pa_photo.delete deletes a pa_photo object, all revision of a pa_photo, and all associated pa_images (including binaries). Basically nukes a photo, -so be careful using this one, because it can't be undone.
+so be careful using this one, because it can't be undone.procedure delete ( item_id in acs_objects.object_id%TYPE @@ -356,43 +357,51 @@ currently implemented as tcl procedures.
pa_get_root_folder -{package_id ""} Returns the folder_id of the root folder for -an instance of the photo album system. If no root folder exists, as -when a new package instance is accessed for the first time, a new -root folder is created automatically with appropriate permissions -If value has be previously requested, value pulled from cache. If -pakage_id is not specified, procedure uses value from [ad_conn package_id] +{package_id ""} Returns the folder_id of the root +folder for an instance of the photo album system. If no root folder +exists, as when a new package instance is accessed for the first +time, a new root folder is created automatically with appropriate +permissions If value has be previously requested, value pulled from +cache. If pakage_id is not specified, procedure uses value from +[ad_conn package_id]
pa_context_bar_list {-final ""} item_id Constructs the list to be fed to ad_context_bar appropriate for item_id. If -final is specified, that string will be the last item in the context bar. Otherwise, the name corresponding to item_id will be used.
pa_make_file_name -{-assert:boolean} {-ext ""} id Constructs a filename for an -image based on id and extention. Files are created into a 3 tier -directory structure: year/xx/zz/ for a photo_id 1234xxzz.jpg Same -file would return year/xx/zz/1234xxzz.jpg. If -assert specified, -proc creates directory and any parent directories if necessary
+{-assert:boolean} {-ext ""} id Constructs a filename +for an image based on id and extention. Files are created into a 3 +tier directory structure: year/xx/zz/ for a photo_id 1234xxzz.jpg +Same file would return year/xx/zz/1234xxzz.jpg. If -assert +specified, proc creates directory and any parent directories if +necessary
pa_is_folder_p -folder_id {package_id ""} Returns "t" if folder_id is a folder -that is a child of the root folder for the package, else "f". If -package_id is not given procedure uses value from - [ad_conn package_id].
+folder_id {package_id ""} Returns "t" if +folder_id is a folder that is a child of the root folder for the +package, else "f". If package_id is not given procedure +uses value from + [ad_conn +package_id].
pa_is_album_p -album_id {package_id ""} Returns "t" if album_id is a album -that is a child of the root folder for the package, else "f" If -package_id is not given procedure uses value from - [ad_conn package_id].
+album_id {package_id ""} Returns "t" if +album_id is a album that is a child of the root folder for the +package, else "f" If package_id is not given procedure +uses value from + [ad_conn +package_id].
pa_is_photo_p -photo_id {package_id ""} Returns "t" if photo_id is a photo -that is a child of the root folder for the package, else "f" If -package_id is not given procedure uses value from - [ad_conn package_id].
+photo_id {package_id ""} Returns "t" if +photo_id is a photo that is a child of the root folder for the +package, else "f" If package_id is not given procedure +uses value from + [ad_conn +package_id].
pa_grant_privilege_to_creator object_id {user_id -""} Grants a set of default privileges stored in parameter -PrivilegeForCreator on object id to user_id. If user_id is not -specified, uses current user.
+""} Grants a set of default privileges stored in +parameter PrivilegeForCreator on object id to user_id. If user_id +is not specified, uses current user.
pa_image_width_height filename width_var height_var Uses ImageMagick program to get the width and height in pixels of filename. Sets height to the variable named in @@ -507,19 +516,23 @@
Description: List of grantee privilege pairs for new root folders. Grantee is an integer or function that -returns a party_id. Format as a space separated list
Default: acs.magic_object_id('the_public') read +returns a party_id. Format as a space separated list
Default: +acs.magic_object_id('the_public') read acs.magic_object_id('registered_users') pa_create_album -acs.magic_object_id('registered_users') pa_create_folder
+acs.magic_object_id('registered_users') +pa_create_folderDescription: If set to "t", users are presented -a link to display the full sized base image from photo page.
Default: t
+Description: If set to "t", users are +presented a link to display the full sized base image from photo +page.
Default: t
If set to "t", the images/index.vuh file runs a -query to check if user has read access to photo prior to serving -it. Note, setting to "t" can impact performance on high volume -sites. The urls for images also change depending on this parameter. -If "t" url contains the pa_image_id, else contains the path to the -pa_image in file-system.
Default: f
+If set to "t", the images/index.vuh +file runs a query to check if user has read access to photo prior +to serving it. Note, setting to "t" can impact +performance on high volume sites. The urls for images also change +depending on this parameter. If "t" url contains the +pa_image_id, else contains the path to the pa_image in +file-system.
Default: f
The display, grouping, and administration functionality of the +within the instance (as long as the subsite url isn't +changed).
The display, grouping, and administration functionality of the photo album package will be included in the initial release of the package. This is intended to be one part of a larger system that will allow bulk uploading and purchasing of photos. These two @@ -121,11 +122,12 @@ Most of the images were scanned from the negatives at processing time making it easy for the couple to obtain digital versions of their photographs. The couple creates a new photo album for their -wedding, and then adds the following folders: "Engagement photo -shoot," "Rehearsal dinner," "Ceremony," "Reception," and -"Honeymoon." The honeymoon itself was spent in two different -places. The couple creates subfolders for each of these places in -their Honeymoon folder.
Now the folder hierarchy looks like:
+wedding, and then adds the following folders: "Engagement +photo shoot," "Rehearsal dinner," +"Ceremony," "Reception," and +"Honeymoon." The honeymoon itself was spent in two +different places. The couple creates subfolders for each of these +places in their Honeymoon folder.Now the folder hierarchy looks like:
- Wedding - Engagement Photo Shoot @@ -145,12 +147,12 @@ parents can upload additional photos to those folders or modify the attributes of any given photo.
The administrator of the "Dogs of the World" subsite on the "All -Furry Creatures" web sites wants to provide a way to show pictures -of various dog breads. Since the admin is a busy person she doesn't -want to upload and manage all of the images herself. She does, -however, want to specify the general layout of the various albums -and control who can upload images.
She creates an instance of the photo album within her subsite. +
The administrator of the "Dogs of the World" subsite +on the "All Furry Creatures" web sites wants to provide a +way to show pictures of various dog breads. Since the admin is a +busy person she doesn't want to upload and manage all of the +images herself. She does, however, want to specify the general +layout of the various albums and control who can upload images.
She creates an instance of the photo album within her subsite. Then goes about creating a folder structure such as:
- Dogs of the World @@ -178,12 +180,12 @@4.1.5. Related Links
System/Package "coversheet"
User's guide
Test plan
+Developer's Guide
User's guide
Test plan
IluvCamp photo albums (Call or email me for log in information)
Competitive system(s)
VI.D.30 Admin can edit other people's +
VI.D.30 Admin can edit other people's albums.
VI.D.40 Admin designates default permissions for hierarchy levels. So various users can view, create, edit, and upload to different levels.
VI.D.50 Admin can allow user to access the page Index: openacs-4/packages/photo-album/www/doc/index.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/photo-album/www/doc/index.adp,v diff -u -r1.3 -r1.4 --- openacs-4/packages/photo-album/www/doc/index.adp 26 Aug 2015 18:03:35 -0000 1.3 +++ openacs-4/packages/photo-album/www/doc/index.adp 12 Sep 2016 06:08:01 -0000 1.4 @@ -8,12 +8,12 @@ Tom Baginski
bags\@arsdigita.com