# nuclia.plone
This Plone add-on allows to index Plone contents in [Nuclia](https://nuclia.com/).
## Create a Nuclia knowledge box
[Create a Nuclia account](https://docs.nuclia.dev/docs/quick-start/create)
## Install the add-on
Add `nuclia.plone` in your buildout in the `eggs` section and run buildout.
Restart Plone.
Go to Site Setup / Add-ons and install `nuclia.plone`.
Go to Nuclia settings, and enter the following:
- Knowledge box ID: you have a default knowledge box created with your Nuclia account, go to [Nuclia dashboard](https://nuclia.cloud/), the knowledge box ID is indicated on the home page in the **Nuclia APi endpoint**.
- API key: see [how to get an API key](https://docs.nuclia.dev/docs/guides/getting-started/quick-start/push#get-an-api-key).
- Region: this the geographical region your knowledge box is attached to.
- Widget snippet: see [how to create a widget](https://docs.nuclia.dev/docs/guides/getting-started/quick-start/search#add-a-search-widget-to-your-website).
- File attribute: the attribute of the content that contains the file to index. Default is `file`.
- Metadata mapping: Nuclia allows to store the following metadata: `title`, `summary`, `tags`, `contributors`, `created`, `modified`. You can map Plone content fields to these metadata fields. If the field belongs to the parent node, use the following format: `parent/field_name`.
- Workflow states: you can choose which workflow states trigger indexing in Nuclia. Default is `published`.
## Usage
Everytime a content having a file is created or modified (and if it is in the appropriate workflow state).
The Nuclia search widget is visible on the `/@@nuclia-search` view.
Contributors
============
- Eric BREHAULT, ebrehault@gmail.com
Changelog
=========
1.0b4 (2024-07-29)
------------------
- Fix tags encoding for Python 2.7
[ebrehault]
1.0b3 (2024-06-28)
------------------
- Manage target folders
[ebrehault]
- Respect workflow state when reindexing
[ebrehault]
1.0b2 (2024-06-27)
------------------
- Conservative encoding for the filename
[ebrehault]
1.0b1 (2024-05-24)
------------------
- Allow to re-index all files
[ebrehault]
- Support different field name for the file content, and allow to map metadata fields
[ebrehault]
- Compliancy with Plone 5.1
[ebrehault]
- Allow to re-index all files
[ebrehault]
1.0a3 (2022-10-10)
------------------
- Fix project metadata.
[ebrehault]
1.0a2 (2022-10-03)
------------------
- Fix project metadata.
[ebrehault]
1.0a1 (2022-10-03)
------------------
- Initial release.
[ebrehault]
Raw data
{
"_id": null,
"home_page": "https://github.com/nuclia/nuclia.plone",
"name": "nuclia.plone",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Python Plone CMS",
"author": "Eric BREHAULT",
"author_email": "ebrehault@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b5/81/0c780d876e55ee532a476a50885391423768805b52a11c28da3c4bcfee96/nuclia.plone-1.0b4.tar.gz",
"platform": null,
"description": "# nuclia.plone\n\n\n\nThis Plone add-on allows to index Plone contents in [Nuclia](https://nuclia.com/).\n\n## Create a Nuclia knowledge box\n\n[Create a Nuclia account](https://docs.nuclia.dev/docs/quick-start/create)\n\n## Install the add-on\n\nAdd `nuclia.plone` in your buildout in the `eggs` section and run buildout.\n\nRestart Plone.\n\nGo to Site Setup / Add-ons and install `nuclia.plone`.\n\nGo to Nuclia settings, and enter the following:\n\n- Knowledge box ID: you have a default knowledge box created with your Nuclia account, go to [Nuclia dashboard](https://nuclia.cloud/), the knowledge box ID is indicated on the home page in the **Nuclia APi endpoint**.\n- API key: see [how to get an API key](https://docs.nuclia.dev/docs/guides/getting-started/quick-start/push#get-an-api-key).\n- Region: this the geographical region your knowledge box is attached to.\n- Widget snippet: see [how to create a widget](https://docs.nuclia.dev/docs/guides/getting-started/quick-start/search#add-a-search-widget-to-your-website).\n- File attribute: the attribute of the content that contains the file to index. Default is `file`.\n- Metadata mapping: Nuclia allows to store the following metadata: `title`, `summary`, `tags`, `contributors`, `created`, `modified`. You can map Plone content fields to these metadata fields. If the field belongs to the parent node, use the following format: `parent/field_name`.\n- Workflow states: you can choose which workflow states trigger indexing in Nuclia. Default is `published`.\n\n## Usage\n\nEverytime a content having a file is created or modified (and if it is in the appropriate workflow state).\n\nThe Nuclia search widget is visible on the `/@@nuclia-search` view.\n\n\nContributors\n============\n\n- Eric BREHAULT, ebrehault@gmail.com\n\n\nChangelog\n=========\n\n1.0b4 (2024-07-29)\n------------------\n\n- Fix tags encoding for Python 2.7\n [ebrehault]\n\n\n1.0b3 (2024-06-28)\n------------------\n\n- Manage target folders\n [ebrehault]\n- Respect workflow state when reindexing\n [ebrehault]\n\n\n1.0b2 (2024-06-27)\n------------------\n\n- Conservative encoding for the filename\n [ebrehault]\n\n\n1.0b1 (2024-05-24)\n------------------\n\n- Allow to re-index all files\n [ebrehault]\n\n- Support different field name for the file content, and allow to map metadata fields\n [ebrehault]\n\n- Compliancy with Plone 5.1\n [ebrehault]\n\n- Allow to re-index all files\n [ebrehault]\n\n\n1.0a3 (2022-10-10)\n------------------\n\n- Fix project metadata.\n [ebrehault]\n\n1.0a2 (2022-10-03)\n------------------\n\n- Fix project metadata.\n [ebrehault]\n\n\n1.0a1 (2022-10-03)\n------------------\n\n- Initial release.\n [ebrehault]\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Integrate Nuclia search in Plone",
"version": "1.0b4",
"project_urls": {
"Homepage": "https://github.com/nuclia/nuclia.plone",
"PyPI": "https://pypi.python.org/pypi/nuclia.plone",
"Source": "https://github.com/nuclia/nuclia.plone",
"Tracker": "https://github.com/nuclia/nuclia.plone/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5810c780d876e55ee532a476a50885391423768805b52a11c28da3c4bcfee96",
"md5": "4fcdce7a36ebebb44b78d79a43d745d1",
"sha256": "1fe0c80bd4587c84781a4fc325122d5bafb9cbf8dd88caef98615bd5f6ac5164"
},
"downloads": -1,
"filename": "nuclia.plone-1.0b4.tar.gz",
"has_sig": false,
"md5_digest": "4fcdce7a36ebebb44b78d79a43d745d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 25991,
"upload_time": "2024-07-29T13:38:14",
"upload_time_iso_8601": "2024-07-29T13:38:14.735935Z",
"url": "https://files.pythonhosted.org/packages/b5/81/0c780d876e55ee532a476a50885391423768805b52a11c28da3c4bcfee96/nuclia.plone-1.0b4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 13:38:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nuclia",
"github_project": "nuclia.plone",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "nuclia.plone"
}
JSON
