Coppermine Photo Gallery v1.5.x: Documentation and Manual
Table of contents
Documentation Language Selection
Coppermine documentation
About Coppermine
About the documentation
Features
Quick-Start guide
Table of contents
Minimum requirements
Testing (alpha/beta versions!)
Languages
Translation guide
Credits
Coppermine team
Contributors
Translators
Free code used
License & Copyright
Copyrights
License
(GNU GPL)
Preamble
Terms and conditions
0. Definitions
1. Source Code
2. Basic Permissions
3. Protecting Users' Legal Rights From Anti-Circumvention Law
4. Conveying Verbatim Copies
5. Conveying Modified Source Versions
6. Conveying Non-Source Forms
7. Additional Terms
8. Termination
9. Acceptance Not Required for Having Copies
10. Automatic Licensing of Downstream Recipients
11. Patents
12. No Surrender of Others' Freedom
13. Use with the GNU Affero General Public License
14. Revised Versions of this License
15. Disclaimer of Warranty
16. Limitation of Liability
17. Interpretation of Sections 15 and 16
Previous versions
Additional terms (license add-ons)
Preservation of author attributions
Marking of modified versions
Disclaimer
Known issues
Installation and setup
How to install the script
What the installer does
Setting permissions
Apache on Unix/Linux (CHMOD)
Apache on Windows
IIS on Windows
Asking for support on permissions issues
The install screen
Auto-Installers
Installation FAQ
Uninstall
Upgrading
Why upgrade?
Reasons for package releases
Changelog
Steps needed to perform when upgrading Coppermine (from any version)
Additional actions for updating from particular versions
Upgrading from versions cpg1.0,1.1,1.2.x or 1.3.x
Upgrading from cpg1.4.x to version cpg1.5.x
The update script
What it does
Purpose
Authorization check
When must the updater be run?
The version check tool
What it does
Options
Version comparison
Upgrading FAQ
Downgrading from cpg1.5.x to an older version
Getting Started
Basic concepts
Initial configuration
Category/album/file structure
Resized images
Your admin account
Check uploads
Consider bridging
What are your visitors allowed to do?
Change your coppermine's design
Typical setups
Frequently Asked Questions
Themes
Themes that come with Coppermine
Upgrading your custom theme
Converting cpg1.4.x themes to cpg1.5.x
Edit style.css
Edit template.html
Edit theme.php
Validation Methodology
Converting cpg1.3.x themes to cpg1.4.x
Edit style.css
Edit template.html
Edit theme.php
Validation Methodology
Content of a theme
How the theme engine works
User-contributed themes
Creating your custom theme
Rename your theme first
Tipps & tricks
Using WYSIWYG-editors
Modifying colors
Creating a Coppermine theme that matches your overall site layout
Editing template.html
Template tokens
Important
List of tokens in template.html
Editing style.css
Editing theme.php
Item types
The sample theme - a template to copy from
Method
Scope
List of items in theme.php
Theme Examples
Copyright-disclaimer in footer
Dynamic (PHP-driven) content
Using anycontent.php
Custom header and footer
Theme-based dynamic content (theme.php)
Modifying core files
Graphic resources in themes
Menu Icons
Image Navigation bar
Rating images
Administration
Admin menu items
Banning
Configuration
General settings
Language & Charset settings
Themes settings
Album list view
Thumbnail view
Image view
Comment settings
Contact form settings
Thumbnail settings
File settings
Image watermarking
Registration
User settings
Custom fields for user profile
Custom fields for image description
Cookie settings
Email settings
Logging & statistics
Maintenance settings
Groups
The group control panel
Group names
Group types
Quota
Group permissions (Rating/Ecards/Comments)
Public albums upload
Personal gallery
Upload method
Assigned albums
Creating custom groups
Deleting custom groups
Triggering synchronisation (bridged only)
Users
The user control panel
Page controls
Searching for user(s)
Creating new users
Editing users
Group membership
Categories
Albums
The Album Manager
Creating albums
Renaming albums
Changing the album order
Deleting albums
Modifying albums/files
Album properties
Reset album properties
Admin vs. user
Album FAQ
Files
Editing files
Editing videos
Custom Thumbnails
Keywords
Assigning keywords
Assigning keywords when uploading
Editing/adding keywords
Keywords manager
Album keywords
BBCODE
EXIF data
Plugins
What is a plugin?
The Plugin API
Where to get Plugins from?
Plugins that ship with Coppermine
The Plugin Manager
Uploading a plugin
Installing a plugin
Plugin Configuration
Uninstalling a plugin
Writing plugins
Performance
Admin Tools
Errors
Exporting
Watermarking
Uploading
Uploading pics by FTP / Batch-Add Pictures
Uploading by HTTP
Windows XP Web Publishing Wizard
XP Web Publishing Wizard: Setup
XP Web Publishing Wizard: Uploading pictures
Upload troubleshooting
Permissions
Enable troubleshooting settings
Asking for support on upload issues
Error messages
Server-sided restrictions
Things to check
Comments
Allowing comments
Comments options
Spam issues
Reviewing Comments
Individual Comments
Bridging
What bridging does
Available bridge files
Pre-requistes
Authentication by cookie
Standalone version first
Coppermine users, groups and pics uploaded by users are lost when integrating
Backup
Integration steps
Using the bridge manager
Choose application to bridge coppermine with
Path(s) used by your bridge app
Bridge-app-specific settings
Enable/disable bridging
Recover from failed bridging
Synchronising the bridge app groups with Coppermine's groups
Bridging support
Some config options get disabled
Bridging files
Creating a custom bridge file
Bridging philosophy
Individual bridge issues
Subdomain issues
Developer documentation
Coding guidelines
Adding/renaming/removing files
Sanitization of Superglobals using Inspekt
Javascript in Coppermine
Plugin Writing for Coppermine
Plugins tutorial, API description
An Overview of the Coppermine Plugin API
Introduction
Intended Audience
Required Skills & Knowledge
Recommended Software & Support Forums
Structure of this Document
"Hello, world" Plugin Tutorial
My First Plugin
Installation, Configuration, and Clean-Up
Installation with Simple Configuration
Installation with Configuration Parameters
Configuration during Operation
Uninstallation & Clean-Up
Linking to Custom Plugin Scripts
Adding a Button to Coppermine
Multi-language Support
Distributing Your Plugin
Where to Go from Here
Plugin Hooks
Plugin Class Properties & Methods
Global Variables & Constants
System Global Variables
Coppermine Constants
Reference list of plugin hooks
Choosing Plugin Hooks
Finding Plugin Hooks
Using Plugin Hooks
Plugin Hooks Listed
Script: index.php
Filter: 'anycontent'
Filter: 'user_caption_params'
Filter: 'plugin_block'
Script: displayimage.php
Filter: 'file_info'
Filter: 'post_breadcrumb'
Script: thumbnails.php
Filter: 'post_breadcrumb'
Script: functions.inc.php
Filters: 'gallery_header' and 'gallery_footer'
Filter: 'thumb_data'
Filter: 'template_html'
Filter: 'page_meta'
Filters: 'thumb_caption' and all derivatives
Filters: 'meta_album'
Script: themes.inc.php
Filter: 'file_data'
Filter: 'html_image_reduced_overlay'
Filter: 'html_image_reduced'
Filter: 'html_image_overlay'
Filter: 'html_image'
Filter: 'html_document'
Filter: 'html_other_media'
Filter: 'admin_menu'
Filter: 'sys_menu'
Filter: 'sub_menu'
Script: usermgr.php
Filter: 'usermgr_header'
Filter: 'usermgr_footer'
Script: pluginmgr.php
Filter: 'plugin_configure'
Filter: 'plugin_cleanup'
Script: plugin_api.inc.php
Filter: 'page_html'
Filter: 'page_end'
Filter: 'plugin_install'
Filter: 'plugin_uninstall'
Filter: 'plugin_wakeup'
Filter: 'plugin_sleep'
Script: init.inc.php
Filter: 'page_start'
Script: picmgmt.inc.php
Filter: 'add_file_data'
Plugin Hooks Alphabetically
Editing the documentation
Subversion
Adding config options
Versioncheck
Updating
Tools recommended by the devs
Database manipulation
FTP clients
Web development
Text editors
Picture Editors
Database schema
Configuration file
Database reference within coppermine code
cpg15x_albums
cpg15x_banned
cpg15x_bridge
cpg15x_categories
cpg15x_categorymap
cpg15x_comments
cpg15x_config
cpg15x_dict
cpg15x_ecards
cpg15x_exif
cpg15x_favpics
cpg15x_filetypes
cpg15x_hit_stats
cpg15x_languages
cpg15x_pictures
cpg15x_plugins
cpg15x_sessions
cpg15x_temp_messages
cpg15x_usergroups
cpg15x_users
cpg15x_votes
cpg15x_vote_stats