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

# Tools recommended by the devs

## Target audience

This part of the documentation is meant for end users of Coppermine as well as for developers. There is no support for this section though, it comes as-is.

## Disclaimer

The Coppermine dev team is not affiliated with any of the sites / projects mentioned below, nor do we provide support for those apps. We're just convinced that those tools are usefull when running a gallery script like Coppermine.

Please do not ask support questions related to the apps mentioned below on the Coppermine support board. From our perspective, those apps come from a third party - support for them can be found elsewhere on the web.
The best place to get support for those apps are their homepages and the documentation that usually comes with those apps. You might find other usefull resources using Google.

This page is meant as a service to end users and developers - please don't make us regret having put together this link list.

## List of tools

The tools fall into different categories, depending on what you want to accomplish:

- Database manipulation
- FTP-clients
- Web development
- Plain text editors
- Picture Editors

### Database manipulation

If you manually want to edit the database behind Coppermine or need to backup or restore your database, you will need these tools.

App name | Purpose | Type | OS | License | i18n | Homepage
--- | --- | --- | --- | --- | --- | ---
#### phpMyAdmin | Database management |  | n/a |  | 50+ languages | www.phpmyadmin.net
Description: Open-source web application that can be downloaded (for free) and installed on your webserver (easy installation). It comes with multiple language support. Your webhost may even provide this tool. Features: MySql database management tool that allows manipulating your database and running queries directly against your database. Benefits for the use with Coppermine: Create database backups Edit config options (even if your Coppermine site's config panel is not accessible) Repair broken tables
#### mySqlDumper | Database backup/restore |  | n/a |  | 2 languages | mysqldumper.de/en/
Description: MySqlDumper is a web app that can be downloaded and installed on your webserver. It is meant to be used to create backups of your mysql databse (and eventually restore those backups). Particularly helpful if you don't have shell access to your webserver and regular mySQL backups fail due to time-outs. Features: A PHP-Script has a maximum of execution time; anything after above the limit (Usually sets to 30 seconds) will result in losing data. Such behavior renders large database backup impossible. Perhaps you already noticed how much of a problem it could be while using other tools. MySqlDumper uses a proprietary technique to avoid execution interruption. It only reads and saves a certain amount of commands and then calls itself via JavaScript and memorizes how far in the process it was and resumes its action from its last standby.

### FTP clients

Upload/download files to/from your webserver using the File Transfer Protocol (FTP). Needed to install Coppermine in the first place, but as well for means of FTP-upload plus batch-add, theme customization, file backup, updates.
Having an FTP app is a (nearly) pre-requisite for being able to install and maintain Coppermine (or any web-driven app) in the first place, at least if you're being webhosted. Only in the rare cases of having other ways of transfering files to/from your webserver (e.g. if you're on an intranet) you could get away without an application that is capable of transfering files using FTP. On 99% of all shared webhosting, FTP is the only supported (and recommended) method to transfer files. Therefore, having a good FTP-client is a must.

The Coppermine dev team is strongly advising not to use the FTP-clients built into WYSIWYG-editors like MS Frontpage, as those built-in clients have been designed to work with files created by that editor, but they have not been designed with pre-made scripts like Coppermine in mind.
Don't use so called "web-FTP" interfaces neither, as they are restricted by design to the limitations built into browsers.

App name | Purpose | Type | OS | License | i18n | Homepage
--- | --- | --- | --- | --- | --- | ---
#### FileZilla | FTP client |  |  |  | multi (18+ languages) | filezilla-project.org
Description: FileZilla is a free FTP client that is available as open-source app (free of charge). Features: Ability to resume Uploads/Downloads (if the server supports it) Custom Commands Site Manager with folders Keep Alive system Timeout detection Firewall support SOCKS4/5 and HTTP1.1 Proxy support SSL secured connections SFTP support Upload/Download Queue Drag&Drop Multi-language support GSS authentication and encryption using Kerberos
#### SmartFTP | FTP client |  |  | Free for non-commercial use | multi (20+ languages) | www.smartftp.com
Description: SmartFTP is a fully-featured FTP client for Windows. Features: Available for Windows 98, ME, 2000, XP, 2003, XP x64, and 2003 x64. Multiple connections, auto-reconnect and resume broken transfers, global and local transfer queues with scheduling, FXP, custom commands, CHMOD, backup tool, drag & drop. Benefits for the use with Coppermine: Transferring Coppermine to your server for initial installation, transferring photos to your /albums folder, settings permissions appropriately, applying mods, plugins, themes. License: Free for Personal, Educational, or Non-Profit Use (no support). Small cost for Commercial Use or to include support

### Web development

The web development tools are usually integrated into the browser as a plugin, so they interact with the page you're viewing in your browser. They are particularly helpful to figure out CSS issues, as one of their features often is to let you see which section of the output is controlled by which stylesheet class. Another key aspect that makes them usefull with Coppermine is their ability to monitor cookies and forms, which helps in figuring out issues with logging in.

App name | Purpose | Type | OS | License | i18n | Homepage
--- | --- | --- | --- | --- | --- | ---
#### Web Developer | Web development tool |  | n/a |  | 19 languages | chrispederick.com/work/web-developer/
Description: "Web Developer Extension" is a plugin for the Mozilla/Firefox browser that adds a toolbar to your browser window. Using this toolbar, you can view cookie information, view and manipulate stylesheets, form data, images. It is particularly helpful for web designers (or after all everybody who runs and maintains a website of his own). Features: Disable: The disable features allows the disabling of various features including the cache, JavaScript and page colors. Cookies: The cookies features provide various cookie related tools including disabling, adding and viewing cookies. CSS: The CSS features provide various tools related to the CSS on the page including displaying the styles applied to the selected element and live editing of the CSS. Forms: The forms features provide the ability to manipulate the forms on the page including display the form details and populating form fields. Images: The images features provide various image related tools including finding broken images and outlining images. Information: The information features provide various informational tools including displaying element information and viewing the document size. Miscellaneous: The miscellaneous features provide various tools including displaying a ruler and live editing of the HTML. Outline: The outline features allow the outlining of various elements including block level and positioned elements. Resize: The resize features provide the ability to resize the window to pre-defined or custom sizes and to display the current window size. Tools: The tools features allow an unlimited number of configurable tools including validating the CSS and the HTML. View Source: source There view source features provide the ability to view the page source including viewing the generated source and viewing the source in an external application. Benefits for the use with Coppermine: Fix cookie issues (especially when bridging), find out what stylesheet class controls which section of the output
#### Web Accessibility Toolbar | Web development tool |  |  |  |  | www.visionaustralia.org.au/ais/toolbar/
Description: The "Web Accessibility Toolbar" has been developed to aid manual examination of web pages for a variety of aspects of accessibility. It consists of a range of functions that: Details identify components of a web page facilitate the use of 3rd party online applications simulate user experiences provide links to references and additional resources. Benefits for the use with Coppermine: Fix cookie issues (especially when bridging), find out what stylesheet class controls which section of the output License: Creative Commons (Freeware) Requirements: Microsoft Internet Explorer
#### IE Developer Toolbar | Web development tool |  |  | ? |  | microsoft.com [...]
Description: Microsoft has released a toolbar as well that has similar capabilities as the above mentioned toolbars. It can be used with IE6 or better (IE7 is supported as well) and can be used with Windows 2000 or better. Features: Explore and modify the document object model (DOM) of a Web page. Locate and select specific elements on a Web page through a variety of techniques. Selectively disable Internet Explorer settings. View HTML object class names, ID's, and details such as link paths, tab index values, and access keys. Outline tables, table cells, images, or selected tags. Validate HTML, CSS, WAI, and RSS web feed links. Display image dimensions, file sizes, path information, and alternate (ALT) text. Immediately resize the browser window to a new resolution. Selectively clear the browser cache and saved cookies. Choose from all objects or those associated with a given domain. Display a fully featured design ruler to help accurately align and measure objects on your pages. Find the style rules used to set specific style values on an element. View the formatted and syntax colored source of HTML and CSS.
#### Firebug | Web development tool |  | n/a | MPL |  | getfirebug.com
Description: Firebug integrates with Firefox as a browser plugin to put a wealth of development tools at your fingertips while you browse. You can edit, debug, and monitor CSS, HTML, and JavaScript live in any web page. Alternative platforms: there's a Firebug Lite version that can be used with IE, Opera and Safari License: Mozilla Public License (Freeware)

### Text editors

To modify the core code of coppermine or come up with a custom theme you will need a plain-text editor. You can't use WYSIWYG-editors like MS Frontpage, but you really need to use a plain-text editor. While the editor that comes with your operating system (usually notepad.exe on Windows) is fine, you may want an editor with advanced features like syntax-highlighting, project management

App name | Purpose | Type | OS | License | i18n | Homepage
--- | --- | --- | --- | --- | --- | ---
#### Crimson Editor | Plain text editor |  |  |  |  | www.crimsoneditor.com
Description: Open-source client application that can be downloaded (for free) and installed on your Windows-PC. Features: Crimson Editor is a source code editor. This program is not only fast in loading time, but also small in size. While it can serve as a good replacement for Notepad, it also offers many powerful features for programming languages such as HTML, C/C++, Perl and Java: Details Syntax Highlighting for HTML, C/C++, Perl, Java, Matlab and LaTeX (can be extended for other programming languages based on custom syntax files) Multi doc editing Multi-level undo/redo Project management Directory tree view window Find & Replace Natural word wrapping built-in FTP client Benefits for the use with Coppermine: Edit core files (PHP), HTML templates, CSS stylesheets Unicode-support (utf-8)
#### Bluefish | Plain text editor |  |  |  | 17 languages | bluefish.openoffice.nl
Description: Bluefish is a powerful editor targeted towards programmers and webdesigners, with many options to write websites, scripts and programming code. Bluefish supports many programming and markup languages, and it focuses on editing dynamic and interactive websites. Features: Lightweight - Bluefish tries to be lean and clean, as far as possible given it is a GUI editor. Bluefish is uses 30%-45% of the memory compared to other web development editors. Fast - Bluefish loads tens of files within seconds. A What You See Is What You Need interface Multiple document interface, easily opens 500+ documents (tested 3500 documents simultaneously) Project support, enables you to work efficiently on multiple projects, and automatically restores settings for each project. Support for remote files using gnome-vfs (depending on your gnome-vfs setup, you'll have FTP, SFTP, HTTP, HTTPS, WebDAV, Samba and more). The development version uses GIO/GVFS to open remote files. Very powerful search and replace, allowing POSIX and Perl Compatible regular expressions and sub-pattern replacing Open files recursively based on filename patterns and/or content Unlimited undo/redo functionality Customizable syntax highlighting based on Perl Compatible regular expressions, with subpattern support and default patterns for Python, HTML, PHP, C, Java, JavaScript, JSP, SQL, XML, Perl, CSS, ColdFusion, Pascal, R, Octave/MATLAB Anti aliased text window Multiple encodings support. Bluefish works internally with UTF8, but can save your documents in any desired encoding. Line numbers along the document, bookmarks in documents and an excellent search function HTML toolbar and tearable menus Compliance with the Gnome and KDE user interface guidelines where possible Specify custom dialogs, search and replace patterns or insert patterns and bind them to a shortkut key combination of your liking to speed up your development process Integrate external programs such as make, lint, weblint, xmllint, tidy, javac, or your own program or script to handle advanced text processing or error detection. Integrate external filters of your liking, pipe your document (or just the current selected text) through sort, sed, awk or any custom script. Function reference browser, including reference files for PHP, CSS, Python and HTML Auto tag closing for HTML and XML documents
#### Notepad++ | Plain text editor |  |  |  | 43 languages | notepad-plus.sourceforge.net
Description: Open-source client application that can be downloaded (for free) and installed on your Windows-PC. Features: Syntax Highlighting and Syntax Folding Supported languages : C, C++, Java, C#, XML, HTML, PHP, CSS, makefile, ASCII art (.nfo), doxygen, ini file, batch file, Javascript, ASP, VB/VBS, SQL, Objective-C, RC resource file, Pascal, Perl, Python, Lua, TeX, TCL, Assembler, Ruby, Lisp, Scheme, Properties, Diff, Smalltalk, Postscript, VHDL, Ada, Caml, AutoIt, KiXtart, Matlab, Verilog, Haskell, InnoSetup, CMake YAML User Defined Syntax Highlighting Auto-completion Multi-Document Multi-View: You have two views at same time. That means you can visualize (edit) 2 different documents at the same time. You can visualize (edit) in the 2 views one document at 2 different positions as well. The modification of document in one view will carry out in another view (i.e. you modify the SAME document when you are in clone mode). Regular Expression Search/Replace supported Full Drag ‘N' Drop support Dynamic position of Views File Status Auto-detection: if you modify or delete a file which opened in Notepad++, you will be notified to update your document (reload the file or remove the file) Zoom in and zoom out Multi-Language environment supported Bookmark: user can just click on the bookmark margin (located right side of line number margin) or type Ctrl+F2 to toggle a book mark. To reach the bookmark, type just F2 (Next bookmark) or Shift+F2 (Previous bookmark). To clear all bookmarks, click the Menu Search->Clear All bookmarks. Brace and Indent guideline Highlighting Macro recording and playback Benefits for the use with Coppermine: Edit core files (PHP), HTML templates, CSS stylesheets Unicode-support (utf-8)
#### PsPad | Plain text editor |  |  |  | 8 languages | www.pspad.com
Description: PSPad is a freeware programmer's editor for Microsoft Windows operating systems, useful for people who: Details work with various programming environments like highlighted syntax in their source code need a small tool with simple controls and the capabilities of a mighty code editor are looking for a tool that handles plain text want to save time - PSPad offers rich text formating functions need tool what offer user extension capabilities want to save money and still have the functionality of professional products because PSPad is free for commercial and government purposes too Features: Project management work with several documents at the same time save desktop sessions to later reopen all session files FTP client - edit files directly from the web macro recorder to record, save and load macros search and replace in files text difference with color-coded differences highlighted templates (HTML tags, scripts, code templates...) installation contains templates for HTML, PHP, Pascal, JScript, VBScript, MySQL, MS-Dos, Perl etc. syntax highlighting according to file type user-defined highlighters for exotic environments auto correction intelligent internal HTML preview using IE and Mozilla full HEX editor call different external programs for different environments external compiler with output catcher, log window and log parser for an "IDE" effect in every environment color syntax highlight printing and print preview integrated TiDy library for formatting and checking HTML code, conversion to CSS, XML, XHTML integrated free version of the top CSS editor TopStyle Lite export with highlight to RTF, HTML, TeX format to file or clipboard column block select, bookmarks, line numbers, ... reformat and compress HTML code, tag character case change line sorting with ability to sort on defined columns and drop duplicates ASCII chart with HTML entities Code explorer for Pascal, C/C++, INI, HTML, XML, PHP and more in development spell checker internal web browser with APACHE support matching bracket highlighting

### Picture Editors

Before uploading images to your webserver, you might want to edit them on your client. There's a number of reasons why you should do that:

- Resizing the images on the client will give you better results, is faster (as you save both processing time on the server as well as upload time) and avoids issues with server-sided restrictions on resouces consumption
- Cropping and rotating is easier to perform on the client
- Editing picture meta data (like EXIF or IPCT) is only possible on the client (because the image libraries on the server that coppermine can use don't come with the needed capabilities)

On www forums you can often read the recommendation to use Adobe's Photoshop application to perform such tasks, but it's a bit overkill to use such a powerfull, expensive application for such basic purposes. There are many applications available free of charge that can accomplish the same thing.

App name | Purpose | Type | OS | License | i18n | Homepage
--- | --- | --- | --- | --- | --- | ---
#### Irfan View | Image viewer with basic editing capabilities |  |  |  | 25 languages | irfanview.com
Description: Free for personal and educational use. Small license fee for commercial use. Features: Many supported file formats Multi language support Thumbnail/preview option Paint option - to draw lines, circles, arrows, straighten image etc. Support for Adobe Photoshop Filters Fast directory view (moving through directory) Batch conversion (with image processing) File search Support for embedded color profiles in JPG/TIF Change color depth Cut/crop IPTC editing Effects (Sharpen, Blur, Adobe 8BF, Filter Factory, Filters Unlimited, etc.) Lossless JPG rotation Unicode support Only one EXE-File, no DLLs, no Shareware messages like "I Agree" or "Evaluation expired" No registry changes without user action/permission!
#### The Gimp | Image manipulation program for photo retouching, image composition and image authoring. |  |  |  | GIMP has been translated into many, many languages. Yours is surely among them. | www.gimp.org
Description: GIMP is an acronym for GNU Image Manipulation Program. It is a freely distributed program for such tasks as photo retouching, image composition and image authoring. It has many capabilities. It can be used as a simple paint program, an expert quality photo retouching program, an online batch processing system, a mass production image renderer, an image format converter, etc. GIMP is expandable and extensible. It is designed to be augmented with plug-ins and extensions to do just about anything. The advanced scripting interface allows everything from the simplest task to the most complex image manipulation procedures to be easily scripted. GIMP is written and developed under X11 on UNIX platforms. But basically the same code also runs on MS Windows and Mac OS X.