Filemod

Filemod

The filemod module allows you to create custom pages in your Imagevue gallery. You can either load your own Image or SWF, or use a built-in module like slideshow or photoblinds effect to create a stunning intro page. To see a few examples, goto the demo gallery more examples page, and scroll down to Filemods and view some of the demos.

Using Filemod

To set up a filemod page, first goto admin › manage › [create new folder]. When the new folder has been created, select “use as [filemod]” in the listbox on the right – The page will reload and two new fields will appear “filemod” and “parameters“. The filemod selector lists the options:

• photoblinds
  Runs the photoblinds effect on a specific image, or a random image selected from a folder.
• slideshow
  Runs a small slideshow from images within the folder, or from a separate folder.
• randomimage
  Loads a random image from a folder.
• custom
  This setting can be used to load an external file that is not contained in the “filemods” folder.
• [files stored in imagevue/filemods/ folder]
  This setting, simply loads any file stored in the imagevue filemods folder.

Parameters

The parameters input field can often stay blank, but some filemod options require 1 or more parameters to be set. You can also use the parameters field to forward any values to your custom SWF. Several parameters can be forward in a single string by using the & character like in this example: “title=Hello&frame=true&click=togglefullscreen“. A few of the global parameters are set by default in your main settings under modules.filemod: align, frame, text, textalign, but they may be overwritten by adding the the parameter to the parameter field. Below, you will find the global parameters:

• title= – Sets a text title for a filemod. If undefined, title is inherited from folder title. If using randomimage, title is inherited from image title.
• description= – Sets a description for a filemod. If undefined, description is inherited from folder description. If using randomimage, description is inherited from image description(unless undefined)
• align= – Sets the alignment of the filemod relative to the Stage. Normal options apply: “TL,T,TR,R,BR,B,BL,L,M” – This option is globally set in settings modules.filemod.align, but may be overwritten in parameters string for a specific filemod.
• frame= – (true/false) Sets a frame around the filemod, with frame attributes inherited from image.frame in config. This option is globally set in config.filemod.frame, but may be overwritten in parameters string for a specific filemod.
• click= – Sets an action when clicking the filemod. Can be any internal link “#/folder/” or set to “togglefullscreen“. If undefined, there is not click event.
• text= – (true/false) Sets the text(title+description) on or off. This option is globally set in config.filemod.text, but may be overwritten in parameters string for a specific filemod.
• textalign= – Sets the alignment of the text relative to the filemod. Options: “above,over” – This option is globally set in config modules.filemod.textalign, but may be overwritten in parameters string for a specific filemod.

Photoblinds Filemod

Photoblinds is a basic image effect that you can use as an intro for your gallery, or in any other location as you may find it suitable. You can find an example of the photoblinds effect in action here. To create a photoblinds page, follow the basic procedure above and select “photoblinds” in the filemod dropdown box.

Photoblinds random
By default, if no parameters are set, the photoblinds module will attempt to load an image from inside the folder you currently created. Simply upload your photos here, and the photoblinds module will load a random image from the list of images in this folder.

Photoblinds random, different path
If you want your photoblinds page to load a random image from another gallery folder, then you need to add the path parameter to the parameters field. For example, if you want to load a random image from the folder content/pictures1/, then add the following line to the parameters field: path=content/pictures1/

Photoblinds image
If you want to load a specific image into your photoblinds page, you must add the image parameter to the parameters field. For example, if you want to load the image content/pictures1/jump.jpg, then add the following line to the parameters field: image=content/pictures1/jump.jpg

Using photoblinds on startpage
To use your photoblinds page as your startpage, you must goto admin › Settings › settings.startpath, and set your newly created photoblinds folder as startpath. You may want to keep the photoblinds effect as a “home” button in your main menu, or you may want to hide it like we have done in our demo gallery startpage. To do that, locate your photoblinds folder in admin, and select “hide this folder”. Keep in mind, you can also use the “click” parameter to set an event for your startpage. For example, you may want so that when the visitor clicks the startimage, they are taken to the first gallery, or into fullscreen mode. See the click-parameter listed above.

For the photoblinds effect, we strongly recommend using frame/border, and align set to M(middle), both of which are default. For other filemods, like custom pages, you most likely want to disable the frame, and that has to be done through the parameters field.

Slideshow filemod

The slideshow filemod allows you to create a simple slideshow from the images within the folder. It can be used as a startpage for your gallery, or in any other location you may find suitable. You can find an example of the slideshow module here. To create a slideshow page, follow the basic procedure at the top of this page, and then select “slideshow” in the filemod dropdown. PS! This slideshow module must not be confused with the slideshow feature in the main gallery – read more

Default Slideshow
By default, if no parameters are set, the slideshow module will attempt to load images from inside the folder you currently created. Simply upload your photos here, and the slideshow module will load images from the list of images in this folder.

Slideshow, different path
If you want to load images from another gallery folder, then you must add the path parameter to the parameters field. For example, if you want to load slideshow images from the folder content/pictures1/, then add the following line to the parameters field: path=content/pictures1/

Slideshow interval
The default interval between slides is 5 seconds, but you can change that by adding your custom interval to the parameters field: interval=7

To use the slideshow module as startpage, goto admin -> config.settings.startpath and set your new folder as startpath.

Randomimage Filemod

The randomimage filemod simply loads a random image from a folder. It can be used as a startpage for your gallery, or in any other location you may find suitable. You can find an example of the randomimage module here. To create a randomimage page, follow the basic procedure at the top, and select “randomimage” in the filemod dropdown.

Randomimage
By default, if no parameters are set, the randomimage module will attempt to load an image from inside the folder you currently created. Simply upload your photos here, and the randomimage module will load a random image from the list of images in this folder.

Randomimage, different path
If you want to load a random image from another gallery folder, then you must add the path parameter to the parameters field. For example, if you want to load a random image from the folder content/pictures1/, then add the following line to the parameters field: path=content/pictures1/

To use the randomimage page as startpage, goto admin -> config.settings.startpath and set your new folder as startpath.

Custom Filemod

You can load your own custom SWF(or picture) pages with the filemod. The easiest way to do that, is to upload your custom files into the imagevue/filemods/ folder (by FTP), and they will appear in the filemod dropdown list. You can then forward any parameters to your SWF through the parameters field. You can find an example of a custom SWF module here.

To load a file that is not stored in the imagevue/filemods/ folder, you can select “custom” in the filemod dropdown list, and use the path parameter to set what custom file to load. For example, if you want to load the file myfolder/myfile.swf, you need to set the following in the parameters field: path=myfolder/myfile.swf

parameters
For custom filemods, you may not want text, frame, and you may want to set a different stage alignment. An example of this, would be adding the following to the parameters field: align=BR&frame=false&text=false. In addition, you can of course add your own parameters that go to your custom SWF.

Additional notes

Although this method allows you to load your own SWF files, there are many restrictions. For example, complex SWF files may have code that interferes with the imagevue code, and is not compatible in some way. Also, you may find yourself having problems with the positioning of your filemod SWF. Alignment from imagevue is based on height/width of the object, compared to width and height of the stage. If you for example have an animation that starts from something small and then expands to something bigger, there will be problems with the dynamic alignment, as your swf virtually has dynamic width and height. A good remedy for this, is to create a transparent(0% alpha) square in the back of your FLA/SWF, that basically covers the maximum width and height of your SWF/animation. The square should start from top left corner(0,0) and cover the maximum width and height of your content even as it changes.

Comments are closed in preparation for new website. Use the forum or contact page.