________________________________________________________________________________ A. License for pre-version 0.5 en/de "diaRice PHOTO CALENDAR" ---------------- 1. Software is distributed for private use only. You are not allowed to pass it to third party. People should always address to http://support.webdaum.de/diarice in order to download the up-to-date version or the freshly updated older ones. 2. The reciprocal link pointing to diarice.de in the meta menu may not be deleted, set to REL="no-follow", disabled, or disguised in any way. The copyright notices must stay intact in all files. This file (readme.txt) may not be renamed, altered, moved or deleted. 3. The JavaScript-, CSS-, HTML- and PHP-code, and the image files may be altered for private purpose only. You are not allowed to circulate modified versions of any of the files. 4. Copyright All rights reserved for Michael Daum, webdaum.de. Whoever wants to use my work for commercial purposes should contact me. (See 5. contact address) Whoever will use my work - or parts of it - for commercial purposes without permission, will be prosecuted! 5. Disclaimer: The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non infringement. In no event shall the author be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software. This is a pre-version. To report problems, ask for help, post inquiries and wishes, please contact: diaRice(at)webdaum(dot)de ________________________________________________________________________________ B. REQUIREMENTS ---------------- You will need just some free web space and a server allowing to execute the Open Source script language PHP (version 4-5). You do not need to have access to a database. Knowledge of scripting languages, HTML or CSS is NOT required. If you know a little about PHP/HTML/CSS/JS, it should be easy to accommodate the source code to your wishes. There are source code editors implemented, that enable you to modify copies of the calendar's modules and templates online. Just delete the modified file (by pressing the trash icon) to switch back to the default. When upgrading, all your private modules and templates in your local folder will be preserved, as only the original files will be overwritten. The calendar doesn't require much of space, just about 400KB. The exact space you need depends on the actual size and compression of your images. (The photo calendar is optimized for images up to 266 x 266 Pixel in size.) Let's do a simple calculation: at 365 images per year and an estimated file-size of about 10KB per image you will need at least 4MB of free web space per year. You will need even a little more space when activating the extensions for image description or user generated comments. It's basically possible to run the calender as a multiuser application. But the user rights management is still in it's prime, so it's just making a simple distinction between admins with full rights and users with just little restrictions. In later versions it should be possible to make finer distinctions and to lock and unlock specific directories for specific users. ________________________________________________________________________________ C. Installation ---------------- Unzip the files and upload them to your server. Open index.php in the root directory of the calender with your browser. You will be directed to the setup automatically. After choosing your language you will be taken step by step through the installation. Please note down name and password after the admin account has been created. Please indicate your name, address and email. In case you forgot your password, the password can be sent to you by email. Please indicate the relative path to the images directory, starting from the root directory of the calendar and the month, day and year, the calendar starts. In case the directory doesn't exist, the application will try to create it. A raw configuration file will be created from the given data. On success, please follow the link to the calendar's starting page and choose "Login" from the side menu to get connected to the calendar's protected area - the section of administration - to do the fine adjustments. _____________________________________________________________________________ D. Configuration ---------------- MOST OF THE SETTINGS CAN BE CHANGED FROM THE MENU: Go: Login > Config or type "?go=config" to the address bar. Alternatively modify the file "data/config_data.php" directly on the server. - USER RIGHTS MANAGEMENT: Only a admin user can add a new user: Go: Login > Users. or type "?go=users" to the address bar. New users will have to login with name and password given by the admin and to fill in their private profile to be able to open any of the files in the calendar's protected area. After the new user's profile has been saved down, the admin can give full rights to that user by choosing: Go: Login > Rights from the menu or type "?go=profile_edit&all=1" Click on the check box "Administrator" to give full rights. - ADD FOLDERS AND IMAGES USING THE MENU: On the starting page in the protected area you will find a list containing of years. Click on a link to create a new directory. In the side menu and in the list a link pointing to that new directory will appear. Follow the link to create directories for the months as well. Now choose a month. Notice that an empty file and an empty image's filename is shown for every day of the month. Now you can start to upload your images to the chosen directory via the form at the bottom of the page. The server will be automatically renaming the images on receive. You have to reload the page in order to update the display of the images. - UPLOAD IMAGES AND FOLDERS VIA FTP: Images must be named according to following rule: underline character, leading zero for numbers 0-9, dot . and lowercase extension jpg - means e.g.: _01.jpg to _31.jpg TIP: Use IrfanView's batch action to convert/rename your directories quickly. Put those images in extra folders for every month. Name rule: number with leading zero, but no underline character, e.g..: 01 for January or 12 for December. Put the folders for the months in folders for the years, name them a four-digit number, e.g.: 2007 When uploading your images, please make sure to deposit the year's directories in the directory you indicated in the config file (field "Path to image folder"). - MOVE IMAGES, SET THEM TO OFFLINE: Please enable JavaScript. Open the directory containing the image to be moved and click on its filename. Replace the image's filename that is to be moved by the one of the image to be replaced. (The replaced file will be moved to the offline folder.) Now you can add the replaced image - that is now appearing in the "offline" section below the "on line" images - in different position to the current or any other directory. Again just enter the image's name you want to be replaced by the offline image in the clickable field below the offline image. TIP: You can also set an image to offline by simply emptying the field containing its filename. - REMOVE AN IMAGE PERMANENTLY: Just click on the delete icon on the upper left edge of the image. The image will be deleted irrevocably ! - ADD AN DESCRIPTION TO AN IMAGE: Please choose Login > Config > Extensions and activate extension "image description" by typing "on" to the field on the right. Save. Now move to the folder containing the image to be described: My images > Year > Month and click on the image. A form will appear so you can enter the text. Save. Clicking on the image leads directly to its display in the calendar. - ALLOW USER COMMENTS: Please choose Login > Config > Extensions and activate extension "comments" by typing "on" to the field on the right. Save. Now a form will appear on the bottom of every page of the calendar. To edit user comments and set to on/offline: Navigate to the month containing the image that has been commented: My comments > Year > Month and click on the preview. - SWITCH DESIGN: The photo calendar is optimized for images up to 266 x 266 Pixel in size. With a little CSS knowledge it will be easy to alter a CSS file so it will fit for larger images as well. In case the images are very large or very different in sizes, and you know to little about Cascading Style sheets, please activate the "resize.js" choosing Config > Effects. In later version (in case they might exist) there will be multiple CSS skins for different image sizes. ATM there are two alternatives apart from default dark.css: grey.css and white.css. To skip to a different design, please navigate to Login > Config > Config and choose a CSS file from the list. - INSTALLING AN ADDITIONAL LANGUAGE: English and German are the languages implemented by default. You will find additional language packages here: http://support.webdaum/diarice/language Download and unpack the archive to your computer. You can upload the language files via FTP to folder lang or alternatively go: Login > Config > Config > Install language. Please copy and insert ( Ctrl + C, Ctrl + V) contents of the lang file to the upper field. Copy and insert contents of the help file to the second field and copy and insert contents of the read me file to the last field. Send the form. On success, you'll be forwarded to the configuration file automatically. There you can set the freshly installed language to active with a mouse click, or even to the calendar's default language.