diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configure_server.txt | 55 | ||||
| -rw-r--r-- | docs/css_guide.txt | 87 | ||||
| -rw-r--r-- | docs/extending_tidypics.txt | 39 | 
3 files changed, 0 insertions, 181 deletions
diff --git a/docs/configure_server.txt b/docs/configure_server.txt deleted file mode 100644 index 32fb5d86e..000000000 --- a/docs/configure_server.txt +++ /dev/null @@ -1,55 +0,0 @@ -Server Configuration
 ------------------------------------
 -
 -Run your server analysis located in the Tidypics Administration section and 
 -then read through this document.
 -
 -If you are experiencing errors, please check your server error log. Tidypics 
 -writes warnings for most upload related problems. You will see something 
 -along these lines: "Tidypics warning: user exceeded post limit on image upload"
 -
 -
 -
 -GD: Elgg requires GD for image resizing. Tidypics uses GD by default for 
 -resizing. There are two versions GD and GD2. It generally does not matter 
 -which one you are using and it isn't always apparent which one you are
 -running anyway.
 -
 -ImageMagick: A significantly better image library than GD. There is a command-line
 -version that is commonly available on servers and a PHP extension call imagick that
 -you can install on your server (if you have control of your server).
 -
 -exec: Calls to ImageMagick command-line utilities like convert require that
 -exec() be available. On some servers it will be disabled for security reasons.
 -
 -Memory Available to PHP: The amount of RAM available to a single PHP 
 -process. This can have an effect on how large an image you can resize
 -(especially if you are running Tidypics with GD). The best place to
 -change it is .htaccess.
 -
 -Memory Used to Load This Page: This gives you a baseline of how much
 -memory is being used to load the Elgg framework and plugins. 
 -
 -Max File Upload Size: The largest file that can be uploaded. You can
 -adjust this in .htaccess.
 -
 -Max Post Size: The largest amount of data that can be submitted. For
 -Tidypics, this affects how many large images can be uploaded in a 
 -single upload. If this is exceeded, nothing is uploaded and the 
 -user gets an error message. It can be adjusted in .htaccess.
 -
 -Max Input Time: This is the amount of time PHP will wait for an 
 -upload to finish. Your users may experience failures if they are
 -uploading large images on a poor connection or if your server 
 -does not have a lot of bandwidth.
 -
 -Max Execution Time: The longest time a PHP script can run on your
 -server. If a user uploads many large images, the resize code may take
 -a long time to complete and will be stopped by PHP. If you are seeing
 -problems with this, you probably have a slow server.
 -
 -GD imagejpeg: jpeg resizing with GD
 -
 -GD imagegif: gif resizing with GD
 -
 -GD imagepng: png resizing with GD
\ No newline at end of file diff --git a/docs/css_guide.txt b/docs/css_guide.txt deleted file mode 100644 index 9663cad1a..000000000 --- a/docs/css_guide.txt +++ /dev/null @@ -1,87 +0,0 @@ -Views:
 ------------------
 -all albums view
 -album view
 -image view
 -upload view
 -
 -
 -CSS elements:
 --------------------------
 -#tidypics_wrapper - wrapper on image view 
 -
 -#tidypics_breadcrumbs - breadcrumbs on image and album views
 -
 -#tidypics_desc - description/caption in image and album views 
 -
 -.tidypics_info - holds metadata about image/album like tags
 -
 -#tidypics_controls - image view controls (download, start tagging, etc.)
 -
 -.tidypics_album_images - border around images - needs work
 -
 -#tidypics_image_nav - back and next nav controls in image view
 -
 -#tidypics_image_full - not used
 -
 -#tidypics_image_wrapper - margins for image in image view
 -
 -#tidypics_image - frame
 -
 -.tidypics_album_cover - all albums view and river images 
 -
 -.tidypics_album_widget_single_item 
 -
 -.tidypics_album_gallery_item 
 -
 -
 -/* ------ tidypics widget view ------  */
 -
 -#tidypics_album_widget_container 
 -
 -.tidypics_album_widget_timestamp 
 -
 -/* ---------  image upload/edit forms  ------------   */
 -
 -#tidpics_image_upload_list 
 -
 -.tidypics_edit_image_container 
 -
 -.tidypics_edit_images 
 -
 -.tidypics_image_info 
 -
 -
 -/* ---- tidypics group css ----- */
 -
 -#group_albums_widget 
 -
 -
 -/* ---------  tidypics river items ------------   */
 -
 -.river_object_image_create 
 -
 -.river_object_album_create 
 -
 -.river_object_image_comment 
 -
 -.river_object_album_comment 
 -
 -/* ----------- tagging ---------------- */
 -#tidypics_tag_instructions 
 -
 -#tidypics_tag_instruct_text 
 -
 -#tidypics_tag_instruct_button_div 
 -
 -#tidypics_tag_instruct_button 
 -
 -#tidypics_tag_menu 
 -
 -#tidypics_delete_tag_menu 
 -
 -.tidypics_tag 
 -
 -.tidypics_tag_text 
 -
 -#tidypics_phototags_list 
 diff --git a/docs/extending_tidypics.txt b/docs/extending_tidypics.txt deleted file mode 100644 index 55e6b5dd5..000000000 --- a/docs/extending_tidypics.txt +++ /dev/null @@ -1,39 +0,0 @@ -Extending Tidypics
 ------------------------------------
 -
 -*** DISPLAYING THE LATEST PHOTOS ***
 -In tidypics/lib/tidypics.php, there is a function tp_get_latest_photos().
 -It can be used to display the site-wide latest photos or an individual
 -user's latest photos. The documentation explains how you could use that
 -function to display the latest photos on your front page if you are using
 -the custom front page tutorial plugin from Curverider. 
 -
 -
 -*** MAKING TIDYPICS MATCH YOUR THEME ***
 -Please check the css guide found in this directory. This will list the 
 -different css elements and where they are used.
 -
 -
 -*** TIDYPICS EVENTS ***
 -1. album created: 'add', 'tp_album'
 -2. album updated: 'update', 'tp_album'
 -3. album deleted: 'delete', 'tp_album'
 -4. photos uploaded: 'upload', 'tp_album' - triggered after a set have been uploaded and resized
 -5. photo uploaded: 'upload', 'tp_image' - triggered after each image is resized
 -6. photo edited: 'update', 'tp_image'
 -7. photo deleted: 'delete', 'tp_image'  
 -
 -*** TIDYPICS PLUGIN HOOKS ***
 -1. album slideshow: 'tp_slideshow', 'album' - return false to not have a slideshow, otherwise return link to slideshow
 -2. watermark - return false to prevent default watermark
 -    'tp_watermark', 'gd' 
 -    'tp_watermark', 'imagick'
 -    'tp_watermark', 'imagemagick'
 -3. image link: 'tp_image_link', 'image' - return false for no link or a url otherwise - params passed to this will porbably change in 1.7
 -    
 -    
 -*** IMAGE MENU EXTENSIONS ***
 -Below an image is a div called tidypics_controls. By default it contains controls
 -like tagging or downloading an image. You can change what is shown there by overridding
 -or extending the tidypics/image_menu view.
 -
  | 
