.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt =================== EXT: sb\_downloader =================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Kurt Kunig :Changed: 2015-10-09T10:04:36.970000000 :Author: Sebastian Baumann :Email: sb@sitesystems.de :Info 3: :Info 4: .. _EXT-kk-downloader: EXT: kk\_downloader =================== Extension Key: **kk\_downloader** **Copyright 2008, Kurt Kunig, < `kurt.kunig@kupix.de `_ >** Copyright 2000-2002, Sebastian Baumann, Thanks Sebastian for the Initial idea and the source code until 0.1.2 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: Table of Contents ----------------- **`EXT: kk\_downloader 1 <#1.EXT:%20kk_downloader|outline>`_** **`Introduction 1 <#1.1.Introduction|outline>`_** `What does it do? 1 <#1.1.1.What%20does%20it%20do_|outline>`_ `Credits (look into the changelog at the end of this manual): 1 <#1.1. 2.Credits%20(look%20into%20the%20changelog%20at%20the%20end%20of%20thi s%20manual):|outline>`_ `Screenshots 2 <#1.1.3.Screenshots|outline>`_ **`User manual 3 <#1.2.User%20manual|outline>`_** `Install the Extension 3 <#1.2.1.Install%20the%20Extension|outline>`_ `Create the sites (data folder, ...) 3 <#1.2.2.Create%20the%20sites%20(data%20folder,%20...)|outline>`_ `Add Categories and Partners in the data folder 3 <#1.2.3.Add%20Catego ries%20and%20Partners%20in%20the%20data%20folder|outline>`_ `Configure the options: LIST-view 4 <#1.2.5.Configure%20the%20options :%20LIST-view|outline>`_ `Configure the options: SINGLE-view 4 <#1.2.6.Configure%20the%20options:%20SINGLE-view|outline>`_ **`Template setup - configuration 5 <#1.3.Template%20setup%20-%20configuration|outline>`_** `Reference 5 <#1.3.1.Reference|outline>`_ `Used Markers 9 <#1.3.2.Used%20Markers|outline>`_ `Static css file 9 <#1.3.3.Static%20css%20file|outline>`_ `Standard HTML-Template 10 <#1.3.4.Standard%20HTML-Template|outline>`_ **`FAQ 11 <#1.4.FAQ|outline>`_** **`Changelog 12 <#1.5.Changelog|outline>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Download system with many features. Displays downloads with short description, click counter, file size and image preview. It is possible to create a detail site of each download. .. _Credits-look-into-the-changelog-at-the-end-of-this-manual: Credits (look into the changelog at the end of this manual): ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From Sebastian: Thanks to Kurt Kunig ( `www.kupix.de `_ ) for several add-ons and manual revision. From Kurt: Thanks to Sebastian Baumann for the initial idea and the source base of version 0.1.2 .. _Screenshots: Screenshots ^^^^^^^^^^^ Standard **without** image preview: |img-1| Standard **with** image preview: |img-2| |img-3| Complete list of all downloads (no “starting point” selected and “ **plugin.tx\_kkdownloader\_pi1.defaultDownloadPid = all** ” and a separate html-template selected in the typoscript setup): .. _User-manual: User manual ----------- To setup and use the extension, you should do the following: Install The Extension Create Or Set a Data Folder (Sysfolder, named “download-container” e.g.) and point on himself in the field “ **General Record Storage page** “! This is important for finding the categories later on!You can also put a download object into a “normal” page instead of a sysfolder; the sysfolder then is only for the general categories. Don't forget to point to that sysfolder from this page in the “General Record Storage Page”. Add Categories and Downloads into this data sysfolder or the downloads into the page where he should be visible. Create a new page and add the Extension (and add download items if they are not in a sysfolder) Configure the options .. _Install-the-Extension: Install the Extension ^^^^^^^^^^^^^^^^^^^^^ The first step you need to do is to install the extension – **kk\_downloader** -- with the extension manager. You can get it by going to Tools section and choosing “Ext Manager” on the main action menu (usually on left-side). Then in the dropdown Menu at the top, select “Import Extensions” in the Menu at top. Then type “ **kk\_downloader** ” in the “Extensions in TYPO3 Extension Repository” and click on the “Look up” button. You should then find this extension. If you have never installed this, then you will see a red arrow to the left of “ **kk\_downloader** ” and you can click on that to install. If it has been installed, you can click on the green arrow to the left of the extension or the name of the extension and then load the newest version by clicking on the Import/Update button. It is highly recommended to install the newest extension in the "local" folder (LOCAL: typo3conf/ext/kk\_downloader). .. _Create-the-sites-data-folder: Create the sites (data folder, ...) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You have to create several pages. The usual way is to create one sysfolder where the records and categories are saved in.It´s possible to create the extension records in normal sites but we recommend to use a new Storage Folder because therecan bemany records and you can keep everything in one place. Create a page where the LIST view appears Create a page where the SINGLE view appears (not absolutely needed) Create a SYSFOLDER named “download-container” e.g. beyond your site with LIST view. On each page you have to set the “ **General record store page** ” to your (category-)sysfolder. Put the plugin into your page(s) template with “ **Include static (from extensions)** ” = “kk\_downloader” and put the desired parameters in. Set the plugin-configuration into the template setup box. You can copy and paste it from this manual if you want (see below) .. _Add-Categories-and-Partners-in-the-data-folder: Add Categories and Partners in the data folder ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Click on “ *Create new record* ” and choose one of the following: |img-4| **Categorie** for a new categorie and **Download** for a new partner record. You have to add first your categories, because you need the categories to add a new partner record(only in the sb\_downloader- version!). Here in this version categories are no longer mandatory fields!The form fields are self-explanatory. .. _Configure-the-options-LIST-view: Configure the options: LIST-view ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ After you create a page and add the extension, you have to edit the Flexform to get the right settings. Please do not forget to **deactivate the cache** in the page behaviour! |img-5| Flexform options |img-6| New since version 1.2.0: browse max. n items per page .. _Configure-the-options-SINGLE-view: Configure the options: SINGLE-view ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The same as above, only choose SINGLE instead of LIST! A page with the plugin SINGLE view should not be cached! Please set it in the page options. |img-7| **What you have to look for!** Tell the plugin the ID of the page with the single view: - You have the possibility to edit the following plugin properties via setup:plugin.tx\_kkdownloader\_pi1.singlePID = 28 (e.g.) - Put the marker ###MORE### into your HTML-template {This link will be inactive if a) the singlePID is not given or has a wrong UID or b) the correct singlePID-page has the hidden status. .. _Template-setup-configuration: Template setup - configuration ------------------------------ .. _Reference: Reference ^^^^^^^^^ **plugin\_tx\_kkdownloader\_pi1.** .. ### BEGIN~OF~TABLE ### .. _debug: debug """"" .. container:: table-row Property debug Data type Boolean Description Prints of the Extension will appear on screen Default false .. _linkdescription: linkdescription """"""""""""""" .. container:: table-row Property linkdescription Data type integer Description If no linktitle set: 1 = filename.fileextension, 2 = filename 3 = fileextension Default 1 .. _downloadIcon: downloadIcon """""""""""" .. container:: table-row Property downloadIcon Data type string Description Path to download icon (complete – e.g. downloadIcon = typo3conf/ext/kk\_downloader/pi1/images/down load.gif) or Path to the folder, where the fileicons are: (e.g. downloadIcon = typo3/gfx/fileicons/) This path must end with a Slash! Result: the corrosponding icons to the fileextension will be shown, just like “pdf.gif” e.g. - Kurt Kunig Default .. _missingDownloadIcon: missingDownloadIcon """"""""""""""""""" .. container:: table-row Property missingDownloadIcon Data type string Description If the path is set typo3/gfx/fileicons/ you can set a default download icon if a icon is missing (e.g. for rar files) Default typo3conf/ext/kk\_downloader/pi1/images/download.gif .. _templateFile: templateFile """""""""""" .. container:: table-row Property templateFile Data type String Description Path to template file Default typo3conf/ext/kk\_downloader/kk\_download\_template.html .. _defaultDownloadPid: defaultDownloadPid """""""""""""""""" .. container:: table-row Property defaultDownloadPid Data type integer/string Description \# PID of the general download folder (if no page-"starting-point" is set) integer: PID of a page-object string: 'all' →ALL downloads will be selected Default 'all' .. _singlePID: singlePID """"""""" .. container:: table-row Property singlePID Data type integer Description Pid of the detail page Default empty .. _displayCreationDate: displayCreationDate """"""""""""""""""" .. container:: table-row Property displayCreationDate Data type boolean Description Decission to display the date of the crdate behind the download-number or not displayCreationDate (1 = yes, 0 = no) \- additional array-elements in locallang.xml Default .. _dateformat: dateformat """""""""" .. container:: table-row Property dateformat Data type ->stdWrap Description Here you can set the date formating for the template-marker: ###DATE###. Example: plugin.tx\_kkdownloader\_pi1 {dateformat= l, d.m.Y} This will display the date in content elements like this: “Monday, 31.03.2008 ”. Default .. _datetimeformat: datetimeformat """""""""""""" .. container:: table-row Property datetimeformat Data type ->stdWrap Description e.g. used for formatting the date-output of the download-file datetimeformat = d.M.Y H:m Default .. _timeformat: timeformat """""""""" .. container:: table-row Property timeformat Data type ->stdWrap Description Here you can set the date formating for the template-marker: ###DATE###. Example: plugin.tx\_kkdownloader\_pi1 {timeformat= H:i} This will display the time in content elements like this: “12:03”. Default .. _imageDistance: imageDistance """"""""""""" .. container:: table-row Property imageDistance Data type String Description Distance between Image and text Default 5 .. _Image: Image """"" .. container:: table-row Property Image Data type ->imgResource ->stdWrap Description Configurates the image(s) in news items. Example: image{ file.maxW = 140 imageLinkWrap = 0 imageLinkWrap { enable = 1 bodyTag = wrap = \| width = 400m height = 400 JSwindow = 1 JSwindow.newWindow = 1 JSwindow.expand = 17,20 } } see: `TSref->imgResource `_ Default .. _fileMDateClass: fileMDateClass """""""""""""" .. container:: table-row Property fileMDateClass Data type String Description Span-class for LastMod-date of the download file e.g. fileMDateClass = sb\_fileMDateClass Default empty .. _filesizeClass: filesizeClass """"""""""""" .. container:: table-row Property filesizeClass Data type String Description class for the display of the file-size e.g. filesizeClass = sb\_filesize\_class Default empty .. _parseFunc: parseFunc """"""""" .. container:: table-row Property parseFunc Data type Array Description Render content of the field “longdescription”, converts LINK-entries into a-tags e.g. parseFunc < lib.parseFunc parseFunc not set => Content will only be rendered with the php-method “nl2br( )” Default parseFunc\_RTE .. _results-at-a-time: results\_at\_a\_time """""""""""""""""""" .. container:: table-row Property results\_at\_a\_time Data type Integer Description limit of single items on one list-page used with LIST for page-browsing. Can be overwritten in flexform (see screenshot above) Default 25 .. _pageBrowser-maxPages: pageBrowser.maxPages """""""""""""""""""" .. container:: table-row Property pageBrowser.maxPages Data type Integer Description Maximum **x** pages will be shown Default 10 .. _pageBrowser-showPBrowserText: pageBrowser.showPBrowserText """""""""""""""""""""""""""" .. container:: table-row Property pageBrowser.showPBrowserText Data type Boolean Description should pagebrowser-text be shown Default true .. _pageBrowser-showResultCount: pageBrowser. showResultCount """""""""""""""""""""""""""" .. container:: table-row Property pageBrowser. showResultCount Data type boolean Description Should the list result (Item 1 to 5 of 23) be shown? Default true .. _pageBrowser: pageBrowser { """"""""""""" .. container:: table-row Property pageBrowser { activepage\_stdWrap.wrap page\_stdWrap.wrap pagelink\_stdWrap.wrap previous\_stdWrap.wrap next\_stdWrap.wrap } Data type stdWrap Description Wrapping the active page Default \| \| \| \| \| .. ###### END~OF~TABLE ###### If you want to modify variables from locallang.xml you can also do this here in the typoscript setup: **plugin\_tx\_kkdownloader\_pi1.\_LOCAL\_LANG.** .. ### BEGIN~OF~TABLE ### .. _default-bracketstart-n: default.bracketstart = \n[ """""""""""""""""""""""""" .. container:: table-row Property default.bracketstart = \n[ de.bracketstart = ( Data type string Description A **\n** in all locallang.parameter means a linefeed “
” after rendering Default \n( .. _default-bracketend: default.bracketend = ] """""""""""""""""""""" .. container:: table-row Property default.bracketend = ] de.bracketend = ) Data type string Description Dto. Default ) .. _default-category-text-Cat: default.category\_text = Cat. """"""""""""""""""""""""""""" .. container:: table-row Property default.category\_text = Cat. de.category\_text = Kat. Data type string Description Default Category: Kategorie: .. _default-downloads: default.downloads """"""""""""""""" .. container:: table-row Property default.downloads Data type string Description Default downloads .. _default-novalue: default.novalue """"""""""""""" .. container:: table-row Property default.novalue Data type string Description Default No data .. _default-notemplate: default.notemplate """""""""""""""""" .. container:: table-row Property default.notemplate Data type string Description Default No HTML-template. Neither in the flexform nor in the template-setup!? .. _default-filesize: default.filesize """""""""""""""" .. container:: table-row Property default.filesize Data type string Description Default Filesize: .. _default-fileMDate: default.fileMDate """"""""""""""""" .. container:: table-row Property default.fileMDate Data type string Description Default File date: .. _default-since: default.since """"""""""""" .. container:: table-row Property default.since Data type string Description Default since: .. _default-oclock: default.oclock """""""""""""" .. container:: table-row Property default.oclock Data type string Description Default o´clock .. _default-more: default.more """""""""""" .. container:: table-row Property default.more Data type string Description Default [more] .. _default-lastedit: default.lastedit """""""""""""""" .. container:: table-row Property default.lastedit Data type string Description Default last edit: .. _default-category-text: default.category\_text """""""""""""""""""""" .. container:: table-row Property default.category\_text Data type string Description Default Category: .. _a-s-o: a.s.o. """""" .. container:: table-row Property a.s.o. Data type Description Look into the **locallang.xml** For all other languages put the language.prefix before the parameter: eg in German: **de.category\_text = Kategorie** Default .. ###### END~OF~TABLE ###### **These are the existing TEXT\_...-entries:** **default:** **de (German):** **Example** plugin.tx\_kkdownloader\_pi1 { \# debug the main program yes = 1 / no = 0 debug = 0 \# redefine locallang parameters \_LOCAL\_LANG.de.bracketstart = ( \# template templateFile = typo3conf/ext/kk\_downloader/kk\_download\_template.html \# PID of the general download folder (if no page-"starting-point" is set) \# either the numeric PID or 'all' for all downloadable files defaultDownloadPid = all \# PID of the page for a SINGLE view (if wanted) singlePID = 39 \# download description \# (1 = filename.fileextension, 2 = filename, 3 = fileextension) linkdescription = 1 \# date and time format dateformat = d.M.Y timeformat = H:i \# used for download-file date & time datetimeformat = d.M.Y H:m \# span-class for File date and time fileMDateClass = sb\_fileMDateClass \# span-class for displaying the file-size filesizeClass = sb\_filesize\_class \# download icon \# if set to typo3/gfx/fileicons/ typo3 standard icons appear \# you can set own images like: \# downloadIcon = typo3conf/ext/kk\_downloader/pi1/images/download.gif downloadIcon = typo3/gfx/fileicons/ \# if a download icon is missing (e.g. \*.rar) missingDownloadIcon = typo3conf/ext/kk\_downloader/pi1/images/download.gif \# distance around image imageDistance = 5 \# image settings image{ file.maxW = 120 imageLinkWrap = 1 imageLinkWrap { enable = 1 bodyTag = wrap = \| width = 400m height = 400 JSwindow = 1 JSwindow.newWindow = 1 JSwindow.expand = 17,20 } } } .. _Used-Markers: Used Markers ^^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _TITLE: ###TITLE### """"""""""" .. container:: table-row a ###TITLE### b Title of download .. _CATEGORIES: ###CATEGORIES### """""""""""""""" .. container:: table-row a ###CATEGORIES### b Category Name .. _LINKS: ###LINKS### """"""""""" .. container:: table-row a ###LINKS### b All download links with filesize in brackets and download icon .. _SHORTDESCRIPTION: ###SHORTDESCRIPTION### """""""""""""""""""""" .. container:: table-row a ###SHORTDESCRIPTION### b Short description of doanload(s) .. _DESCRIPTION: ###DESCRIPTION### """"""""""""""""" .. container:: table-row a ###DESCRIPTION### b Detailled description of the download object(s) .. _MORE: ###MORE### """""""""" .. container:: table-row a ###MORE### b Link to detailview .. _IMAGE: ###IMAGE### """"""""""" .. container:: table-row a ###IMAGE### b Preview image .. _CLICKS: ###CLICKS### """""""""""" .. container:: table-row a ###CLICKS### b Download counter .. _LASTDOWNLOAD: ###LASTDOWNLOAD### """""""""""""""""" .. container:: table-row a ###LASTDOWNLOAD### b Date and time of the last download .. _IPLASTDOWNLOAD: ###IPLASTDOWNLOAD### """""""""""""""""""" .. container:: table-row a ###IPLASTDOWNLOAD### b IP-address of the downloader .. _DATE: ###DATE### """""""""" .. container:: table-row a ###DATE### b Creation date (and time) .. _LASTEDIT: ###LASTEDIT### """""""""""""" .. container:: table-row a ###LASTEDIT### b Last edit date .. _Unknown-Property: ((Unknown Property)) """""""""""""""""""" .. container:: table-row a b .. _FILE: ###FILE### """""""""" .. container:: table-row a ###FILE### b file-name including the file-icon .. _FILEMDATE: ###FILEMDATE### """"""""""""""" .. container:: table-row a ###FILEMDATE### b date of last modification of the file .. _FILESIZE: ###FILESIZE### """""""""""""" .. container:: table-row a ###FILESIZE### b filesize of links .. _ICON: ###ICON### """""""""" .. container:: table-row a ###ICON### b File-extension icon .. ###### END~OF~TABLE ###### .. _Static-css-file: Static css file ^^^^^^^^^^^^^^^ You can insert the static css file via “ **Include static (from extensions)** ” in the template of your page (or rootpage) .. _Standard-HTML-Template: Standard HTML-Template ^^^^^^^^^^^^^^^^^^^^^^ ****

###TITLE###

###TEXT\_CATEGORIES###: ###CATEGORIES###
###LINKS###
###SHORTDESCRIPTION###
###MORE###
###IMAGE###
###CLICKS### ###TEXT\_CLICKS###
###TEXT\_LASTDOWNLOAD###: ###LASTDOWNLOAD###
###TEXT\_IPLASTDOWNLOAD###: ###IPLASTDOWNLOAD###
###TEXT\_LASTEDIT###: ###LASTEDIT###
****

###TITLE###

###CATEGORIES###
###LINKS###

###TEXT\_SHORTDESCRIPTION###:
###SHORTDESCRIPTION###
###DESCRIPTION###

###IMAGE###
###CLICKS### ###TEXT\_CLICKS### ###TEXT\_DATE### ###DATE###
###TEXT\_LASTDOWNLOAD###: ###LASTDOWNLOAD###
###TEXT\_IPLASTDOWNLOAD###: ###IPLASTDOWNLOAD###
###TEXT\_LASTEDIT###: ###LASTEDIT###
****
###FILE### ###ICON###
###TEXT\_FILESIZE###: ###FILESIZE###
###TEXT\_FILEMDATE###: ###FILEMDATE###
.. _FAQ: FAQ --- .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _generated: ((generated)) """"""""""""" .. _I-cant-insert-categories-in-a-new-partner-record: I can´t insert categories in a new partner record. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You have to put your SysFolder intothe “ **General Record Storage page” resp. “starting point”** of your page.Sometimes it is better to create a general storag page (sysfolder) for the categories and then put this one into the above mentioned field of the sysfolder that takes the download files in. **When I upload a file I got the message that the filesize shoud be too large?** Upload file size is limited by a variable in the base configuration. .. _Changelog: Changelog --------- Please look into the cangelog-file of the extension under **/typo3conf/ext/kk\_downloader/ChangeLog** |img-8| Ext: kk\_downloader - 12 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 119 .. :id: Grafik1 .. :name: Grafik1 .. :width: 669 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 160 .. :id: Grafik5 .. :name: Grafik5 .. :width: 486 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 268 .. :id: Grafik4 .. :name: Grafik4 .. :width: 669 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 46 .. :id: Grafik2 .. :name: Grafik2 .. :width: 102 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 653 .. :id: Grafik3 .. :name: Grafik3 .. :width: 358 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 102 .. :id: Grafik7 .. :name: Grafik7 .. :width: 335 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 117 .. :id: Grafik6 .. :name: Grafik6 .. :width: 402 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102