EXT: Modern Downloads¶

What does it do?¶

This is a modern download plugin based on the Modern Linklist (ab_linklist) extension.

It has the following features:

• Backend users can create categories and downloads, they can accept or delete new downloads proposed by frontend users, accept or disable downloads reported broken by frontend users and can check for non- working downloads (the latter also from behind a proxy server as curl support is available).
• Frontend users can rate downloads, the current rating/number of votes is shown in the detailed download view and also with small stars in the category view. Both features can be disabled in the backend.
• Frontend users can specify a contact address and a preview image when proposing a new download. The maximum sizes for images in the category and detailed link view can be defined in the backend.
• All download and category values (label, description, href, rating, preview image, parent category, ...) are fully editable in the backend which also provides comfortable, graphical category trees.
• The extension features comprehensive, FlexForm-based configuration options for all important plugin settings.
• For each category the total number of downloads (plus downloads in all subcategories) is shown in the frontend.
• For each category an image can be defined which is shown in front of the category link instead of the standard black triangle.
• The number of downloads shown on a page can be limited to a certain value, a comfortable page browser has been added.
• Flexible "TOP lists" show the TOPx number of downloads concerning rating, clicks and creation time per category (and below).
• A “TREE” view shows a tree of all categories and downloads on one page similar to other download extensions around.
• A “CATALOG” view shows a catalog of the categories and downloads similar to the google catalog.
• date_stdWrap and time_stdWrap functions can be used to format the display of date and time.
• An e-mail (with configurable subject) is sent to a specified address if a download is proposed/reported broken by a frontend user.
• The plugin supports basic multiple-click and multiple-rating protection by storing the user's IP address.
• A blacklist for words in the label and description fields of a download is provided. If the user-submitted label and/or description contains one of these words, the download proposal is refused with an error message.
• A (simple and slow) search function has been added which provides searching on label and description of downloads.
• The design and layout can be fully customized and fitted to your needs by editing the supplied CSS-based and table-based templates. “Default CSS-styles” with some basic CSS-definitions are also provided.
• Caching of the output can be enabled and the extension also makes use of the new cHash mechanism.
• The extension is capable of displaying multi-language content: Categories and downloads can be translated using the standard TYPO3 facilities.
• The extension supports the versioning of downloads and the workspaces functionality offered by TYPO3 version 4.0.
• The extension features import wizards which allow to 1) automatically generate a SQL query to import categories/downloads from other download lists/database tables and 2) to import categories/downloads from a CSV file.
• The extension also features an export wizard which allows to export categories/downloads to different output formats (HTML, XML, TXT and CSV are supported so far).
• The backend module offers a statistics functionality which allows to view statistics on the categories/downloads contained in the database.
• FreeCap and Captcha Library support (extensions: "sr_freecap" and “captcha”) is integrated for the “Propose a new download” frontend form.
• The extension supports frontend editing of download records.
• The extension features sponsored downloads which are always shown first in the different views and can have assigned an additional description.

Online Resources¶

If you like this extension please consider to rate it at:

http://typo3.org/extensions/repository/view/ab_downloads/$CURRENT_V ERSION$/rating/

Project homepage:

http://typo3.andreas-bulling.de/en/extensions/modern-downloads/

Subversion repository:

http://repos.andreas-bulling.de/ab_downloads/

Bugtracker:

http://typo3.andreas-bulling.de/en/bug-tracker/

Donations:

http://typo3.andreas-bulling.de/en/donate-money/

A demo with the most recent features enabled can be found here:

http://typo3.andreas-bulling.de/en/demos/modern-downloads/

Most of the new labels/backend options have only been translated to German yet. So please feel free to send me more translations to make this extension usable for more people!

Screenshots¶

Changing from other download extensions¶

If you want to import your categories and downloads from other (TYPO3) extensions or database tables an appropriate SQL query can be generated automatically in the “Import categories/downloads” backend view. Just follow the instructions step by step and use for example phpMyAdmin in your TYPO3 backend afterwards to execute the query.

FAQ¶

• How can I change the appearance of the pagebrowser?

  When looking at the generated html source code you can see that the pagebrowser and its components are wrapped in several <div> tags which you can freely modify by adding appropriate CSS definitions to your site.

  You also have the possibility to substitute the built-in pagebrowser with your own pagebrowser script. The file "example_userPageBrowserFunc.php" was added in folder "res/" of the extension which contains a example pagebrowser userfunction you can change to fit your needs (see the file for a description and the needed TypoScript setup).

• How can I enable the PiBasePagebrowser/use the new features of the extended TYPO3 v3.8.0 pagebrowser?

  Just overwrite the provided (static) TypoScript setup in your extension/main template. The following default settings have been predefined:

  usePiBasePagebrowser = 0
  pageBrowser {
          maxPages = 50
          showResultCount = 1
          showPBrowserText = 0
          dontLinkActivePage = 1
          tableParams = cellpadding="2" align="center"
          hscText = 1
  
          # settings for the extended pagebrowser from TYPO3 3.8.0
          showFirstLast = 0
          pagefloat = center
          showRange = 0
          disabledLinkWrap = <span style="color:#bbb;">|</span>
          inactiveLinkWrap = |
          activeLinkWrap = <b>|</b>
          browseLinksWrap = |
          showResultsWrap = |<br />
          showResultsNumbersWrap = |
          browseBoxWrap = <div class="tx-abdownloads-pi1-browsebox">|</div>
  }
  

• How can I change the display of date and time?

  First make sure to set the correct language and locale in your main template (please refer to the TYPO3 Documentation on how to do this). After that just overwrite the provided (static) TypoScript setup in your extension/main template.

For example a possible German format:

plugin.tx_abdownloads_pi1 {
  date_stdWrap.strftime = %d. %B %Y
  time_stdWrap.strftime = %H:%M:%S Uhr
}

• How can I change the labels of the pagebrowser?

  Create an extension template for the page you added the “Modern Downloads” to and add the following TypoScript code in the “Setup” field of the template.

  For example apossible German format (not using the PiBasePagebrowser):

  plugin.tx_abdownloads_pi1 {
    _LOCAL_LANG.de {
      pi_list_browseresults_prev = < vorherige Einträge
      pi_list_browseresults_next = weitere Einträge >
      pi_list_browseresults_displays = Anzeige: <b>%s bis %s</b> von <b>%s</b>
    }
  }
  

  Another German example (using the PiBasePagebrowser in this case):

  plugin.tx_abdownloads_pi1 {
    # enable the PiBasePagebrowser
    usePiBasePagebrowser = 1
  
    _LOCAL_LANG.de {
      pi_list_browseresults_prev = < vorherige Einträge
      pi_list_browseresults_next = weitere Einträge >
      pi_list_browseresults_displays (
        Anzeige: <b>###FROM### bis ###TO###</b> von <b>###OUT_OF###</b>
      )
    }
  }
  

• How can I change the label of the search button?

  Create an extension template for the page you added the “Modern Downloads” to and add the following TypoScript code in the “Setup” field of the template.

  For example a possible German format:

  plugin.tx_abdownloads_pi1{

  _LOCAL_LANG.de{

  pi_list_searchBox_search=Suchen

    }
  }
  

• How can I change the appearance and layout of the download lists?

  In subfolder “pi1” of the extension you will find an example template file called “tx_abdownloads_pi1.tmpl” which is used by the extension by default. Copy this file to some other place (perhaps where you store your other templates) and edit it to fit your needs. Afterwards select it in the plugin options under “Template file”. As the ATagParams of the frontend links can be defined/changed you can also use this additional method.

• How can I define/change the parameters (ATagParams) of the frontend links?

  Just overwrite the provided (static) TypoScript setup in your (extension) template. The following default style classes for the links have been predefined:

  # listView link/category parameter settings
  listView {
          # ATagParams
          categoryLabel.ATagParams = class="tx_abdownloads_listView_categoryLabel"
  
          linkAddNew.ATagParams = class="tx_abdownloads_listView_linkAddNew"
          linkLabel.ATagParams = class="tx_abdownloads_listView_linkLabel"
          linkDetails.ATagParams = class="tx_abdownloads_listView_linkDetails"
          linkReportBroken.ATagParams = class="tx_abdownloads_listView_linkReportBroken"
          linkRate.ATagParams = class="tx_abdownloads_listView_linkRate"
          linkImage.ATagParams = class="tx_abdownloads_listView_linkImage"
  }
  
  # treeView link parameter settings
  treeView {
          # ATagParams
          linkAddNew.ATagParams = class="tx_abdownloads_treeView_linkAddNew"
          linkLabel.ATagParams = class="tx_abdownloads_treeView_linkLabel"
          linkDetails.ATagParams = class="tx_abdownloads_treeView_linkDetails"
          linkReportBroken.ATagParams = class="tx_abdownloads_treeView_linkReportBroken"
          linkRate.ATagParams = class="tx_abdownloads_treeView_linkRate"
          linkImage.ATagParams = class="tx_abdownloads_treeView_linkImage"
  }
  
  # searchView link parameter settings
  searchView {
          # AtagParams
          categoryLabel.ATagParams = class="tx_abdownloads_searchView_categoryLabel"
  
          linkLabel.ATagParams = class="tx_abdownloads_searchView_linkLabel"
          linkDetails.ATagParams = class="tx_abdownloads_searchView_linkDetails"
          linkReportBroken.ATagParams = class="tx_abdownloads_searchView_linkReportBroken"
          linkRate.ATagParams = class="tx_abdownloads_searchView_linkRate"
          linkImage.ATagParams = class="tx_abdownloads_searchView_linkImage"
  }
  
  # topView link parameter settings
  topView {
          # ATagParams
          linkLabel.ATagParams = class="tx_abdownloads_topView_linkLabel"
          linkDetails.ATagParams = class="tx_abdownloads_topView_linkDetails"
          linkImage.ATagParams = class="tx_abdownloads_topView_linkImage"
  }
  
  # catalogView link parameter settings
  catalogView {
          # AtagParams
          categoryLabel.ATagParams = class="tx_abdownloads_catalogView_categoryLabel"
          subcategoryLabel.ATagParams = class="tx_abdownloads_catalogView_subcategoryLabel"
  
          linkAddNew.ATagParams = class="tx_abdownloads_catalogView_linkAddNew"
          linkLabel.ATagParams = class="tx_abdownloads_catalogView_linkLabel"
          linkDetails.ATagParams = class="tx_abdownloads_catalogView_linkDetails"
          linkReportBroken.ATagParams = class="tx_abdownloads_catalogView_linkReportBroken"
          linkRate.ATagParams = class="tx_abdownloads_catalogView_linkRate"
          linkImage.ATagParams = class="tx_abdownloads_catalogView_linkImage"
  }
  

• How can I define/change the wraps for the generated output?
  Just overwrite the provided (static) TypoScript setup in your (extension) template. The following wraps, crops, etc. have been predefined:
  # General stdWraps
  categoryPath_stdWrap.wrap = |
  linkLabel_stdWrap.wrap = <b>|</b>
  addLink_stdWrap.wrap = <b>|</b>
  addLinkText_stdWrap.wrap = <b>|</b>
  mandatoryField_stdWrap.wrap = <span style="color:red;">*</span>|
  reportLinkBrokenText_stdWrap.wrap = <b>|</b>
  rateLinkText_stdWrap.wrap = <b>|</b>
  formErrorMsg_stdWrap.wrap = |
  nonPublicLinkMessage_stdWrap = |
  linkLabel_stdWrap.wrap = |
  linkDescription_stdWrap.wrap = |
  
  # listView link/category parameter settings
  listView {
          # Wraps
          categories_stdWrap.wrap = |
          category_stdWrap.wrap = |
          categoryPath_stdWrap.wrap = |
          categoryLabel_stdWrap.wrap = |
          categoryDescription_stdWrap {
                  wrap = <br/><i>|</i>
                  crop =
          }
  
          links_stdWrap.wrap = <b>|</b>
          linkAddNew_stdWrap.wrap = |
          linkTeaser_stdWrap {
                  wrap = |
                  crop = 30 | ... | 1
          }
          linkDescription_stdWrap.wrap = |
          linkLabel_stdWrap.wrap = |
          linkDetails_stdWrap.wrap = |
          linkReportBroken_stdWrap.wrap = |
          linkRate_stdWrap.wrap = |
  }
  
  # treeView link parameter settings
  treeView {
          # Wraps
          categoryLabel_stdWrap.wrap = <b>|</b>
          categoryDescription_stdWrap {
                  wrap = <br/><i>|</i>
                  crop =
          }
  
          linkAddNew_stdWrap.wrap = |
          linkTeaser_stdWrap {
                  wrap = |
                  crop = 30 | ... | 1
          }
          linkDescription_stdWrap.wrap = |
          linkLabel_stdWrap.wrap = |
          linkDetails_stdWrap.wrap = |
          linkReportBroken_stdWrap.wrap = |
          linkRate_stdWrap.wrap = |
  }
  
  # searchView link parameter settings
  searchView {
          # Wraps
          resultMessage_stdWrap.wrap = |
          noLinksMessage_stdWrap.wrap = |
  
          categoryPath_stdWrap.wrap = |
          categoryLabel_stdWrap.wrap = <b>|</b>
          categoryDescription_stdWrap {
                  wrap = <br/><i>|</i>
                  crop =
          }
  
          links_stdWrap.wrap = <b>|</b>
          linkTeaser_stdWrap {
                  wrap = |
                  crop = 30 | ... | 1
          }
          linkDescription_stdWrap.wrap = |
          linkLabel_stdWrap.wrap = |
          linkDetails_stdWrap.wrap = |
          linkReportBroken_stdWrap.wrap = |
          linkRate_stdWrap.wrap = |
  }
  
  # topView link parameter settings
  topView {
          # Wraps
          topMessage_stdWrap.wrap = <b>|</b>
  
          categoryPath_stdWrap.wrap = |
          categoryLabel_stdWrap.wrap = <b>|</b>
          categoryDescription_stdWrap {
                  wrap = <br/><i>|</i>
                  crop =
          }
  
          linkTeaser_stdWrap {
                  wrap = |
                  crop = 30 | ... | 1
          }
          linkDescription_stdWrap.wrap = |
          linkLabel_stdWrap.wrap = |
          linkDetails_stdWrap.wrap = |
  }
  
  # catalogView link parameter settings
  catalogView {
          # Wraps
          categoryPath_stdWrap.wrap = |
          categoryLabel_stdWrap.wrap = |
          categoryDescription_stdWrap {
                  wrap = <br/><i>|</i>
                  crop =
          }
  
          subcategoryLabel_stdWrap.wrap = |
          subcategoryDescription_stdWrap {
                  wrap = <br/><i>|</i>
                  crop =
          }
  
          links_stdWrap.wrap = <b>|</b>
          linkAddNew_stdWrap.wrap = |
          linkTeaser_stdWrap {
                  wrap = |
                  crop = 30 | ... | 1
          }
          linkDescription_stdWrap.wrap = |
          linkLabel_stdWrap.wrap = |
          linkDetails_stdWrap.wrap = |
          linkReportBroken_stdWrap.wrap = |
          linkRate_stdWrap.wrap = |
  }
  

• How can I define/change the indention factor for the TREE view?

  Just overwrite the provided (static) TypoScript setup in your (extension) template. The following indentionFactor has been predefined:

  # treeView link parameter settings
  treeView {
          # indentionFactor
          indentionFactor = 40
  }
  

• How can I define/change the separator and the appendix for the CATALOG view?

  Just overwrite the provided (static) TypoScript setup in your (extension) template. The following separator and appendix have been predefined:

  # catalogView link parameter settings
  catalogView {
          # Separator and appendix
          separator = , 
          appendix = ...
  }
  

• How can I access/use arbitrary database fields of categories or downloads with TypoScript?

  For example, to access/use the “label” database field, create an extension template for the page you added the “Modern Downloads” to and add the following TypoScript code in the “Setup” field of the template:

  # Condition is true if a category is shown
  [globalVar = GP:tx_abdownloads_pi1|category_uid > 0]
  lib.downloadTitle = COA
  lib.downloadTitle {
  10 = RECORDS
  10 {
     source = {GPvar:tx_abdownloads_pi1|category_uid}
    source.insertData = 1
       tables = tx_abdownloads_category
    conf.tx_abdownloads_category >
        conf.tx_abdownloads_category = TEXT
         conf.tx_abdownloads_category.field = label
          }
  }
  
  # Condition is true if a link is shown
  [globalVar = GP:tx_abdownloads_pi1|uid > 0]
  lib.downloadTitle = COA
  lib.downloadTitle {
  10 = RECORDS
  10 {
         source = {GPvar:tx_abdownloads_pi1|uid}
     source.insertData = 1
       tables = tx_abdownloads_download
    conf.tx_abdownloads_link >
    conf.tx_abdownloads_link = TEXT
     conf.tx_abdownloads_link.field = label
      }
  }
  
  [GLOBAL]
  

  This creates a TypoScript object called "lib.downloadTitle" filled with the label of a) the current category or b) the current link. This objectt could for example be used to fill the description HTML metatag:

  page.headerData.20 >
  page.headerData.20 < lib.downloadTitel
  page.headerData.20.wrap = <meta name="description" content=" | " />
  

• How can I enable the frontend edit panels for download records?

  First, make sure the adminPanel is enabled in the TypoScript “Setup” of your main/extension template:

  config.admPanel = 1
  

  Afterwards, enable “Display Edit Panels” in the “Editing” section of the admin panel and click “Update”. Given that you have added the ###EDIT_PANEL### marker to your template, the edit panels will show up in the frontend.

• I've set the “ Maximum filesize of downloads ” appropriately but I still can't upload files larger than X MB, whats's going wrong?

  There are several other places which you should check:

  PHP: “post_max_size” and “upload_max_filesize” options usually in php.ini

  TYPO3: “maxFileSize” in the Install Tool

Files¶

The following table shows the files used/available in the extension:

Reference¶

plugin.tx_abdownloads_pi1 properties: TS configuration

plugin.tx_abdownloads_pi1.sys_language_mode = strict