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.
DAM Easy Search¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Laurent Verhoest |
Changed: | 2007-05-14T11:40:55 |
Author: | Yoann Jean |
Email: | yoann.jean@gmail.com |
Info 3: | |
Info 4: |
DAM Easy Search¶
Extension Key: advoo_dameasysearch
Copyright 2006-2007 URBACT, DIV, ERDF, Yoann Jean, <yoann.jean@gmail.com>
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¶
DAM Easy Search 1
Introduction 1
What does it do? 1
Screenshots 2
Users manual 3
Configuration 5
To-Do List 7
Changelog 7
Introduction¶
What does it do?¶
This is a front end plugin to search for documents stored in the Document Asset Management extension (tx_dam). This plugin search engine is based on the DAM categories. The goal is to have a thematic research through the DAM using a thesaurus based on categories.
Currently, the extension allows to have “main categories” that will be used as global families of criterias (themselves being sub categories). The extension currently manages only one level of main category and then one level of sub categories.
When performing the search, each main categories criterias are combined with a logical AND operator, whereas the user can choose which logical combination to use for criterias within the same main category.
After installing the extension on your TYPO3 system you will find one plugin added in the content elements plugin list, named DAM Easy Search.
This plugin was initially developed for the needs of the URBACT Secretariat ( http://urbact.eu ), managing authority of the URBACT Program cofinanced by the European Union ( http://europa.eu ) on behalf of the ERDF (European Regional Development Fund).
Screenshots¶
This is the default welcome view, when searching on 3 main categories. The extension comes with a template for frontend that can be changed to suits your needs.
In the picture above, we are searching for photos of “Places” “Mexico OR Los Angeles” AND with “Landscape” “Sea AND Mountains” AND of “Years” “2006”. The combination used between main categories : “Places”, “Landscape” and “Years” is a logic AND. The combination used between each of their criterias is a user choice.
... and the search result
“Relevance” is a simple ratio between the number of matched criterias and the total number of criterias.
... and the backend categories tree
Users manual¶
((generated))¶
DAM Easy Search¶
If you want to provide to your visitors an easy way to search for dam documents, just insert the dam easy search plugin:
Create a page for the plugin and add a new item.
Then select the “insert plugin” content element type and the “DAM Easy Search” plugin:
Then, you can tell which categories are mandatory for your search (if there are). Here, you can select any categories you want. By default, a maximum of 10 categories can be selected (if you need more, you have to edit the xml file describing the flexform configuration).If you select some mandatories categories, the search form will act as a filter because files associated with these mandatories categories will automatically be prompted by default.
In this example, we want to provide to our users a search module only for pictures taken in 2005.
After that, you can tell which categories you want to use as search criterias families. Here, you can select only categories that have at least one subcategory. Indeed, this subcategory will be used as a search criteria. If you don't select any criteria families, the search form won't be displayed but the complete list of files associated to the mandatories categories (selected above) will be prompted. That kind of configuration can be use to display all documents corresponding to mandatory categories.
The order of your selection will define the order of the columns on the front end. Using the arrows, you can then dynamically change the order without changing the template.
When the plugin is displayed prior to any search, a “welcome” message can be displayed.
This message is stored in the plugin “locallang.xml” file with a default value. It can be customized in TypoScript using this setting :
plugin.tx_advoodameasysearch_pi1._LOCAL_LANG.fr.welcome_msg = Your personal welcome message for french
You can then choose, by changing the default template, to display it somewhere or not.
Multi linguism handling of categories¶
With the version 1.0.8 of the extension “tx_dam”, there is no easy way to use the default TYPO3 translation management for categories. To handle this issue, we use a hack by parsing the “keywords” field of a category. Here is an example :
The “keywords” fields will be parsed line by line. Each line must contains “language title” = “title translated”. This way, if your visitor browses the website in the language whose title in your Typo3 Website is “en”, the category “Projets” will be prompted “Projects”. If a translation is not found, or the visitor browses the website in the default language, the field “Title” is used.
Configuration¶
((generated))¶
Requirements¶
This plugin depends on “tx_dam” extension.
General¶
This plugin comes with a default template, using the following markers. For each marker, you will find a screenshot of the corresponding field in the DAM File form.
###FILE_TITLE### :
###DOWNLOAD_LINK### :
###FILE_LANGUAGE### : show a flag image if found
###CRITERIA_TITLE### :
A list of labels can also be configured through _LOCAL_LANG :
submit_button_label¶
Label key
submit_button_label
Description
Label for the search button
no_categories¶
Label key
no_categories
Description
Message shown if no categories selected for “criterias families”
no_subcategories¶
Label key
no_subcategories
Description
Message shown if no sub categories found for a criterias family
no_result¶
Label key
no_result
Description
Message shown if no result found
download_link¶
Label key
download_link
Description
Label for the download link
categories_legend¶
Label key
categories_legend
Description
Label for the search form legend tag
operator_or¶
Label key
operator_or
Description
Label for the “OR” operator in the default list box
operator_and¶
Label key
operator_and
Description
Label for the “AND” operator in the default list box
ranking_label¶
Label key
ranking_label
Description
Label for the ranking of the file result
category_label¶
Label key
category_label
Description
Label for the file associated categories
no_criterias_msg¶
Label key
no_criterias_msg
Description
Message shown if no criteria selected when performing a search
welcome_message¶
Label key
welcome_message
Description
Text used as a welcome message
TypoScript Reference¶
tempalte¶
Property
tempalte
Data type
string
Description
The path to the file used as a template
Default
EXT:advoo_dameasysearch/pi1/template.tmpl
CSS Styling¶
Here are the default ones. As every css classes are only in the template file, you can adjust it to suits your needs.
tx_advoodameasysearch_pi1 {}
tx_advoodameasysearch_pi1-search {}
tx_advoodameasysearch_pi1-column {}
tx_advoodameasysearch_pi1-operator {}
tx_advoodameasysearch_pi1-row {}
tx_advoodameasysearch_pi1-filelist {}
tx_advoodameasysearch_pi1-file {}
tx_advoodameasysearch_pi1-title {}
tx_advoodameasysearch_pi1-ranking {}
tx_advoodameasysearch_pi1-categories {}
tx_advoodameasysearch_pi1-description {}
This one is dynamically assigned. It refers to file associated criterias matching the search criterias.
tx_advoodameasysearch_pi1-matched {}
To-Do List¶
A next step would be to provide a full configuration set of TypoScript variables.
Relevance results are based on “fixed” 5 stars display, it may be interesting to have the possibility to configure the number of stars corresponding to 100%, and also the pictures used (here only white star, half-filled star and full-filled star).