"Folder" option filter portlet/tile

[djay]

How it works

The idea is to support documents that are already organised by folders with useful names and where heretical organisation might be needed.

1. Create a normal filter portlet
2. Select "Folder" as the groupby
3. Pick if you want dropdown, links or checkboxes/radio etc
4. Will display the top level folders with counts inside each based on other other filters already applied. Won't display folders with no content in the results
5. Will "open" a folder if selected. This will show counts for subfolders at this new level similar to the the top level (it only shows folders). Indenting is used to show the folder hierarchy.
6. if a folder is opened (ie selected) then this will narrow down other filters
7. You can "open" multiple folders at once if enabled

Changes

I took the code from #26 and replaced the new section filter with an option in the existing filter portlet. It mostly does this by using new groupby_criteria defaults

Pros

• can select multiple paths using checkboxes or links
• same modifiers can be used to achieve the same result for anything path like e.g. multi-level taxonomy
• less code
• less clutter in the UI of having another portlet type

Cons

• Won't appear exactly like a navigation portlet
  • but I think it doesn't behave exactly like a navigation portlet so maybe this is a pro?

Changes to groupby_criteria

Introduced the following changes to groupby_criteria overrides

• groupby_modifier.
  • Lets you turn single metadata value one or more other values. Also allows removing certain values so could replace value_blacklist.
  • For Folders it allows a leaf to include all its parents as options.
  • It ensures the order that options are added is preserved
• "groupby_name" which allows integrators to override the name of an index/grouby_criteria
• sort_on - allows query used to determine options to be sorted so options are sorted using the index rather than a function.
  • this didn't end up being used for Folders so can be removed if desired

Indenting

• currently uses css_modifier to ident radio and checkboxes
• dropdowns don't support css for options so level is converted to  
  • would be better if there was a css way - e.g. https://stackoverflow.com/questions/1037732/nesting-optgroups-in-a-dropdownlist-select

Alternatives

• support level/nesting directly via a level_modifier
  • Any widget used will then have to choose how best to display this
  • could be useful for taxonomies that also need to display multiple levels/nesting?
• have widgets be paths and then widgets know to display these nested
  • e.g. "My Folder / My sub" will get turned into "{indent}My Sub" by the templates/widgets
• Support customisable widgets/templates (later)
  • ie modifier can specify new template for a given index which cab better display that index, e.g. tree control

"Folder" as criteria name

When you pick the groupby it's called "Folder"

Pros

• it's a terms used in plone elsewhere and should be obvious what it means. Path is more a technical term.
• It only displays folders, never full paths.
  Cons
• in collections its called "Location"

Alternatives

• Section
• Path
• Location
• use translation to pick english name instead of groupby_criteria

[djay]

@agitator any answers to the questions above?

[djay]

@petschki I've cleaned it all up and finalised the things I wasn't sure on. It's ready for a review.
The only thing I haven't done is fix the css and compile it.