loading

‘Finished Projects’

x

More galleries...

working

please wait...

/*

xFlow!

Created by Paul Whitrow - http://xflow.pwhitrow.com

xFlow! Software License - see xFlow! Software License.html in the xFlow! root directory

NB, These instructions are subject to change relating to any new release.

Please refer to the official xFlow! forum for help: http://xflow.pwhitrow.com/forum

*/

This document covers the installation, updating and administration proceedure
required for xFlow!

General Overview
----------------
xFlow! requires no database to function, but does store it's data in a flat
XML file. This file is called images.xml (by default) and will be stored in the same 
directory as the gallery that it relates to. Therefore, the main gallery directory 
(called 'galleries' by default) will need write permissions (755) in order to create 
directories, upload items and update the data file.

The file private/xflow_definitions.php controls xFlow! and so such there are 
changeable settings within. These include setting the main URL of the parent site, 
the directory name that xFlow! is installed in, and the write permissions allowed,
plus many others.

A site map is dynamically created and stored in the galleries directory. This can
be accessed externally for SEO (Search Engine Optimization) enhancement. This file
will also need write access permissions (755).

Click on any question mark icon within xFlow! for help relating to that item.


Contents
========

1. Settings
2. Installation Instructions
3. Administration Instructions
4. Updateing Instructions

1. Settings
-----------

All global settings within xFlow! are stored in the definitions file (xflow_definitions.php) 
found within the /private directory.


2. Installation Instructions
----------------------------
2.1 Extract the downloaded ZIP file to a location on your local machine.
2.2 Change the default admin password (DEF_XFLOW_ADMINPASS) to one of your own.
2.3 Change any other settings as you require.
2.4 Copy all files in the main xFlow! (/xflow/) directory to your webserver.
2.5 Set the directory permisions for the main gallery directory and all sub directories and files (755).


3. Administration Instructions
------------------------------

3.1 Login/Logout
3.2 New gallery
3.3 Deleting a gallery
3.4 Uploading Items to a gallery
3.5 Editing Images in a gallery
3.6 Changing the position of an item in a gallery
3.7 Deleting items from a gallery
3.8 Creating a gallery automatically (manual directory)
3.9 Creating a gallery automatically (ZIP upload)
3.10 Editing gallery options
3.11 Re-issuing after template change
3.12 Creating a gallery from a Flickr RSS feed
3.13 Creating a gallery from a YouTube RSS feed
3.14 Changing the Favicon for a gallery


3.1 Login/Logout:

    3.1.1 Login to xFlow! by pressing the key combination Ctrl + Shift + x, or by adding /admin to the main URL 
          (eg, yourwebsite.com/xflow/admin). 
    3.1.2 Enter your password (default is: xflow) in the box provided and click the 'Login' button. 
          You will automatically be returned to the index page upon successful login.
    3.1.3 To logout, press the key combination Ctrl + Shift + x or click on the 'Logout' link at the top of xFlow!.
    3.1.4 Click on the logout button.

3.2 New Gallery:

    3.2.1 Click on the 'New Gallery' link at the top of xFlow!.
    3.2.2 Enter the name of your new gallery in the box provided under the 'New Gallery' section, and click the 'Create' button.
    3.2.3 A confirmation message will be displayed and you will be automatically redirected to the 'Gallery Options' section. 
          The gallery you created should be pre-selected in the directory list at the top of the 'Gallery Options' section. 
          If not, select it and click the 'Edit' button.
    3.2.4 Now you can enter your gallery details in the boxes provided. Default settings will be pre-loaded into the form fields.
    3.2.5 When all information has been entered, click on the 'Save' button to create the gallery.
    3.2.6 You will get a confirmation message when the gallery has been created. Click on the link
          in the 'Return to Gallery' link at the top of xFlow! to go directly to your new gallery.

3.3 Deleteing a gallery:

    3.3.1 Click on the 'Gallery Options' link at the top of xFlow!.
    3.3.2 The gallery you are editing should be pre-selected in the 'Gallery options' section at the top.
          If not, select it and click the 'Edit' button.
    3.3.3 Check the 'Delete directory?' checkbox.
    3.3.4 Click the 'Save' button.

3.4 Uploading Items to a gallery:

    3.4.1 Click on the 'Gallery Items' link at the top of xFlow!.
    3.4.2 Click on the tab for the media type you want to upload (image, video or audio).

    3.4.3 Uploading an Image

	  3.4.3.1 Select the image you wish to upload by clicking the 'Browse' button, 
		  or entering the URL of a remote (online) image in the 'Remote Image' box.
	  3.4.3.2 Enter a title for your image (or leave blank).
	  3.4.3.3 Check the box 'Filename for title' to display image file name instead of any title text
	  3.4.3.4 Enter a description for your image (or leave blank).
	  3.4.3.5 Select a resize value for your image if required (or leave blank).
	  3.4.3.6 Select the degrees to rotate your image if required.
	  3.4.3.7 Select an effect to apply to your image (Sepia or Greyscale).
	  3.4.3.8 Check the watermark box to add a watermark to the bottom right of your uploaded image.
	  3.4.3.9 Click the 'Upload Image' button to upload your new image.
	  3.4.3.10 Enter any additional code you may require in the 'Code' box provided.
	  3.4.3.11 Repeat process as required.

    3.4.4 Uploading a Video

	  3.4.4.1 Select the video you wish to upload by clicking the 'Browse' button, 
		  or entering the URL of a remote (online) video in the 'Remote Video' box.
	  3.4.4.2 Select an image to display for your video by clicking on the 'Browse' button, 
		  or leave blank to have the default image used.
	  3.4.4.3 Enter a title for your video (or leave blank).
	  3.4.4.4 Check the box 'Filename for title' to display video file name instead of any title text
	  3.4.4.5 Enter a description for your video (or leave blank).
	  3.4.4.6 Select an effect to apply to your display image (Sepia or Greyscale).
	  3.4.4.7 Check the watermark box to add a watermark to the bottom right of your uploaded display image.
	  3.4.4.8 Enter any additional code you may require in the 'Code' box provided.
	  3.4.4.9 Click the 'Upload Video' button to upload your new video.
	  3.4.4.10 Repeat process as required.

    3.4.5 Uploading an Audio File

	  3.4.5.1 Select the audio file you wish to upload by clicking the 'Browse' button.
	  3.4.5.2 Select an album art image to display for your audio file by clicking on the 'Browse' button, 
		  or entering the URL of a remote (online) image in the 'Remote Image' box, or leave blank to 
		  have the default image used.
	  3.4.5.3 Check the box 'Use ID3 Tags' to to have the title and description fields populated with the ID3 
	          data from the audio file (if it exists).
	  3.4.5.4 Enter a title for your audio file (or leave blank).
	  3.4.5.5 Check the box 'Filename for title' to display the file name instead of any title text
	  3.4.5.6 Enter a description for your audio file (or leave blank).
	  3.4.5.7 Select the degrees to rotate your image if required.
	  3.4.5.8 Select an effect to apply to your display image (Sepia or Greyscale).
	  3.4.4.9 Enter any additional code you may require in the 'Code' box provided.
	  3.4.5.10 Click the 'Upload Audio' button to upload your new audio file.
	  3.4.5.11 Repeat process as required.

3.5 Editing Items in a gallery:

    3.5.1 From the gallery you are viewing, click on the 'Gallery Items' link at the top of xFlow!.
    3.5.2 Click on the image you wish to edit from the thumbnails displayed.
    3.5.3 Change it's details in the editing section.
    3.5.4 You can have the item link to an external website by entering a single URL (web address) in the 
          description box.
    3.5.5 You can add extra HTML code (such as a button) to the image by entering the code into the
          code box provided.
    3.5.6 Click the 'Save' button when you have finished making changes.

3.6 Changing the position of an item in a gallery:
    
    3.6.1 From the gallery you are viewing, click on the 'Gallery Items' link at the top of xFlow!.
    3.6.2 Click on a thumbnail from the list provided and hold the mouse button down.
    3.6.3 Drag the thumbnail to it's desired location and release the mouse button.
    3.6.4 Repeat process as required.
    3.6.5 Click the 'Save' button in the 'Gallery Items' section when you have finished making changes.

3.7 Deleting items from a gallery:

    3.7.1 From the gallery you are viewing, click on the 'Gallery Items' link at the top of xFlow!.
    3.7.2 Hover over the items you wish to remove and tick the displayed checkbox. Select as many items as you wish.     
    3.7.3 Click the revealed 'Delete' button to delete the selected items.
    3.7.4 Click the 'Clear' button to unselect all checked items.

3.8 Creating a gallery automatically (manual directory):

    3.8.1 Create the directory directly in the galleries directory on your webserver, and upload items into it.
    3.8.2 Click on the 'New Gallery' link at the top of xFlow!.
    3.8.3 Click the 'from Directory' tab.
    3.8.4 Select the directory you created from the list avaialable.
    3.8.5 Click on the 'Create Gallery' button. xFlow! will create the XML file and the thumbs directory 
          required for the new gallery.
    3.8.6 When the images within your directory are processed, you should be taken to the 'Gallery Options' page.
    3.8.7 The gallery you are editing should be pre-selected in the 'Gallery List' section at the top.
          If not, select it and click the 'Edit' button.
    3.8.8 Enter the information for your gallery as required into the text boxes provided. You can
          also change any other paremeters you wish.
    3.8.9 Click on the 'Save' button to update the XML file.
    3.8.10 Click on the 'Return to Gallery' link. xFlow! will create the thumbnails and take you to your new gallery. 
	  NOTE: This can take some time depending on the amount of items you have in the gallery.
	  If you do get a timeout error, just refresh the browser and xFlow! should continue building
	  your thumbnails from where it left off.

3.9 Creating a gallery automatically (ZIP upload):

    3.9.1 Click on the 'New Gallery' link at the top of xFlow!.
    3.9.2 Click the 'from ZIP' tab.
    3.9.3 Enter a title for your new gallery.
    3.9.4 Select the ZIP archive you wish to upload by clicking the 'Browse' button, and finding your chosen ZIP file.
    3.9.5 Click on the 'Create Gallery' button. xFlow! will upload the ZIP file, extract all items from it 
         (both image and video [FLV] can be included), and then build your gallery using default options.
    3.9.6 When the images within your directory are processed, you should be taken to the 'Gallery Options' page.
    3.9.7 Edit your gallery options as required, then click on the 'Return to Gallery' link at the top of xFlow!. 

3.10 Editing gallery options:

    3.10.1 Click on the 'Gallery Options' link at the top of xFlow!.
    3.10.2 The gallery you are editing should be pre-selected in the 'Gallery options' section at the top.
           If not, select it and click the 'Edit' button.
    3.10.3 Update any of the options available.
    3.10.4 Click the 'Save' button when you have finished making changes.
    3.10.5 Click on the 'Return to Gallery' link at the top of xFlow!. 

3.11 Re-issuing after template change

    3.11.1 Click on the 'Re-Issue' link at the top of xFlow!.
    3.11.2 Click on the 'Do it now!' button.

3.12 Creating a gallery from Flickr

    3.12.1 Click on the 'Social' link at the top of xFlow!.
    3.12.2 Click on the 'Flickr' tab.
    3.12.3 Enter your Flickr API key (apply here http://www.flickr.com/services/apps/create/apply/)
    3.12.4 Enter the user's name for the Flickr account (obtained from the Flickr URL for said account)
    3.12.5 Enter the set ID (or leave blank if not required) for the Flickr account (obtained from the 
           Flickr URL for said account)
    3.12.6 Enter the number of items to retrieve
    3.12.7 Set the resize value for the images (if required).
    3.12.8 Click the 'Create Gallery' button.

3.13 Creating a gallery from YouTube

    3.13.1 Click on the 'Social' link at the top of xFlow!.
    3.13.2 Click on the 'YouTube' tab.
    3.13.3 Enter the desired YouTube user's name into the box provided.
    3.13.4 Click the 'Create Gallery' button.

3.14 Changing the Favicon for a gallery

    3.14.1 From the gallery you are viewing, click on the 'Gallery Items' link at the top of xFlow!.
    3.14.2 Click the thumbnail you wish to use from the list displayed.
    3.14.3 Check the 'Use for Favicon' option next to the image of your choice.
    3.14.4 Click the 'Save' button in the 'Gallery Items' section when you have finished making changes.


4. Updating Instructions
----------------------------
xFlow! displays your current version in the top left of the Administration menu bar.
If an update is available, a download link will be displayed. Click this link to have
xFlow! automatically download and install the latest version.