added a help page for common problems

diff --git a/languages/en.php b/languages/en.php
index 3d669fee891d725eef020a83b492d33ef486c54e..87c431f75bca7cb24520dbd08617acff7666521a 100644 (file)
--- 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.',\r
                        'tidypics:settings:image_lib' => "Image Library",\r
                        'tidypics:settings:thumbnail' => "Thumbnail Creation",\r
+                       'tidypics:settings:help' => "Help",\r
                        'tidypics:settings:download_link' => "Show download link",\r
                        'tidypics:settings:tagging' => "Enable photo tagging",\r
                        'tidypics:settings:photo_ratings' => "Enable photo ratings (requires rate plugin of Miguel Montes or compatible)",\r

diff --git a/views/default/tidypics/admin/help.php b/views/default/tidypics/admin/help.php
new file mode 100644 (file)
index 0000000..4014be9
--- /dev/null
+++ b/views/default/tidypics/admin/help.php
@@ -0,0 +1,25 @@
+<br />\r
+<h3>White screen when uploading images</h3>\r
+<p>\r
+Tidypics tries to calculate the maximum size of an image that your server will support. If it\r
+guesses incorrectly and someone uploads a photo that is too large, the script may crash when\r
+resizing the image if you are using GD. The easiest way to test this is to set display_errors\r
+to 1 in your .htaccess file and upload large images. If this causes a problem, a php memory error\r
+should display on the screen. You can increased your php memory limit (see the docs directory).\r
+A better option is to use ImageMagick if your server supports it (again see the docs directory).\r
+</p><p>\r
+If it is not a memory issue, you should see some other error appear. Once you have fixed the error,\r
+change display_error back to 0.  \r
+</p>\r
+<h3>Question mark images appear</h3>\r
+<p>\r
+If you see question mark images when you look at your albums, this means the resizing of the images\r
+failed. This could be due to the memory limits as described above. There are other causes. Tidypics\r
+tries to detect these problems and write the cause to the error log. You should check your server\r
+error log right after an upload that results in a question mark for these error messages. The messages\r
+will begin with "Tidypics warning:". It is possible if you have turned off php warnings that you will \r
+not see these warnings.\r
+</p><p>\r
+Another possible cause is using ImageMagick when your server does not support it or specifying\r
+the wrong path to the ImageMagick executables.\r
+</p>
\ No newline at end of file

diff --git a/views/default/tidypics/admin/tidypics.php b/views/default/tidypics/admin/tidypics.php
index 7aeb3a195983d8be464e95b9f810d76f3f1adbfb..fa518156ca178852721dce52586687023ceae267 100644 (file)
--- 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>