glFusion Wiki

Site Tools


glfusion:mediagallery:albums

Albums

Albums are the containers in Media Gallery that hold your media items. Albums can also hold other albums, called sub-albums. Each album has a unique set of properties that control how it looks and also how it will handle various media objects.

Album Configuration Options

The album configuration will control many aspects of how Media Gallery will work. The album configuration will control who can view the album, what type of media it can hold, who can upload to it, how the media will be presented and what features and functions will be available. Understanding all the different configuration options is very important since they play a very important role in the overall media presentation.

Album Attributes

Album attribute configuration options control which features are available in the album and also how the album will be displayed.

Album Theme

Each album can use its own set of templates to create a unique look. Media Gallery comes with the following themes:

Theme Description
default The standard Media Gallery look and feel.
clean This theme uses a very clean interface that only shows a few of Media Gallery's options. Only the media title and views display below the thumbnail. The media view screen is very basic with the administrative menus at the bottom of the screen.
simpleviewer This theme uses a Flash control to provide an interactive method to display the album media.
lightbox This is the standard Media Gallery theme that uses a Light Box to display the full media view.
podcast This theme is designed to showcase and display MP3 media or other audio / video media. It is a single column theme that shows the thumbnail to the left with the item description to the right.

You can easily create your own custom themes. See the creating_a_theme section for more details.

Allow Comments

If this is enabled, users will be able to post comments on the media items contained in this album.

Enable EXIF

If this is enabled, users will be able to view the embedded EXIF/IPTC data of the JPG images. You can disable EXIF processing, or you can have it display below the media item or in a pop-up window. Also, you can control what EXIF/IPTC meta data is displayed by configuring the EXIF options located in the Media Gallery Administration screen.

Enable Rating

You can select whether you want to enable ratings on your media items. Valid options are:

  • Disabled - No rating features.
  • Members Only - Only logged in users can rate a media item.
  • Always - Anyone can rate media items.
You will not be able to rate media items that you uploaded. Also, once you have rated a media item, you will not be allowed to rate it again.

Enable Album RSS Feed

If this is enabled, a RSS feed for the album will be created / updated each time you add or remove media to this album. The RSS icon will appear to the right of the album name. This allows your site users to subscribe to the RSS feed and keep up with any changes to the album.

Permissions are not checked when a user views the RSS feed. If you have a protected album and enable the RSS feed, anyone who knows the feed name can view the feed.

Podcast RSS Feed

If you have enabled the RSS feed for an album, you can select this option to add the necessary information to the RSS feed so it can be read as a Podcast feed in readers such as iTunes.

This option no longer controls the look and feel of the album as it did in previous Media Gallery releases.

Include Sub-Albums in RSS Feed

Selecting this option will include all sub-albums in the parent albums RSS feed. If this option is not selected, the RSS Feed will only contain the items in this album.

MP3 Ribbon Player

If this option is enabled, any MP3 media in the album will have a small Flash Media Player (Ribbon Player) embedded below the thumbnail.

Enable Client Side Sorting

If this is enabled, a sort drop down menu will appear in the lower right hand corner. This will allow your site users to sort the media items to meet their preferences. Note, this only sorts the display of thumbnails for the user, it does not alter the sort options you specified in the album configuration.

Default Album Sort on Upload

By default, all media items in an album are sorted by upload time, with the newest always displaying first. By selecting a new sort order, each time a media item is uploaded, the contents of the album will be resorted using the order you specify here. This will become the default sort order that the album will use.

Enable Postcards

Postcards allow your site users to send a media item to family or friends with a short note. This can be a great tool to help your users advertise your site. Postcards can be completely disabled, enabled only for logged-in users or enabled for all users.

Please use caution when you make your choice, postcards could also be abused and used for spamming if you allow anyone to send them. As a protection against misuse, Media Gallery supports enabling a CAPTCHA string on postcard creation.

See the section on Postcards for more details on this feature.

Display Album Description

If this option is enabled, the album description will display just above the first line of thumbnails.

Display Album Views Counter

If this option is enabled, the number of times an album has been viewed or entered will be displayed on the main Media Gallery index page and for any sub-albums in the album.

If you are the owner of the album or have the mediagallery.admin attribute, your browsing will not increment this counter.

Display Media Views Counter

If this option is enabled, each thumbnail will show the number of times the item has been viewed.

If you are the owner of the media item or have the mediagallery.admin attribute, your browsing will not increment this counter.

Enable Keywords

Each media item can have a set of keywords associated with it. These are primarily used to improve searching. If this option is enabled, the keywords will be displayed below the thumbnail image.

Image / Display / Album Skin

The frame around each image / thumbnail in the album is specified here. Media Gallery supports several different frames.

  • Image Frame is displayed with the thumbnail
  • Display Frame is displayed with the Display Image (Media Item View)
  • Sub-Album frame is displayed for all sub-albums in this album.

List Sub-Albums Before Images

This specifies if any sub-albums should be listed before the media items or after. If enabled, all sub-albums will be displayed before the media items are displayed. If disabled, the sub-albums will be listed after all the media items.

Thumbnail Size

Determines the size of the thumbnails for the album. There are three choices:

  • Small (100×100 pixels)
  • Medium (150×150 pixels)
  • Large (200×200 pixels)

Audio / Video Playback Options

When a user selects to listen to or view an audio / video file, you can specify a few options on how you will play this file.

  • Play in Pop up Window - This option will open a pop up window and play the audio / video file on the users computer using either Microsoft Media Player, QuickTime, or Flash Player.
  • Download to local computer - This option will simply place a direct link to the audio / video file so the file will attempt to download to the user's computer. Generally, the local browser will recognize the mime type and will try to launch the appropriate player on the user's system.
  • In line - This option is similar to option 1, but it will not create a pop up window, instead it will attempt to play the audio / video file using either Microsoft Media Player, QuickTime, or Flash in a window in the Media View.
  • Use mms:// links for Microsoft supported media. This option will preface the audio / video link with 'mms://' which directly calls the Microsoft Media Player. Media Gallery will attempt to determine if the audio / video type is supported by the Microsoft Media Player, if not, it will use a direct download link instead.

Enable Slideshow

For media items in the album, Media Gallery can display them as a slideshow. There are three types of slideshows in Media Gallery:

  • JavaScript - This is the standard slideshow that is full featured and works with most browsers.
  • LightBox - Although this is listed as a slideshow, the user must manually scroll through the images. Lightbox refers to the display method, the screen will be darkened and the image will 'explode' open.
  • Flash Based - This is an experimental Flash based slideshow that will allow Full Screen viewing. This code is still in the early stages of development.

If you do not want to have a slideshow feature for the album, choose Disabled.

Display Rows / Columns

This determines the number of rows / columns of thumbnails per page.

Album Cover

By default, Media Gallery will use the most recent thumbnail as the album cover.

You also have the option of uploading an image to be used as the album cover. By selecting the Attached Thumbnail checkbox and specifying the image to upload in the Thumbnail input, you can add the album cover. When you attach a thumbnail to the album, that image will always be used as the album cover.

Media Gallery also allows you to specify one of the images in the album to be the album cover as well, instead of using the most recently added item. This is configured in the Manage Media screen.

Albums can also be featured and configured to show on the front page, specific topic or all pages. To feature an album, simply check the Set as Featured box and select where it should be displayed. Media Gallery will not show a featured album to a user who does not have the privileges to see that album.

You can have more than one featured album. For example, you could have a different featured album for each Topic on your glFusion system.

Media Handling Options

Each album can have specific options for displaying or handling media within the album.

Use Filename as Caption

If this is enabled, each time a media item is uploaded, if no caption has been entered, the media items filename will be used in the caption field.

Media Gallery supports an integration with DigiBug, an online photo printing service. By enabling this option, a new link/icon will appear in the lower right hand corner of the media view. This link will add the photo to the DigiBug shopping cart.

For full details on the Online Printing feature, see the Online Printing Section.

Allow Media Download

Enabling this option will add a Download link to the media item view screen. This will allow your site users to easily download the media item to their local system.

Display Full (original) Image

You can restrict or disable the ability for your users to view the originally uploaded image. The options are:

  • Always - Allow anyone to view the originally uploaded image
  • Members Only - Only allow logged-in users to view the originally uploaded image
  • Disabled - Disable the ability for anyone to view the originally uploaded image

Include in Random Image Block

This option specifies whether the image media from this album should be included in the site's Random Image block.

Only users with the mediagallery.admin attribute may change this setting.

Maximum Image Width / Height

You can control the maximum resolution of images placed into the album. If you specify values for both width and height, any image media which is of higher resolution will automatically be resized to these limits.

If you do not wish to limit the resolution, place a zero (0) in both fields.

Maximum Allowed File Size

You can also restrict the maximum file size allowed in this album. By specifying the maximum size in kilobytes (Kb) you will limit the ability to upload any media larger than this size. Any item which exceeds this size will be discarded and an error message stating the file is too big will be displayed after the upload.

If you do not wish to restrict the file size, place a zero (0) in this field.

Display Image Size

You must specify the size of the Display Image (the image that is shown when viewing the media item). Media Gallery has several pre-defined sizes and also the ability for you to add a custom size (see Media Gallery Administration).

When the image media is uploaded, Media Gallery will create the display image using the size specified here.

If you change the Display Image Size after you have already added images to an album, those existing image items will not automatically be resized. This setting will only affect any new image items uploaded. To resize the existing items, see the Media Gallery Administration section.

Watermarking Options

Each album can enable or disable watermarking. Also, each album can have a unique watermark image and location. To enable watermarking, select the checkbox for Automatically Watermark on Upload.

Watermark Opacity

This specifies the transparency used by the watermark image. The lower the number, the lighter the watermark image will be on the original image. The higher the number, the darker the watermark will appear.

Watermark Location

This specifies where on the image media the watermark should be placed.

Watermark Image

You must select an existing watermark image to apply to newly uploaded image files.

Changing these values do not affect media items already uploaded to the album, these settings only apply to newly uploaded image media.

For full details on Media Gallery's Watermarking features, see the Watermarking Section.

Allowed Media Types

Each album can be configured to only accept a certain type of media. If you create an album that should only contain music (i.e. MP3 files), you can make MP3s the only allowed media type. Any other type of media that is uploaded to this album will result in an error to the user informing them that the media type is not allowed.

The list of allowed media types are:

Image Audio / Video Other
JPEG MP3 ZIP
PNG OGG Any Other Type
TIF WMV
GIF SWF
BMP MOV
TGA MP4
PSD MPEG
FLV
Remove FLV
Embedded Video

For more information on the different media types, see the Support Media Types section.

User Uploads

By default, only the album owner or a user with write permissions can upload media items. User uploads allows you to open the album for contributions from regular site users.

Allow Registered Users to Upload Media to this Album

If this feature is enabled, any logged-in users to the site will have the ability to upload media items to this album. If this is not checked (disabled), only users with write permissions to the album will be able to upload new items.

Turn on Moderation for this Album

Moderation allows you to store any new uploads by logged-in users into a temporary holding space where they can be reviewed and either approved for inclusion in the album or rejected and deleted. Moderation is a great tool to ensure only appropriate media items are added to your album by your user community.

By enabling this option you will force all new media items uploaded by logged-in users to be redirected to the moderation queue.

This option is only valid if you have Allow Registered Users to Upload Media to this Album enabled.

Moderator Group

If you have enabled moderation for this album, select the group of users who will be responsible for reviewing and approving media submissions.

Email Moderators on Submission

If this option is enabled, all members of the moderator group will be notified via email when new media items have been uploaded. Media Gallery tries to keep from flooding the inbox of the moderators, so if a user uploads 10 media items in a very short period of time, only one moderator email will be sent.

For more details on Media Gallery's moderation capabilities, see the Moderation Section.

Permissions

Media Gallery supports the glFusion security model, using Owner, Group, Logged-In and Anonymous permissions for each album. Media Gallery does not support permissions to the media item level, but instead the album level.

Media Gallery supports a single global permission, whether or not to allow non-logged-in users access to your albums. If you set the Configuration Option, Login Required to Yes, then only registered site users can view your albums, regardless of the album's individual permissions.

Each album has a set of permissions associated with it, these permissions determine who can view, edit or add media to the album. The permissions are:

User Read Permission Edit Permission
Owner Read Edit
Group Read Edit
Logged-In User Read Edit
Anonymous Read

Definitions are as follows:

AttributeDescription / Definition
OwnerEach album has an owner; it is the user who created the album. Owners will always have READ / EDIT permissions.
GroupEach album has a group owner, this is the glFusion group that has ownership of the album. Group Owner can have either READ permission or READ/EDIT permission.
Logged-In User (Members)This is any user who has a login account on your site and is logged-in. Logged-in users can only have READ permission or no permission to view the album.
Anonymous UserThis is any user who has not logged into your site. Anonymous users can only have READ permission or no permission to view the album.
Read PermissionAllows the user to view the contents of the album.
Edit PermissionAllows the user to edit the album attributes (name, description, security permissions, etc.) and upload media to the album.

Force Child Update

If you change the permissions of an album and it contains sub-albums, you can force Media Gallery to set the exact same permissions on all sub-albums by selecting this option.

Creating an Album

To create an album in Media Gallery, select the Create Album option from the Options drop down menu. Each album has a set of configuration attributes that control how the album will be displayed, options for media presentation, and access rights.

Editing an Album

In the album view screen (you must be viewing the album you wish to edit), there is also an Administration Drop down menu, this is where you select to Edit an existing album. The edit screen is identical to the create screen and allows you to modify the settings of an album and also change the parent album (effectively moving the album to another parent).

If the album you are editing contains sub-albums, you have the option of forcing all children albums to have the exact same permissions as the parent. If you choose to do this, check the check box labeled: Force Child Update.

Deleting Albums

An album can be deleted by selecting the Delete button in the album edit screen. If you select to delete an album, you will be given the option to move all sub-albums and media to another album or delete them. If you choose to have all the contents deleted, it is permanent, there is no undo function and all the media and sub-albums will be removed.

There is a Batch Delete Albums function available in the Media Gallery Administration screen. This will present a list of all albums and allow you to select which ones to delete. There is no option to move the contents of the albums when using the Batch Delete Albums function, all media items and sub-albums will be permanently deleted. Please use this feature with caution!

Sorting Albums

From the Gallery View Screen, there is an option to sort your albums. This will control the presentation of your albums to your site users. Albums are sorted in descending order, meaning the album with the highest order value is listed first.

Select Sort Albums from the Options drop down menu and you will be presented with a list of all your albums. To sort the sub-albums of a parent album, select the Parent Album's link and that will give you a list of all sub-albums for that parent.

Global Album Attribute Editor

You can globally change an attribute for all of your albums using the Global Album Attribute Editor. This screen gives you a list of all available album attributes. You will need to check the Update check box for the attributes you wish to change. On submit, all albums will be updated with the new attributes.

You can also select a Starting Album, which will allow you to only apply the settings to that album and all sub-albums under it. If you choose —– as the starting album, the changes will be applied to all albums on your site.


An example is if you decided to enable comments for all your albums, you would check the box for Allow Comments, then check the check box to the right under the Update column so this setting will be applied. Submit and only the Enable Comment attribute will be updated for every album on your site.

Global Album Permission Editor

You can also globally change the permissions for all of your albums using the Global Album Permission Editor. This screen gives you a list of all available permissions. You will need to check the check box for the permissions you wish to change. On submit, all albums will be updated with the new permissions.

An example is if you decide to change the group ownership for all of your albums, you would select the Group from the drop down list and then check the check box to the right under the Update column. Submit and only the Group owner will be updated for every album on your site.

Setting Album Create Defaults

When you create your albums, the initial settings are determined by the default settings that are setup in the Media Gallery Administration Section.

Special Types of Albums

By selecting a specific set of configuration options, you can create special albums that can be used to serve a specific purpose.

Member Albums

Member Albums are a special feature of Media Gallery v1.4+ that allows the site administrator to give site users their own album or albums to upload media into. Member Albums are special in that there are some protected options the member cannot configure, such as setting the album as a featured album or turning on/off moderation. As the site administrator you can specify certain restrictions such as maximum allowed file size, maximum resolution of images or overall disk usage quotas for your members.

Media Gallery allows the site administrator to specify where Member Albums can be created. For example, you could create a special album titled Member Galleries and have all Member Albums placed under this album. Or, you could specify that Member Albums can be created anywhere that the user has permissions to create. For example, by specifying the root album as the Member Album Root, site users could create albums directly off the root album. But, they could not create new sub-albums under another user's album, as permissions would not allow this.

Media Gallery also provides the ability to automatically create Member Albums when the user registers with your site. The drawback to this method is that not all users will utilize their Member Album and you may have several empty albums lying around your site. To address this issue, Media Gallery provides a featured called Self Enrollment where the user can select to have their Member Album created and after they agree to your Terms and Conditions the album will automatically be created. This extra step will help reduce the number of unused Member Albums.

To enable Self Enrollment there are a few options:

  • When Media Gallery was installed a block was created called Member Albums which displays the self enrollment link. You could enable this block.
  • You can create a static page with information about your Member Albums and provide a link to: http://yoursite/mediagallery/enroll.php

To help manage those Member Albums that are created and never used, there is an administrative function, Purge Member Albums that will list all the empty Member Albums on your site and also show the last login date for the user. This batch house-keeping function will make it very simple to remove those unused albums.

Just as Member Albums can be automatically created when a user registers with your site, they can also automatically be purged or archived when the user is removed from your site. Media Gallery allows you to choose whether to delete the album and all of its contents automatically or move it to an archive area.

Member Albums provides a flexible and safe method to allow your site users to share their media items on your website.

For specifics on configuring and administering Member Albums, see the Media Gallery Administration Section.

Podcast Albums

There is a new album attribute called Podcast Album. If this option is checked for the album, the RSS file will include the required enclosure tags needed for podcast clients. The RSS files will also use the album's cover image as the RSS feed image.

Media Gallery can also display a podcast album differently, using a single column layout similar to the glFusion story layout. To enable the podcast layout, select the following album attributes:

  • Podcast Album - Checked
  • Enable Keywords - Checked
  • Display Album Description - Checked
  • Enable Slideshow - NOT checked
  • Thumbnail size small (100×100)
  • Display Columns = 1

If the media file is MP3, Media Gallery will display a small player below the thumbnail to allow your site users to easily listen to the podcast online. The small player will only be displayed when the Display Columns is set to 1.

Hidden Albums

Hidden albums have a special purpose. They are normally hidden from all lists presented to the standard user, but can be used for autotags. For example, if you have an album that only contains images you wish to use in stories, but don't want people to browse the album directory, you can mark it as hidden. All autotags to this hidden album will only provide the image, without a hyperlink to the album.


Users who have EDIT access to a hidden album will see them as normal albums during browsing. This includes any user with the mediagallery.admin attribute.

glfusion/mediagallery/albums.txt · Last modified: 2017/04/12 21:11 (external edit)

Page Tools