Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #105

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ Changelog
3.4.3 (unreleased)
------------------

- Use collection from context as default. `target_collection` is now used to select an alternative collection as result source.
- Use collection from context as default. `target_collection` is now used to select an alternative collection as result source.
This allows to copy and paste preconfigured collections for reuse without reconfiguring each filter element.
[agitator]

- Fix search which include the terms "and", "or" and "not"
[jeffersonbledsoe]

- Update ``plone.app.mosaic`` integration documentation with the
new ``Contentlisting tile`` feature (this needs ``plone.app.standardtiles`` >= 2.3.3)
[petschki]


3.4.2 (2021-02-25)
------------------
Expand Down
18 changes: 12 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,19 @@ source collection template and on the target page which shows the filtered resul
Mosaic Integration
------------------

The three tiles can be added within the Mosaic editor multiple times. Just select them in the ``Insert`` menu
and assign a collection to it. To show the results of the collection simply add a
``Existing Content`` tile which links to the same collection your filter tiles are assigned with.
If ``plone.app.mosaic`` is installed you can enable the ``collective.collectionfilter tiles`` profile
in the addon controlpanel.

TODO: right now the collection needs a default_view template, which wraps the result list with a unique selector
inside the ``#content-core`` container. so the collectionfilter can load the filtered result correctly from
the collection into the container inside the existing content tile.
The filter tiles can be added within the Mosaic editor multiple times. Just select them in the ``Insert`` menu
and assign a collection to it.

As a second step you have to add a ``ContentListing`` tile which shows the search result initially.
If you are enable Mosaic on a ISyndicatableCollection context you can use the query from it.
Copy link
Member

@djay djay May 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might need more explanation on how to enable ISyndicatableCollection?
Does this only apply to some verisons or plone because so far haven't been able to get this to work in plone 5.0


*Important*:

Make shure you add a unique *tile CSS class* and use this class as ``Content CSS Selector``
in your filter tiles so that AJAX reload works correctly for the result listing.


Geolocation filter support
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
-r https://raw.githubusercontent.com/plone/buildout.coredev/5.2/requirements.txt
6 changes: 5 additions & 1 deletion test-5.0.x.cfg
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
[buildout]
eggs-directory = ${buildout:directory}/eggs
download-cache = ${buildout:directory}/downloads

extends =
https://raw.githubusercontent.com/collective/buildout.plonetest/master/test-5.0.x.cfg
https://raw.githubusercontent.com/collective/buildout.plonetest/master/qa.cfg
Expand All @@ -18,9 +21,10 @@ test-eggs =
flake8-ignore = E501,E241

[versions]
setuptools =
zc.buildout =
setuptools =
pycodestyle =
lxml =
configparser = 3.8.1
coverage = >=3.7

Expand Down
2 changes: 1 addition & 1 deletion test-5.1.x.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ test-eggs =
flake8-ignore = E501,E241

[versions]
setuptools =
zc.buildout =
setuptools =
configparser = 3.8.1
coverage = >=3.7

Expand Down
4 changes: 2 additions & 2 deletions test-5.2.x.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ test-eggs =
flake8-ignore = E501,E241

[versions]
#setuptools =
#zc.buildout =
zc.buildout =
setuptools =
coverage = >=3.7