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

Table of Contents
No translation available


Coppermine uses "keywords" for gallery items that allows both the gallery admin as well as end users to assign one or more keywords to each file in a gallery. This is helpful for tagging files so they may be searched or browsed more easily.

Assigning keywords

Keywords can be assigned to files during the upload stage or afterwards in the gallery itself. Keywords can be selected from a list of keywords or entered by typing them in.

Keyword separator or keyword delimiter

Different keywords are separated using a delimiter set on the gallery configuration panel. Choosing the delimiter is a new feature of Coppermine 1.5; previously, keywords could only be separated by spaces. You can choose the keyword separator to be a semicolon, a comma, or a space. The semicolon is the default for new installations of Coppermine 1.5; the space is retained for upgrades from Coppermine 1.4 and earlier. For upgrades, you can convert your keyword separator to a semicolon or comma by going to the Admin Tools page.

Editing/adding keywords

Click on "edit files" next to the thumbnail that represents that album. You can also edit the file information for a single file by clicking on the button underneath the intermediate image. Edit the keywords by entering them into the corresponding field.

Keywords manager

As your gallery grows, there will be an increasing number of files in it and subsequently a lot of keywords to manage. To help you manage your keywords, there is a keyword manager available - just click on the corresponding link in the admin menu.

Note that the keyword manager will only show up in the admin menu if you have enabled "Enable clickable keywords in search" in Coppermine's config. If you have disabled the feature in config, you can still access the keyword manager using the link on the config page or by typing in keywordmgr.php in your browser's address bar (i.e. by going to http://yourdomain.tld/your_coppermine_folder/keywordmgr.php).

The items on they keyword manager screen should be self-explanatory: using the most left column labeled "edit" with the edit-icon next to a keyword you can edit a keyword that can be assigned to several files. Click on the radio button in that column, then modify the keyword using the input field at the bottom of the screen. After editing, submit the change by clicking on the "change keyword" button. This will change the selected keyword for all files.

This feature is particularly helpful if you have keywords assigned to your files that only differ slightly: for example, there could be both the keyword "apple" as well as "apples" in your gallery, which are not the same and therefore might cause issues. Using the above-mentioned option to change a keyword site-wide, either change all occurrences of "apples" to "apple" or vice versa.

The feature "delete keyword" works similarly - just clicking on the "delete keyword XYZ"-link will delete the keyword for all files (it will not delete the file itself, just the keyword).

To find out in which files a particular keyword is being used, just click on "search for "XYZ" in new window".
If Enable clickable keywords in search is enabled, the list will be displayed at the bottom of the keyword manager screen just as it will be displayed on the search page.

Album keywords

Coppermine comes with a powerful feature that allows you to have files that only need to be uploaded once to appear in another (or several other) albums as linked files. This can be accomplished using the album keyword feature.

Here's how you accomplish that: go to the album that contains the pics that are supposed to show up in another album, click on "edit files" next to the thumbnail that represents that album. On the edit files screen, come up with a unique keyword that all those files have in common that a human would not choose as simple keyword. Keep in mind what the keyword separator is for your gallery (set on the configuration panel). A good keyword would be "Holiday Transylvania 2007 With Brad And Janet" for example. (If your gallery keyword separator is a space and you want to keep it a space - and not convert to a better separator like a semicolon - then use "HolidayTransylvania2007WithBradAndJanet".) By using a long and specific keyword, you can be assured that only the files you assign to this specific keywords show up in the album. You can use a simpler keyword if you want to include more variations of the album keyword you choose. Assign that keyword (without the quotes) to all files that are supposed to show up in another album. Then submit the changes. Final step: go to the album that is supposed to contain the copies (linked files). Navigate to the properties screen of that album (use the "properties" button next to the thumbnail that represents the album) and enter the keyword you chose ("Holiday Transylvania 2007 With Brad And Janet" in the above example or without spaces if necessary) into the field "Album Keyword" field (again without the quotes) on the properties page and submit the form. Observe the results - pretty nifty, eh? One drawback though: an album that only contains files linked from another album (using the album keyword feature) and no actual "non-linked" file can not be represented with an album thumbnail. So we suggest uploading at least one "real" pic to the album that is supposed to contain the linked files and assign the thumbnail of that file to the album.

If you use a space as the keyword separator, remember that spaces between words will break those words into separate keywords. If you must use phrases for your keywords, connect them with an underscore or by using the ascii space holder ctrl+Alt+0160 (NOTE: the latter option only works with latin based character sets.)

The better option is to use a semicolon as the gallery keyword separator (set on the configuration panel). That way, you can use a space or a comma in your keywords. For example, for a photo of Mount Rushmore a keyword set could be "Washington, George;mountain;South Dakota" and you would have 3 keywords: (1) "Washington, George", (2) "mountain", (3) "South Dakota".

Each album can only have ONE (1) keyword or keyword phrase. All pictures residing in different albums that you would like to be displayed in this album must have the same keyword or keyword phrase in their respective keyword fields. Pictures, unlike albums can have multiple keywords or keyword phrases separated by the keyword separator/delimiter. This provides you with the option to display pictures in many albums. For the visitor of these albums, it will appear as if the file/image had been uploaded to each album.