Graphic resources in themes - Coppermine Photo Gallery - Documentation & Manual

# Coppermine Photo Gallery v1.5.x: Documentation and Manual

No translation available

# Graphic resources in themes

Graphical resources within themes can be customized and configured. The following standards are being used to change or edit the looks of your custom theme:

- Menu Icons
- Image Navigation bar
- Rating images
- Progress image (loader)

## Menu Icons

The term menu icons may appear a bit misleading: depending on the corresponding option "Enable menu icons" setting, not only admin menu icons may be taken into account, but icons all over coppermine's output both for the admin as well as the visitor may or may not be "spiced up" with little icons that represent the action that can be performed or has been performed.

A Coppermine theme can come with an iconset of it's own. If it doesn't come with an icon set of it's own, the default icon set is being used that resides in the folder `./your_coppermine_folder/images/icons/`. If a theme comes with an iconset of it's own, the icons will reside in the folder `./your_coppermine_folder/themes/your_custom_theme/images/icons/`. You have to explicitely specify that a custom theme has got a per-theme icon set of it's own. To accomplish this, you need to edit `./your_coppermine_folder/themes/your_custom_theme/theme.php` with a plain-text editor and add/uncomment a line like this:

    define('THEME_HAS_MENU_ICONS',16);

If such a line is present, coppermine will look for menu icons within `./your_coppermine_folder/themes/your_custom_theme/images/icons/`. If such a line is not present, the default icon set that comes with coppermine will be used. The code you need to add must be in a line of it's own. It defines a constant and fills that constant with the value "16", where that value stands for the size (in pixels) of the square menu icons.

The menu icon feature is comparatively new, so with the initial release of cpg1.5.x, there probably won't be many different menu icons to choose from. However, this may differ, as the number of available menu icon sets may increase. It's recommended to check the official website from time to time for new icon sets.

## Image Navigation bar

A Coppermine theme can come with a set of images used for the image navigation bar. The image navigation bar is the horizontal line above the intermediate image that allows the visitor to jump back to the thumbnail overview, jump to the previous or next image within the album and (if applicable) toggle the picture information section and allow users to send ecards and start a slideshow. If a theme doesn't come with graphics for the navbar of it's own, the default set of images is being used that resides in the folder `./your_coppermine_folder/images/navbar/`. If a theme comes with a set of images for the navbar, the images will reside in the folder `./your_coppermine_folder/themes/your_custom_theme/images/navbar/`. You have to explicitely specify that a custom theme has got a per-theme navbar set of it's own. To accomplish this, you need to edit `./your_coppermine_folder/themes/your_custom_theme/theme.php` with a plain-text editor and add/uncomment a line like this:

    define('THEME_HAS_NAVBAR_GRAPHICS',1);

If such a line is present, coppermine will look for navbar images within `./your_coppermine_folder/themes/your_custom_theme/images/navbar/`. If such a line is not present, the default navbar image set that comes with coppermine will be used. The code you need to add must be in a line of it's own. It defines a constant and fills that constant with the value "1", where that value doesn't have a particular meaning.

If you decide to design a navbar set of your own for your custom theme, the following images need to reside in your custom navbar folder (`./your_coppermine_folder/themes/your_custom_theme/images/navbar/`):

- ecard.png
- info.png
- next.png
- prev.png
- report.png
- slideshow.png
- thumbnails.png

## Rating images

A Coppermine theme can come with a set of images used for rating. The ability of visitors to rate is not determined by the presence of the rating image - it's a setting that depends on the permission of the group the visitor is in (→ Groups control panel) and the properties of the album (→ Album Properties). If a theme doesn't come with rating images of it's own, the default set of images is being used that resides in the folder `./your_coppermine_folder/images/`. If a theme comes with a set of rating images, the images will reside in the folder `./your_coppermine_folder/themes/your_custom_theme/images/`. You have to explicitely specify that a custom theme has got a per-theme rating images of it's own. To accomplish this, you need to edit `./your_coppermine_folder/themes/your_custom_theme/theme.php` with a plain-text editor and add/uncomment a line like this:

    define('THEME_HAS_RATING_GRAPHICS',1);

The code you need to add must be in a line of it's own. It defines a constant, where the value of the constant doesn't have a particular meaning.

If defined, the following files need to reside in the theme's images folder:

- `rate_empty.png`
- `rate_full.png`
- `rate_new.png`
- `rating.png`

## Film Strip graphics

A Coppermine theme can come with a set of images used to compose the film strip. If a theme doesn't come with film strip images of it's own, the default set of images is being used that resides in the folder `./your_coppermine_folder/images/`. If a theme comes with a set of film strip images, the images will reside in the folder `./your_coppermine_folder/themes/your_custom_theme/images/`. By default, the film strip graphics are named `tile.gif`.

You have to explicitely specify that a custom theme has got a per-theme film strip images of it's own. To accomplish this, you need to edit `./your_coppermine_folder/themes/your_custom_theme/theme.php` with a plain-text editor and add/uncomment a line like this:

    define('THEME_HAS_FILM_STRIP_GRAPHIC',1);

The code you need to add must be in a line of it's own. It defines a constant, where the value of the constant doesn't have a particular meaning.

## Progress image (loader)

A Coppermine theme can come with an image used as progress bar or loading icon. With modern web applications users expect to see if the page they are on is busy with something (i.e. an upload or download) - that's what the progress bar is being used for.
If a theme doesn't come with a loader image of it's own, the default image is being used that resides in the folder `./your_coppermine_folder/images/`. If a theme comes with a pprogress bar animation image, the image will reside in the folder `./your_coppermine_folder/themes/your_custom_theme/images/`. By default, the loader image is named `loader.gif`.

You have to explicitely specify that a custom theme has got a per-theme loader image of it's own. To accomplish this, you need to edit `./your_coppermine_folder/themes/your_custom_theme/theme.php` with a plain-text editor and add/uncomment a line like this:

    define('THEME_HAS_PROGRESS_GRAPHICS',1);

The code you need to add must be in a line of it's own. It defines a constant, where the value of the constant doesn't have a particular meaning.