DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: DAM Downloads¶
| Author: | Kasper Skårhøj |
|---|---|
| Created: | 2002-11-01T00:32:00 |
| Changed by: | Rupert Germann |
| Changed: | 2006-05-11T18:33:07 |
| Author: | Daniel Thomas |
| Email: | dt@dpool.net |
| Info 3: | |
| Info 4: |
EXT: DAM Downloads¶
Extension Key: dam_downloads
Copyright 2004, Daniel Thomas, <dt@dpool.net>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.com
Table of Contents¶
EXT: DAM Downloads 1
Introduction 1
What does it do? 1
Users manual 1
FAQ 1
Adminstration 1
FAQ 1
Configuration 1
FAQ 2
Reference 2
Tutorial 4
Known problems 4
To-Do list 4
Changelog 4
Introduction¶
What does it do?¶
The extension contains a frontend plugin which displays records from the Media module based on the categorisation made in the Media module. Display of lists of records and details of single records is fully configurable through TypoScript and HTML-templates. The plugin handles any given file type. Images are displayed with thumbnails.
It is possible to configure individual downloadlinks for each file. Alternatively, files can be added to session stored download list. Users can then download the whole list via a dynamically created zip- archive.
Configuration¶
FAQ¶
Reference¶
General Configuration¶
plugin.tx_damdownloads_pi1:
pid¶
Property
pid
Data type
int
Description
Every DAM installation has a priviliged page on which records are stored in the pagetree. Specifiy this ID here.
Default
0
imgTypes¶
Property
imgTypes
Data type
String, comma separated list
Description
Specifiy those file types which should be regarded as images and are therefore being processed by ImageMagick.
Default
Jpg, jpeg, gif, tif, png
template¶
Property
template
Data type
fileresource
Description
HTML template file
Default
EXT:dam_downloads/pi1/template.tmpl
restricted¶
Property
restricted
Data type
boolean
Description
With this parameter set you can restrict the display of records to those file-types which are defined as a comma separated list under
restricted.fileTypes
Default
0
restricted.fileTypes¶
Property
restricted.fileTypes
Data type
String, comma separated list
Description
See restricted
Default
jpg, jpeg, gif, tif, png
searchFieldList¶
Property
searchFieldList
Data type
String, comma separated
Description
List of meta data fields which are included in textsearch.
Default
icons_small¶
Property
icons_small
Data type
array
Description
Each of these keys of this typoscript array represents a standard thumbnail image for a given filetype. Example:
icons_small.xls = <img src=”fileadmin/image_for_excel_documents.gif” />
This directive results in the image “image_for_excel_documents.gif” being displayed in the ###DOC### marker of the display if the file_type of the record is xls. Each entry in this array has to correspond to a file_type in the DAM. If no entry is available for a file_type the entry in icons_small.noImg will be displayed.
Default
icons_large¶
Property
icons_large
Data type
array
Description
See icons_small. For detail view of record.
Default
plugin.tx_damdownloads_pi1.downloads:
Configuration for the download functionality. The plugin uses an external class to produce a
filename¶
Property
filename
Data type
string
Description
Name for the file which will be dynamically created by the zip class.
Default
download.zip
directoryName¶
Property
directoryName
Data type
string
Description
Name of the folder into which the files will be extracted when the user extracts the zip-file.
Default
t3downloads/
Hint:
the paramter absolutePathPrefix is not needed anymore in dam_downloads version 1.1.0 and higher.
plugin.tx_damdownloads_pi1.browsebar:
Configuration for the browsebar
start.btn¶
Property
start.btn
Data type
string
Description
String to be displayed as link to the first page
Default
start.std¶
Property
start.std
Data type
->stdWrap
Description
stdWrap start.btn is passed through before output.
Default
back.btn¶
Property
back.btn
Data type
string
Description
String to be displayed as link to the previous page
Default
back.std¶
Property
back.std
Data type
->stdWrap
Description
stdWrap back.btn is passed through before output.
Default
page.btn¶
Property
page.btn
Data type
string
Description
String to be appended to the integer of the pagelinks.
Default
page.std¶
Property
page.std
Data type
->stdWrap
Description
stdWrap each pagelink is passed through before output.
Default
page.stdAct¶
Property
page.stdAct
Data type
->stdWrap
Description
stdWrap the current pagelink is passed through before output.
Default
next.btn¶
Property
next.btn
Data type
string
Description
String to be displayed as link to the next page
Default
next.std¶
Property
next.std
Data type
->stdWrap
Description
stdWrap next.btn is passed through before output.
Default
end.btn¶
Property
end.btn
Data type
string
Description
String to be displayed as link to the last page
Default
end.std¶
Property
end.std
Data type
->stdWrap
Description
stdWrap last.btn is passed through before output.
Default
first¶
Property
first
Data type
->stdWrap
Description
stdWrap the start and back parts are passed through together before output
Default
second¶
Property
second
Data type
->stdWrap
Description
stdWrap the pagelinks are passed through together before output
Default
third¶
Property
third
Data type
->stdWrap
Description
stdWrap the next and end parts are passed through together before output
Default
whole¶
Property
whole
Data type
->stdWrap
Description
stdWrap the first, second and third parts are passed through together before output
Default
plugin.tx_damdownloads_pi1.listView:
results_at_a_time¶
Property
results_at_a_time
Data type
int
Description
How many records displayed on one screen
Default
8
maxPages¶
Property
maxPages
Data type
uint
Description
How many pages displayed in the browsebar
Default
20
orderBy¶
Property
orderBy
Data type
string
Description
SQL ORDER BY string
Default
ORDER BY title
rewind¶
Property
rewind
Data type
boolean
Description
If set then the browsebar will display a link back to the first browsepage every time.
Default
1
cue¶
Property
cue
Data type
boolean
Description
If set then the browsebar will display a link back to the last browsepage every time.
Default
1
cols¶
Property
cols
Data type
int
Description
Number of columns the listView is displayed with.
Default
4
templatePrefix¶
Property
templatePrefix
Data type
string
Description
In the template file there are several subparts for the display types. Based on value of this parameter records will be displayed with the template subpart ###LIST_ITEM###.
If you change the value to SOME_OTHER_VALUE the application will expect a subpart ###SOME_OTHER_VALUE_ITEM###
Default
LIST
imageType¶
Property
imageType
Data type
string
Description
Don't change. Internal information
Default
icons_small.
image¶
Property
image
Data type
->cObj
Description
Configuration for display of thumbnails if record is an image.
Default
std.¶
Property
std.
Data type
array
Description
Each displayable record field's content is passed through stdWrap before output with configuration given in std.NAME_OF_FIELD:
title
description
search_content
language
copyright
file_name
file_path
file_size
file_dl_name
creator
hpixels
vpixels
crdate
tstamp
file_ctime
category
Default
plugin.tx_damdownloads_pi1.singleView:
std¶
Property
std
Data type
array
Description
See. plugin.tx_damdownloads_pi1.listView.std
Default
imgType¶
Property
imgType
Data type
string
Description
Don't change.
Default
icons_large.
templatePrefix¶
Property
templatePrefix
Data type
string
Description
See above
Default
DETAIL
Template Subparts:
###LIST_ITEM###¶
Name
###LIST_ITEM###
###LIST_ITEM_NOIMG###
###COLLECT_ITEM###
###COLLECT_ITEM_NOIMG###
###DETAIL_ITEM###
###DETAIL_ITEM_NOIMG###
Description
Single record in various display modes. Each of the three display modes takes different subparts based on the file being an image or not.
MARKER:
###DOC###
###TITLE###
###CRDATE###
###FILE_TYPE###
###FILE_SIZE###
###DESCRIPTION######ABSTRACT###
###SEARCH_CONTENT###
###LANGUAGE###
###COPYRIGHT###
###FILE_NAME###
###FILE_PATH###
###FILE_DL_NAME###
###CREATOR###
###HPIXELS###
###VPIXELS###
###TSTAMP###
###FILE_CTIME###
###CATEGORIES###
WRAPPEDSUPPARTMARKER:
###LINK_DETAIL###
###LINK_DL_FILE###
###LINK_SAVE### add record to downloadlist
###LINK_DELETE### remove record from downloadlist
Default
###LIST_ROW###¶
Name
###LIST_ROW###
###COLLECT_ROW###
Description
Template for on row in either list or downloadlist display.
MARKER:
###ITEMS### - all items in one row
Default
###LIST_MAIN###¶
Name
###LIST_MAIN###
###COLLECT_MAIN###
Description
Template for all rows:
MARKER:
###ITEMS### - all rows
###BROWSERESULTS###
###BROWSELINKS###
###DOWNLOAD_ZIP### link to trigger the download of the zip archive
Default
###SEARCH###¶
Name
###SEARCH###
Description
Template for search part:
MARKER:
###FORM_URL###
###SWORDS###
###OPTIONS###
SUBPART:
###CATEGORIES###
Default
Tutorial¶
Known problems¶
To-Do list¶
Changelog¶
EXT: DAM Downloads - 4