From edd03acb340891ffa8ca973ca2ab24f87aa32158 Mon Sep 17 00:00:00 2001
From: Cash Costello <cash.costello@gmail.com>
Date: Sat, 12 Dec 2009 03:50:17 +0000
Subject: added a help page for common problems

---
 languages/en.php                          |  1 +
 views/default/tidypics/admin/help.php     | 25 +++++++++++++++++++++++++
 views/default/tidypics/admin/tidypics.php |  8 ++++++++
 3 files changed, 34 insertions(+)
 create mode 100644 views/default/tidypics/admin/help.php

diff --git a/languages/en.php b/languages/en.php
index 3d669fee8..87c431f75 100644
--- a/languages/en.php
+++ b/languages/en.php
@@ -64,6 +64,7 @@
 			'tidypics:admin:instructions' => 'These are the core Tidypics settings. Change them for your setup and then click save.',
 			'tidypics:settings:image_lib' => "Image Library",
 			'tidypics:settings:thumbnail' => "Thumbnail Creation",
+			'tidypics:settings:help' => "Help",
 			'tidypics:settings:download_link' => "Show download link",
 			'tidypics:settings:tagging' => "Enable photo tagging",
 			'tidypics:settings:photo_ratings' => "Enable photo ratings (requires rate plugin of Miguel Montes or compatible)",
diff --git a/views/default/tidypics/admin/help.php b/views/default/tidypics/admin/help.php
new file mode 100644
index 000000000..4014be9ce
--- /dev/null
+++ b/views/default/tidypics/admin/help.php
@@ -0,0 +1,25 @@
+<br />
+<h3>White screen when uploading images</h3>
+<p>
+Tidypics tries to calculate the maximum size of an image that your server will support. If it
+guesses incorrectly and someone uploads a photo that is too large, the script may crash when
+resizing the image if you are using GD. The easiest way to test this is to set display_errors
+to 1 in your .htaccess file and upload large images. If this causes a problem, a php memory error
+should display on the screen. You can increased your php memory limit (see the docs directory).
+A better option is to use ImageMagick if your server supports it (again see the docs directory).
+</p><p>
+If it is not a memory issue, you should see some other error appear. Once you have fixed the error,
+change display_error back to 0.  
+</p>
+<h3>Question mark images appear</h3>
+<p>
+If you see question mark images when you look at your albums, this means the resizing of the images
+failed. This could be due to the memory limits as described above. There are other causes. Tidypics
+tries to detect these problems and write the cause to the error log. You should check your server
+error log right after an upload that results in a question mark for these error messages. The messages
+will begin with "Tidypics warning:". It is possible if you have turned off php warnings that you will 
+not see these warnings.
+</p><p>
+Another possible cause is using ImageMagick when your server does not support it or specifying
+the wrong path to the ImageMagick executables.
+</p>
\ No newline at end of file
diff --git a/views/default/tidypics/admin/tidypics.php b/views/default/tidypics/admin/tidypics.php
index 7aeb3a195..fa518156c 100644
--- a/views/default/tidypics/admin/tidypics.php
+++ b/views/default/tidypics/admin/tidypics.php
@@ -8,6 +8,7 @@
 	$statsselect = '';
 	$imagelibselect = '';
 	$thumbnailselect = '';
+	$helpselect = '';
 	switch($tab) {
 		case 'settings':
 			$settingsselect = 'class="selected"';
@@ -21,6 +22,9 @@
 		case 'thumbnail':
 			$thumbnailselect = 'class="selected"';
 			break;
+		case 'help':
+			$helpselect = 'class="selected"';
+			break;
 	}
 	
 ?>
@@ -31,6 +35,7 @@
 			<li <?php echo $statsselect; ?>><a href="<?php echo $CONFIG->wwwroot . 'mod/tidypics/pages/admin.php?tab=stats'; ?>"><?php echo elgg_echo('tidypics:stats'); ?></a></li>
 			<li <?php echo $imagelibselect; ?>><a href="<?php echo $CONFIG->wwwroot . 'mod/tidypics/pages/admin.php?tab=imagelib'; ?>"><?php echo elgg_echo('tidypics:settings:image_lib'); ?></a></li>
 			<li <?php echo $thumbnailselect; ?>><a href="<?php echo $CONFIG->wwwroot . 'mod/tidypics/pages/admin.php?tab=thumbnail'; ?>"><?php echo elgg_echo('tidypics:settings:thumbnail'); ?></a></li>
+			<li <?php echo $helpselect; ?>><a href="<?php echo $CONFIG->wwwroot . 'mod/tidypics/pages/admin.php?tab=help'; ?>"><?php echo elgg_echo('tidypics:settings:help'); ?></a></li>
 		</ul>
 	</div>
 <?php
@@ -47,6 +52,9 @@
 		case 'thumbnail':
 			echo elgg_view("tidypics/admin/thumbnails");
 			break;
+		case 'help':
+			echo elgg_view("tidypics/admin/help");
+			break;
 	}
 ?>
 </div>
-- 
cgit v1.2.3