forked from eea/eea.facetednavigation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.txt
225 lines (158 loc) · 8.31 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
======================
EEA Faceted Navigation
======================
.. image:: http://ci.eionet.europa.eu/job/eea.facetednavigation-www/badge/icon
:target: http://ci.eionet.europa.eu/job/eea.facetednavigation-www/lastBuild
.. image:: http://ci.eionet.europa.eu/job/eea.facetednavigation-plone4/badge/icon
:target: http://ci.eionet.europa.eu/job/eea.facetednavigation-plone4/lastBuild
The EEA Faceted Navigation **(FacetedNav)** gives you a
**very powerful interface to improve search within large collections of items.**
No programming skills are required by the website manager to configure the
faceted navigation interface, `configuration is done TTW <http://svn.eionet.europa.eu/projects/Zope/attachment/wiki/FacetedNavigationScreenshots/screenshot7.png>`_.
It lets you gradually select and explore different facets (metadata/properties)
of the site content and narrow down you search quickly and dynamically.
On the contrary, plone collections are static, in a way that the site admin
decides the search criteria and the end user is not able to further sort or
filter the presented results.
**FacetedNav is fully customizable**, site admin may decide that some criteria
(facets) must have fixed values while other may be presented as filter options
to the web visitor.
**FacetedNav may very well replace the standard collection content type**, since
it covers same functionality and it adds a lot more features.
**FacetedNav can also be used as an advanced search for your site**.
.. contents::
Main features
=============
It comes with plenty of configuration options and features like:
1. Easy customizable GUI via drag-n-drop, no restart needed.
2. Facets can be set to fixed default values and hidden.
3. Facets can be placed in standard search or extended search panels,
to not intimidate novice users and have cleaner interface
4. Facets can be displayed via several widgets like select, radio,
text input, tag cloud, date range and more
5. Expandable and collapsible widgets with many values
6. Automatically counts number of content items beside each facet value
7. Possibility to show or hide the options with zero results
(show only the facets which return content)
8. Ability to create your custom content types definition to be used as a
combination of interface and portal type, presented in a single widget.
9. Export of search result in RSS.
10. Pleasant user interface based on Ajax JQuery, implemented with "deep linking",
so bookmarking a faceted query works, browser history supported.
11. Export / Import of faceted settings as XML. Useful to replicate same facets
navigation on another site.
12. Search engine friendly, disabling javascript acts as a normal collection
batch list.
13. Synchronization of settings across multiple languages, I18N support.
14. High performance by caching faceted catalog queries via `distributed memory
object caching system: memcached <http://www.danga.com/memcached/>`_
15. Smart facets hiding - hide facets criteria if there is only one page of
results (This can be explicitly disabled/enabled from version 4.6.
It is also disabled by default for new faceted navigable pages starting
with version 5.2)
16. Ability to transform faceted navigable items in search forms by
putting them in the 'search mode' (starting with version 4.6)
17. Ability to enable/disable Plone portlets left and right columns within
faceted navigable contexts (starting with version 4.1. Both disabled by
default for new faceted navigable pages starting with version 5.2)
Faceted settings
================
(*New in version 4.1*)
**Faceted settings** is a menu that appears once you enable Faceted navigation
within your context next to the **Actions** menu and it allows you to perform
the following actions:
Enable/disable left portlets
----------------------------
This allows you to gain more space for faceted navigation pages by disabling
Plone portlets left column.
Default: **disabled** (*starting with version 5.2*)
Enable/disable right portlets
-----------------------------
This allows you to gain more space for faceted navigation pages by disabling
Plone portlets right column.
Default: **disabled** (*starting with version 5.2*)
Enable/disable smart facets hiding
----------------------------------
Hide facets criteria if there is only one page of results.
Default: **disabled** (*starting with version 5.2*)
Extra
=====
You can extend faceted navigation functionality by installing the following
addons:
* Customized vocabularies
- Products.ATVocabularyManager
* Multilingual/translation solution
- Products.LinguaPlone
* Syndication
- Products.basesyndication
- Products.fatsyndication
- bda.feed
* Cache (memcache)
- plone.memoize
- lovely.memcached
- eea.cache
* Relations
- eea.relations
* Faceted extensions
- eea.faceted.tool
- eea.faceted.inheritance
* Faceted themes
- eea.faceted.blue
Screenshots
===========
See more `FacetedNavigationScreenshots <http://svn.eionet.europa.eu/projects/Zope/wiki/FacetedNavigationScreenshots>`_.
Live demo
=========
Here some live production demos:
- `EEA Publications <http://www.eea.europa.eu/publications>`_
- `EEA Multimedia <http://www.eea.europa.eu/multimedia/all-videos>`_
- `University of Minnesota - Explore Books <http://upress.umn.edu/explore>`_
Buildout installation
=====================
- Plone 2 and 3
- Buildouts: http://svn.eionet.europa.eu/repositories/Zope/trunk/eea.facetednavigation/buildouts
- Trac: http://svn.eionet.europa.eu/projects/Zope/browser/trunk/eea.facetednavigation/buildouts
- Plone 4+
- Buildout: http://svn.plone.org/svn/collective/eea.facetednavigation/buildout
- Trac: http://dev.plone.org/collective/browser/eea.facetednavigation/buildout
Source code
===========
- Plone 2 and 3:
- Latest source code in EEA svn: https://svn.eionet.europa.eu/repositories/Zope/trunk/eea.facetednavigation/
- Plone 4+
- Collective: https://github.com/collective/eea.facetednavigation
Eggs repository
===============
- http://eggrepo.eea.europa.eu/simple
Plone versions
==============
It has been developed and tested for Plone 2, 3 and 4. See buildouts section above.
Known bugs and ongoing development
==================================
Bugs and new features are entered on our Trac server at EEA.
- `open bugs / tasks <http://svn.eionet.europa.eu/projects/Zope/query?status=assigned&status=new&status=reopened&component=Faceted+navigation&order=priority&col=id&col=summary&col=component&col=status&col=type&col=priority&col=milestone>`_
- `complete list of bugs / features including fixed and open <http://svn.eionet.europa.eu/projects/Zope/query?status=assigned&status=closed&status=new&status=reopened&component=Faceted+navigation&order=priority&col=id&col=summary&col=component&col=status&col=type&col=priority&col=milestone>`_
Copyright and license
=====================
The EEA Faceted Navigation (the Original Code) is free software; you can
redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc., 59
Temple Place, Suite 330, Boston, MA 02111-1307 USA.
The Initial Owner of the Original Code is European Environment Agency (EEA).
Portions created by Eau de Web are Copyright (C) 2009 by
European Environment Agency. All Rights Reserved.
Other resources
===============
- `Faceted navigation pattern <http://www.welie.com/patterns/showPattern.php?patternID=faceted-navigation>`_
- `Faceted classification <http://www.webdesignpractices.com/navigation/facets.html>`_
- `Flamenco faceted navigation <http://flamenco.berkeley.edu/demos.html>`_ made at University of Berkeley
- `A simpler Faceted plone 3 product made 2008 <http://plone.org/products/faceted-navigation>`_
- `Folder navigation (GSoC) <http://plone.org/support/forums/core#nabble-td3165375>`_ A new product Folder Navigation in early development]
- `Exhibit <http://www.simile-widgets.org/exhibit/>`_ Client based faceted navigation via javascript