Register “What to display”
Select in the box, which view should be displayed by the plugin. The DAM Frontend Plugin contains different views:
Filelist: Displays the files, which are found in the selected categories. No additional settings in the backend required. Possible settings:
use static category selection: if enabled you can choose categories from the register “select your categories”. These categories are used to select files.
enable deletion option for fe_users: If enabled, a user who “owns” the file is allowed to delete this file. The ownership is set via upload thru this user, or can be set in the BE.
enable edits of meta data: If enabled, a user who owns the file, is allowed to edit the meta data and categories of this file. The ownership is set via upload thru this user, or can be set in the BE.
Category Selection: Please set up categories, if you want to limit the result in the filelist for only these categories. For example: You set up a category tree with cat a, b and c. Also you use a search box at your page. If the user uses now the search box without limiting the category tree, the result would show all files he can access (so maybe also cat d). To limit the result for only the cats of the cattree, set up the categoris of the cattree also in the filelist.
Category Tree: Displays the category tree in the Frontend. Additional settings in the backend:
use category selection as default cats: Check this option, if you want to define preselected filelists. Choose the categories you want to display. Now if you use the view “filelist”, all files with the corresponding categories will be displayed. If you use more than one category, a “or” selection is done (all files either “category a” or “category b” are displayed.
Category Selection: Selected at least one category as starting point for category tree in the frontend.
Tree name: Set the name of the tree.
Preselect Categories: These categories are preselected for fe_users, if no category is selected by a user (in most cases if a user visits a page the first time).
Category Selection: Displays the selected categories. No additional settings in the backend requried.
Single View: Displays the detail information of one file, if the user has clicked the magnifying glass. No additional settings in the backend requried.
Search box: Displays a form with search fields. There is a check box “search in all fields”. If this checkbox is set, the category selection of a possible category tree is ignored and all existing and accessible categories are searched. If you want the restrict the searched categories, change the setting for categories (register “Select your categories”) in the filelist element. Then only your selected categories are used to search in “all” cats. This is helpful, if you display a category tree which shows not all categories that are existing in the system.
Upload form: Displays a form for uploading a file to the DAM. The upload form plugin should be placed on separated page, because each time a upload is initiated, the current category selected is deleted.
Register “Upload Settings”: Here you can set the allowed categories a user can use to categorize a document
Preselect Categories: These categories are preselected for fe_users to categorize the document.
myfiles: Shows a list of files, which the current fe_user has uploaded. Possible Settings:
enable deletion option / enable edits of meta data: (see filelist for details)
filelist (grouped categories): Every feature of the filelist view is supported. The difference between the two views is, that here the files are displayed grouped by categories.
Latest view: Shows recently added files. The settings which date field is used and range or amount of files are used for this view, can be set via typoscript. See Configuration (filelist) for more information.
Easy search: Shows a search box to enter a string. For default the columns title, description are searched. This can be customized via typoscript. Also adds a dropdownlist with categories. Possible Settings:
Category Selection: Selected at least one category as starting point for category tree in the frontend.
Drilldown filter: Shows drop down lists, which are showing categories. If a category is selected and it has child element, an additional dropdown box shows the child elements to refine the search.
The views are working together hand in hand. So lets take a look to an example:
Place these three views at the same page, to let a user select a category, see the filelist result and a single view, to look at details of a file.
the “category tree” view to select categories
the “filelist” view to show the results
the “single” view to show the details for a single file
Additional views can be placed at a page, to provide additional functionality (like filters).
Select your categories
category selection: Select the category, which should be displayed in the category browser. Needed only for the view category browser
treename: Name of the tree, which is displayed in the frontend. You can use any name you like.
Options
use static category selection: The selected categories are use to fill a filelist. Use this option only for the filelist.
enable deletion option for fe_users: if enabled a fe_user is allowed to delete a file, if he “owns” it. FE_User ID must be set in column tx_damfrontend_feuser_upload. Use this option only for the filelist.
enable edits of meta data. if enabled a fe_user is allowed to edit the metadata of a file, if he “owns” it. FE_User ID must be set in column tx_damfrontend_feuser_upload. Use this option only for the filelist.
Shows all members of this group in the search box view, to select a filter "author". Use this option only for the search box.
Upload Settings
define the categories which should be selectable by fe_users while uploading a file. Use this option only for the upload view.
Preselect Cat Settings
define the categories which categories should be preselected in a tree. Use this option only for tree views.
The extension adds some new columns to dam records:
tx_damfrontend_feuser_upload: If a user uploads a file, the fe_user ID is added to the dam_record and then the user is the owner of this file. This value can be set in the Backend too. A fileowner is allowed to edit the metadata of this file or is allowed to delete this file (edits and deletions must be allowed in the filelist content element) .
tx_damfrontend_version: Internal counter for versionized files (very basic versioning of cam frontend). Not editable via backend
tx_damfrontend_fegroup: This column is used to store groups that are allowed to edit the document (like the owner).
The extension adds some new columns to dam categories:
tx_damtree_fe_groups_readaccess: Enter the fe_groups which should have read access for this category. Note: If you set no group, access will be allowed. If you restrict access (to at least one group), only the group is allowed to see that files (files that are related to this category)
tx_damtree_fe_groups_downloadaccess: If a group is set to restrict the download, only the group is able to download this file. So you can split up, that files are displayed, but now downloadable.
tx_damtree_fe_groups_uploadaccess: Set the groups, that are allowed to use this category during file upload to assign this category.
Show result only of certain categories
If you want to displays only files of the categories you display in your cattree and you want to use addionally the search box, you have to set up an additional setting In the filelist element.
For this use case you will have to set up at least 3 dam frontend elements at the same page:
catree
searchbox
filelist
Now the user is able to build selections via the cattree and filter the result with the search box.
If the user activates the option “Search in all Categories”, then all categories are used to build the selection. But then really all categories are used to build the selection – and not only the categories that are used in the tree. So we need an additional setting in the filelist element. Use there the same cats as for the category tree – then the result is filtered by these selected categories.
Preselect categories in the tree / filelist
If you want to have some categories preselected in the tree, then just use the tab preselect categories in the cattree element in the backend. The preselection works this way: If no category is selected, the preselected categories are being selected. If the user deselects the last category, then the preselection is loaded again. Therefore it is not possible to select “no category”.
AND vs. OR selection
The normal behavior of selected categories is a “or” selection. This means if you're selection category a and b, all files of both categories will be displayed. If you want to build “and” selections, you have to place the plugin “dam frontend” with the view “category tree” twice at a single page. So now if you're selection category a of the tree 1 and category b of the tree 2, all files will be displayed, if they are assigned to category a and b!
New in Version 0.4.1: You can choose between OR and AND selection via typoscript. (see at typoscript reference: useTreeAndSelection = 1 )
Category selection
The category selection works like the DAM in the backend. You're having three possibilities to build a selection:
Click at the “equal” symbol behind a category: Exactly one category will be selected. All other selected categories are deleted.
Click at the “plus” symbol behind a category: All categories incl. all subcategories will be selected.
Click at the minus to delete exactly one category. Exception: If you're clicking at category node (i.E. at the category “motives”) all subcategories will be deleted.
Advanced categorytree
The new alternative category tree works like a installer. If select a parent node, all childs will be selected too. If you deselect the parent, all childs will be deselected too.
If only a child is selected, then the parent is getting “grey”. If now the parent is clicked, all childs are selected again.
NOTE: Because of this behaviour, the parent (in this example Cat1 or also Cat2) are behaving like a folder. It is not possible to select only them (because a click at the parent selects all child, and deselecting the last child, will deselect the parent too). So you should keep this in mind, by designing your category structure.
If a user has no access for a category the category is locked.
To enable the advanced category please set the ts setting
plugin.tx_damfrontend_pi1.useAdvancedCategoryTree = 1
Important note for CSS style for the tree: Currently the css for tree is generated via typoscript. Sometimes the relative pathes don't work (if the css file is written to the typo3temp path). In that case, you have to take care yourself for the css statements. Here is an example, which you can copy into your css file:
/******************************** Advanced category tree */
.cattree {
width:400px;
}
.treeBgWhite {
}
.treeBgGrey {
background:lightgrey;
}
.checkbox_green a {
display:block;
float:left;
padding-left:20px;
background:url(typo3conf/ext/dam_frontend/res/images/checkbox_green.gif) no-repeat left top;
}
.checkbox a{
display:block;
float:left;
padding-left:20px;
background:url(typo3conf/ext/dam_frontend/res/images/checkbox.gif) no-repeat left top;
}
.checkbox_grey a{
display:block;
float:left;
padding-left:20px;
background:url(typo3conf/ext/dam_frontend/res/images/checkbox_grey.gif) no-repeat left top;
}
.no_access {
background:url(typo3conf/ext/dam_frontend/res/images/no_access.gif) no-repeat left top;
padding-left: 17px;
}
.tree_close {
padding-left: 17px;
background:url(typo3conf/ext/dam_frontend/res/images/tree_close.gif) no-repeat left top;
}
.tree_open {
padding-left: 17px;
background:url(typo3conf/ext/dam_frontend/res/images/tree_open.gif) no-repeat left top;
}
.tree_noControll {
padding-left: 17px;
}
Filelist
The result of your selection will be displayed in the view “filelist” (remember to place the plugin “dam frontend” at least three times at a single page!)
In the first column of the filelist an icon of the filetype is displayed. Currently there are icons for pdf, application, images and textfiles. Additional filetypes can be integrated via typoscript (see section Configuration).
In the filelist you're able to sort by a column. Just click at Acending or descending. If you're clicking at the magnifying glass, additional informations of the selected file will be displayed in the view “single view”. Of course you have to place this view at the same page.
Clicking at the download button will open the file.
The view can be customized. Please take a look in the section configuration.
Note. since version 0.2.0 the filelist can be used “stand alone”, if you use the option “use category selection as default cats”.
Single View
This view displays detail information of a file selected in the filelist view.
You can open the file by clicking at the filename.
You can place the single View at a own page, if you the the singleID In typoscript (see Configuration).
Upload form
Files can only uploaded from fe_user. If no user is logged in, an error message is displayed.
In the first step you choose only a file.
If the file already exists, the user can choose, if it should be replaced (exisiting meta data will be shown in the next step) or if a new version should be created.
The seceond step, is to enter some metadata. The FE_User which uploads the file is automatically set to the column tx_damfronted_feuser_upload, so that the owner can be determined.
In the third step categories can be assigned to the file. Below the category tree you get a list of choosen categories. If you click at the “minus” sign, the category will be removed.
Once you finished assigning categories, just klick “confirm” and the file will finally be uploaded. The file is stored in a subfolder of fileadmin. The subfolder is named like the fe_user (e.G. “user1).
Auto assignment of data
Via typoscript settings some data can be assigned automatically during the upload process.
upload.autoFillFEUserData: You can store data of the fe_user who uploads the file in the file.
Example: upload.autoFillFEUserData {
#left side column of the dam record - right side fe_user column
creator = name
}
upload.autoassignFEGroups: enter the uids of the fe_groups which should be allowed to edit / delete the uploaded files
Edit / delete files
If the edit / delete option is enabled via Flexform or typoscript, then a user is allowed to edit the metadata / categorization of a file, if he is either
the owner of the file (owner is the either set up via backend in the dam record or automatically during the upload process)
member of a edit,group that is attached to a documents
member of a group that is attached to the content element in the backend flexform
member of a group that is attached via typoscript (fileEdit.uids_FEGroups)
If a user is logged in, and he is allowed to edit files, the edit buttons will appear in the list view / lastest view / myFiles view (if the marker is not deleted in the template file)
Edit of meta data
The edit form allows you the edit currently the shown columns of a dam record. If you press confirm the record will be saved.
Edit of categories
The upper area of the form shows the meta data of the selected file.
Via the category tree you are able to select new categories which should be added to the document.
To remove a category, please click at the “minus” symbol in front of the “choosen categories” area. If you click “confirm” the categories will be stored in the document.
The access model of the DAM_Frontend plugin is built on categories and on files permissions. You can assign groups for Read Access, Download Access and Upload Access.
If there is no group assigned to category, then all files, which use this category can be accessed. If there are more then one groups are assigned to a category, a user must be member of both groups to have access to the file.
Additional is the permissions of the dam record / file is analyzed separately. So you are able to define for each file it's own permissions. The start / stop can be used too. More details are found in the administration chapter.
The second plugin is a way to select dam files manually for downloading.
Take care of, the the Plugin is correctly configured (see section installation)
Place the Plugin Frontend Filelist at a page
Select files out of the dam
In the frontend you will see this result:
All selected files will be displayed in a list. Additional filetype icons can be configured via typoscript.
If you're clicking at the icon or the filename, the fileopen dialog of your browser will appear.
Q: I'can't see anything in the frontend.A: Please check if your typoscript installation is correct and / or you included the static template (see installation)
Q: Where can I change the setting for target folder for upload?A: see at the typoscript configuration upload.conf in the chapter Configuration of this manual
Q: Can I get commercial support for this extension for installation or adaptions?A: Yes you can. Write an email to typo3@in2form.com
Q: Can I get also free support?
A: Please use the dam mailinglist