EXT: Hierarchical File List according to DAM Categories¶

What does it do?¶

The frontend plugin shows a hierarchical list of files sorted by DAM categories similar to FIONA media pools. The plugin shows a tree of selected DAM categories. Within each category links to those files that belong to the respective category are shown.

Configuration of plugin in backend (see screenshots) allows:

• Selection of DAM categories to be shown
• Selection of directories which files to be listed
• Sorting of categories and files by various criteria

No TypoScript configuration is needed unless layout of lists is changed.

The access rights for files and categories set by DAM are respected.

By the way FIONA is a commercial content management system that can handle lists of e.g. pdf files as media pools very easily - easier than media in typo3. Although FIONA - in the author's opinion - has limited features compared to Typo3, FIONA's media pools are extraordinary powerful.

Screenshots¶

Create new plugin:

See result in frontend:

Please see users' manual for mor detailed screenshots.

Files¶

Select the directories containing the files you want to display. Files in subdirectories are listed, too, unless the option “ignore files in subdirectories” is checked.

Displaying and Sorting Categories and Files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can choose to display either titles, subtitles or navigation titles of the selected categories and either titles, file names or download file names of the listed files.

You can sort both categories and files by various criteria. Categories can be sorted as in the backend module, by titles, subtitles or navigation titles. Files can be sorted by title, file name or file download name.

If the categories are sorted as in the backend module you can choose to either list the files or the subdirectories first. Otherwise subcategories and files can be merged by a lexicographical sort on the selected sorting criteria.

Frontend content ^^^^^^^^^^^^^^^^

The content shown in the frontend may look like the following screenshots. Please note that the categories' navigation titles e.g. read 02_cat if the title starts with second and e.g. the third demo file's name reads 03_demo_file.txt. Obviously files assigned to more than one category are listed several times.

Categories sorted by title, files sorted by title, categories and files merged by lexicographical sort on titles – titles shown – empty categories hidden.

Categories sorted as in backend module, files sorted by file download name, files first, subcategories thereafter – titles shown – empty categories shown (german frontend)

Categories sorted by navigation title, files sorted by file name, categories and files merged by lexicographical sort on navigation titles resp. file names – navigation titles resp. file names shown – empty categories shown. Probably you will not use this option, nevertheless it will help you to understand the above examples.

Installation and Configuration ------------------------------

One of this extension's purposes is to reduce configuration overhead when listing files managed with dam categories.

This extension works out of the box. Just include one of the static template files. You can choose from grey bullets, lime bullets or no bullets.

An alternative template file can be referenced by TypoScript. See static template files for how to redefine style sheets. All other options are set in the backend of the plugin.

Reference¶

TypoScript-Setup

path/filename

plugin.tx_damtreeview_pi1.templateFile
    = path/filename

Example¶

Administration --------------

This extension requires the extensions “dam” and “dam_catedit” to be installed. It is strongly recommended to install the extension “naw_securedl”.

Template File¶

The template file is designed as following.

<!-- ###DAM_TREE_LIST### begin-->
  <div class="tx_damtreeview_pi1">
  <ul>
  <!-- ###DAM_TREE_ITEM### begin-->
  <li>###ITEM###</li>
  <!-- ###DAM_TREE_ITEM### end-->
  <!-- ###DAM_TREE_SUBCATEGORY### begin-->
  <li class="tx_damtreeview_pi1_subcategory">
    <span class="tx_damtreeview_pi1_subcategory">###CATEGORY###</span>
    ###SUB_TREE###
  </li>
  <!-- ###DAM_TREE_SUBCATEGORY### end-->
  <!-- ###DAM_TREE_NO_ITEM### begin-->
  <li>###TEXT###</li>
  <!-- ###DAM_TREE_NO_ITEM### end-->
  </ul>
  </div>
<!-- ###DAM_TREE_LIST### end-->

The ###DAM_TREE_LIST### subsection defines the list as a whole. Within this list there can be links to files defined by the ###DAM_TREE_ITEM### subsection and subcategories defined by the ###DAM_TREE_SUBCATEGORY### subsection or a message defined by the ###DAM_TREE_NO_ITEM### subsection.

Within the ###DAM_TREE_ITEM### subsection the ###ITEM### tag is replaced by the file title and links to the file content.

The ###DAM_TREE_SUBCATEGORY### subsection defines how a subcategory is rendered. The ###CATEGORY### tag is replaced by the category title. The ###SUB_TREE### tag is recursively replaced by the ###DAM_TREE_LIST### template.

The ###DAM_TREE_NO_ITEM### subsection is used to show a message that no files are found for the respective category, if the hide empty categories box is unchecked in the backend. The ###TEXT### tag is replaced by the phrase defined in pi1/locallang.xml.

It is encouraged to copy the template file and set plugin.tx_damtreeview_pi1.templateFile if the template is to be modified, see configuration.

Cascading Style Sheets¶

The styles are set by _CSS_DEFAULT_STYLE. The following example is from the static file “grey bullets”.

plugin.tx_damtreeview_pi1._CSS_DEFAULT_STYLE (
   div.tx_damtreeview_pi1 ul { list-style-image:
                        url(../typo3conf/ext/dam_tree_view/icons/square_grey.png); }
   li.tx_damtreeview_pi1_subcategory { list-style: none; list-style-image: none; }
   span.tx_damtreeview_pi1_subcategory { margin-left: -1em; font-weight: bold; }
)

0.1.1¶

0.1.0¶