A Quick Introduction

A quick way to offer files and documents intended for download by your web clientele

Feature Set

The recommended minimum tag to implement a file lister set is:

:::FILE_LISTER:set_id=1&sort_by=:::sort_by:::&sort_order=:::sort_order:::&display_type=:::display_type:::&new_set_id=:::new_set_id&no_collapse=1::: :::

If you hard-code the sort_by, sort_order, or display_type you'll disable the ability to interactively change the sort functionality. However, you can use other parameters to set default sort options:

:::FILE_LISTER:set_id=1&sort_by=:::sort_by:::&sort_order=:::sort_order:::&display_type=:::display_type:::&new_set_id=:::new_set_id:::&default_display_type=list&default_sort_by=date&default_sort_order=desc&date_format=pretty_date_long::: :::

default_display_type=list, icon, or quick.
default_sort_by=date, filename, size, or priority
default_sort_order=desc or asc

Other optional parameters:

• date_format: Date display format. Available options: pretty_date_long, pretty_date, date_only, none (do not display a date).
• disable_acrobat: If the current set contains PDF files, a link image at the bottom lets the user download acrobat reader. If disable_acrobat=1, this is not shown.
• disable_header: File lister will not show the image header if disable_header=1.
• disable_set_selector: File lister shows file lister set select box when there are two sets or more. However, if you pass in disable_set_selector = 1 as a variable, file lister doesn't show this file lister set select box.
• disable_display_type_selector: If disable_display_type_selector = 1 is set, it doesn't show display type change options.
• disable_column_header: File lister will not show column headers in list view if disable_column_header=1.
• disable_auto_icon: File lister will not show default icon by file type if disable_auto_icon = 1 is set.
• disable_sort_selector: File lister will not show file sort option dropdown or sortable table header depends on display type if disable_sort_selector = 1 is set.
• disable_dir_control: File lister will not show the directory name or have the ability to collapse the sub directory if disable_dir_control=1
• no_size: If no_size = 1 is passed in as a variable, file lister doesn't show file size column on List mode.
• no_date: If no_date = 1 is passed in as a variable, file lister doesn't show date column on List mode.
• columns: The number of columns in icon view is determined by the columns parameter, if set, then it is determined by the map manager's stored setting for the current set, then the filelister default setting, then three, if none of the others are set.
• view_preset: If view_preset=minimal is passed, the acrobat link, header, and set selector will be disabled, and the default sort type will be list. This results in a much more compact view.
• no_collapse: By default, file lister collapses all folders when the page is loaded. If set to 1, file lister will keep all folders expanded by default.

Filelister Administration

Managing File Lister Sets

1. Navigate to Files/Uploads > File Listers from main menu and click on "Manage File Lister Sets." from vertical menu.
2. To create a new File Lister set, provide the create form with new File Lister set information and click the "Add Set" button.
3. To update File Lister set information, update any information in the File Lister set listing, and click the "Update File Lister Sets" button.

File Lister is designed to use Upload Manager for file uploading to File Lister directories. To enable this feature, add the File Lister directory to LOCAL_UPLOADMANAGER_ALLOWED_DIRS map. For example, if you have a File Lister with designated directory /filelister_upload/, add /filelister_upload/ to the value of LOCAL_UPLOADMANAGER_ALLOWED_DIRS map.

You can set an optional default icon filename to a set. The designated directory for this file is html/filelister_images/. If default icon filename is entered for the File Lister set, the icon will be used when there is no icon file was uploaded for individual files in the File Lister.

When you are deleting an existing File Lister set, you are just deleting file information you saved for each file in the set. The actual files in the set remain in the directory.

Managing Files in a File Lister Set

To manage file information in a File Lister set, click on "List File Listers" from vertical menu and choose a set your want to manage. Then, click on "Show Files" button, and it will list all files in the designated directory for the set you chose and in its sub directories.

File Lister allows to you save the following attributes for individual files in a set: title, sub title, author, description, keywords, publish date, icon, and icon caption. Also, you can rename a file through the file information update interface.

If you want to upload files to the directory of a set, click on "Upload or Manage Files" link on top of file listing. It will lead you to Upload Manager with the File Lister set's directory pre-populated. You can upload any file using this Upload Manager interface. Then, you will see the file you uploaded when you go back to the File Lister set. To properly integrate file upload function from Upload Manager, the directory designated to the File Lister set must be added to the value of LOCAL_UPLOADMANAGER_ALLOWED_DIRS map.