Skip to content

Commit

Permalink
Update README and License
Browse files Browse the repository at this point in the history
  • Loading branch information
ksuess committed Nov 16, 2022
1 parent c421901 commit 5ee5278
Show file tree
Hide file tree
Showing 11 changed files with 50 additions and 116 deletions.
14 changes: 7 additions & 7 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
MIT License

Copyright (c) 2020 Plone Foundation
Copyright (C) 2022 Rohberg, Zürich.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Expand Down
9 changes: 0 additions & 9 deletions LICENSE.md

This file was deleted.

39 changes: 19 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
# volto-searchkit-block
# @rohberg/volto-searchkit-block


## Features

### Search

Highly overridable components for searching, filtering and displaying search results. Sometimes also called faceted navigation.
Search block with highly overridable components for searching, filtering and displaying search results. Sometimes also called faceted navigation.

As this search is addressing `ElasticSearch` with Analysis, the search does understand flexation of words and tolerates typos by fuzzy searching.
As this search is addressing `ElasticSearch` with Analysis, the search does understand inflection of words and tolerates typos by fuzzy searching.

Matched phrases are shown with matches highlighted.
Matched phrases are shown with highlighted matches.

Additional metadata per result item can be configured easily.
Meta data values are clickable to find related content.

The block is prepared for Matomo analytics.


![Search @rohberg/volto-searchkit-block](public/search.png)


## Getting started

You have ElasticSearch up and running with Plone. See `collective.elastic.ingest` and `collective.elastic.ingest` how to set up.

For searching in blocks content, install `rohberg.elasticsearchblocks` and enable its behavior.
For searching in blocks content, install [`rohberg.elasticsearchblocks`](https://github.com/rohberg/rohberg.elasticsearchblocks) and enable its behavior.


## Configuration
Expand All @@ -41,33 +42,31 @@ The block can be configured by
- facets
- restricting types and states

<div style="width:30%">
![Configuration](public/configuration.png)
</div>
![Configuration](public/configuration.png)


Enable Matomo tracking via

```js
config.settings.searchkitblock = {
...config.settings.searchkitblock,
trackVoltoMatomo: true,
};
config.settings.searchkitblock.trackVoltoMatomo = true
```

## panel for testing matches

/controlpanel/test-searchkit-querystrings
## Panel for testing matches

`/controlpanel/test-searchkit-querystrings`

Please update the settings according to your deployment: `/controlpanel/volto_searchkit_block_control_panel`

Please update the settings according to your deployment: /controlpanel/volto_searchkit_block_control_panel

## Credits

This package is a Plone Volto integration of react-searchkit https://www.npmjs.com/package/react-searchkit
This package is a Plone Volto integration of react-searchkit https://www.npmjs.com/package/react-searchkit Copyright (C) 2015-2019 CERN.


## Copyright and license

The Initial Owner of the Original Code is Rohberg, Zürich.
All Rights Reserved.
Copyright (C) 2022 Rohberg.

See [LICENSE.md](https://github.com/rohberg/volto-searchkit-block/blob/master/LICENSE.md) for details.
The project is licensed.
See [LICENSE](https://github.com/rohberg/volto-searchkit-block/blob/master/LICENSE) for details.
Binary file modified public/configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions src/components/Searchkit/ESRequestSerializer.jsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
/*
* This file is part of React-SearchKit.
* Copyright (C) 2019 CERN.
*
* React-SearchKit is free software; you can redistribute it and/or modify it
* under the terms of the MIT License; see LICENSE file for more details.
*/

import _isEmpty from 'lodash/isEmpty';

export class ESRequestSerializer {
Expand Down
8 changes: 0 additions & 8 deletions src/components/Searchkit/ESResponseSerializer.jsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
/*
* This file is part of React-SearchKit.
* Copyright (C) 2019 CERN.
*
* React-SearchKit is free software; you can redistribute it and/or modify it
* under the terms of the MIT License; see LICENSE file for more details.
*/

export class ESResponseSerializer {
constructor() {
this.serialize = this.serialize.bind(this);
Expand Down
21 changes: 21 additions & 0 deletions src/components/Searchkit/LICENSE_Cern_react-searchkit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (C) 2015-2019 CERN.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
3 changes: 3 additions & 0 deletions src/components/Searchkit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
`volto-searchkit-block` is an integration of `react-searchkit` in `Volto / Plone 6`.

`react-searchkit` Copyright (C) 2015-2019 CERN
8 changes: 0 additions & 8 deletions src/components/Searchkit/Results.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
/*
* This file is part of React-SearchKit.
* Copyright (C) 2019 CERN.
*
* React-SearchKit is free software; you can redistribute it and/or modify it
* under the terms of the MIT License; see LICENSE file for more details.
*/

import React, { Component } from 'react';
import { Grid, Icon as IconSemantic } from 'semantic-ui-react';
import { Count, Pagination, ResultsMultiLayout, Sort } from 'react-searchkit';
Expand Down
5 changes: 0 additions & 5 deletions src/components/Searchkit/constants.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
const listFilterFields = [];

// Nested fields are configurable via block
// const facet_fields = [
// 'informationtype'
// ];

export { listFilterFields };
51 changes: 0 additions & 51 deletions src/components/Searchkit/queries.txt

This file was deleted.

0 comments on commit 5ee5278

Please sign in to comment.