diff --git a/CHANGELOG.md b/CHANGELOG.md index 9aa38fc..b50fc47 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Change Log +## 2.2.0 +- moved to onlyoffice.plone + ## 2.1.1 ## Fixed - issue with packaging diff --git a/README.md b/README.md index c695e42..bbc8071 100644 --- a/README.md +++ b/README.md @@ -1,201 +1,5 @@ # Plone ONLYOFFICE integration plugin -This plugin allows users to edit office documents within [Plone](https://plone.org/) using ONLYOFFICE Docs packaged as Document Server - [Community or Enterprise Edition](#onlyoffice-docs-editions). +Moved to [onlyoffice.plone](https://pypi.org/project/onlyoffice.plone/) -## Features - -The plugin allows to: - -* Create and edit text documents, spreadsheets, and presentations. -* Share documents with other users. -* Co-edit documents in real-time: use two co-editing modes (Fast and Strict), Track Changes, comments, and built-in chat. - -Supported formats: - -* For viewing and editing: DOCX, XLSX, PPTX, DOCXF, OFORM. -* For viewing only: PDF, ODT, ODS, ODP, DOC, XLS, PPT. - -## Installing ONLYOFFICE Docs - -You will need an instance of ONLYOFFICE Docs (Document Server) that is resolvable and connectable both from Plone and any end-clients. ONLYOFFICE Document Server must also be able to POST to Plone directly. - -You can install free Community version of ONLYOFFICE Docs or scalable Enterprise Edition with pro features. - -To install free Community version, use [Docker](https://github.com/onlyoffice/Docker-DocumentServer) (recommended) or follow [these instructions](https://helpcenter.onlyoffice.com/server/linux/document/linux-installation.aspx) for Debian, Ubuntu, or derivatives. - -To install Enterprise Edition, follow instructions [here](https://helpcenter.onlyoffice.com/server/integration-edition/index.aspx). - -Community Edition vs Enterprise Edition comparison can be found [here](#onlyoffice-docs-editions). - -## Installing Plone ONLYOFFICE integration plugin - -1. Install plugin by adding it to your `buildout.cfg`: - ``` - [buildout] - - ... - - eggs = - onlyoffice.connector - ``` -2. Run `bin/buildout`. -3. Go to `Site Setup` -> `Add-ons`and press the `Install` button to enable plugin. - -You could also install plugin via Docker -``` -docker run --rm -p 8080:8080 -e ADDONS="onlyoffice.connector" plone -``` -Both options will automatically install plugin from [PyPi](https://pypi.org/project/onlyoffice.connector/). - -## Configuring Plone ONLYOFFICE integration plugin - -To configure plugin go to `Site Setup`. Scroll down to `Add-ons Configuration` section and press the `ONLYOFFICE Configuration` button. - -## Developing Plone ONLYOFFICE plugin - -1. Clone repository and change directory: - ``` - git clone --branch deploy git@github.com:ONLYOFFICE/onlyoffice-plone.git - cd onlyoffice-plone - ``` -2. Create a virtualenv in the package. -3. Install requirements with pip. -4. Run buildout: - ``` - virtualenv . - ./bin/pip install -r requirements.txt - ./bin/buildout - ``` -5. Start Plone in foreground: - ``` - ./bin/instance fg - ``` -If you have a working Plone instance, you can install plugin by adding the project files to the src directory: -1. In the src directory create the onlyoffice.connector directory. -2. Put your project files received by git into the onlyoffice.connector directory. -3. Edit the buildout.cfg file: - ``` - [buildout] - - ... - - eggs = - onlyoffice.connector - - develop = - src/onlyoffice.connector - ``` -4. Rerun buildout for the changes to take effect: - ``` - ./bin/buildout - ``` -5. Then start or restart your Plone instance. - -Note that Plone is based on Zope server and will not run as `root` user. If you intend to run it as `root` user. You must supply [effective-user directive](https://zope.readthedocs.io/en/2.12/SETUID.html). In order to do so add `effective-user ` line to `./parts/instance/etc/zope.conf`. - -## Upgrade Plone ONLYOFFICE integration plugin -1. If you specified a concrete plugin version in your buildout.cfg file (so-called “pinning”, and a recommended practice), - like onlyoffice.connector = 1.0.0, update this reference to point to the newer version. If the plugin version is not - specified, then the latest version will be automatically loaded: - ``` - [versions] - - ... - - onlyoffice.connector = 1.0.1 - ``` -2. Run bin/buildout. Wait until the new version is downloaded and installed. -3. Restart Plone - your site may look weird, or even be inaccessible until you have performed the next step. -4. Navigate to the Add-on screen (add /prefs_install_products_form to your site URL) and in the Upgrades list select onlyoffice.connector and click "Upgrade onlyoffice.connector". - -## How it works - -The ONLYOFFICE integration follows the API documented [here](https://api.onlyoffice.com/editors/basic): - -* User navigates to a document within Plone and selects the `ONLYOFFICE Edit` action. -* Plone prepares a JSON object for the Document Server with the following properties: - * **url**: the URL that ONLYOFFICE Document Server uses to download the document; - * **callbackUrl**: the URL that ONLYOFFICE Document Server informs about status of the document editing; - * **key**: the UUID+Modified Timestamp to instruct ONLYOFFICE Document Server whether to download the document again or not; - * **title**: the document Title (name). -* Plone constructs a page from a `.pt` template, filling in all of those values so that the client browser can load up the editor. -* The client browser makes a request for the javascript library from ONLYOFFICE Document Server and sends ONLYOFFICE Document Server the docEditor configuration with the above properties. -* Then ONLYOFFICE Document Server downloads the document from Plone and the user begins editing. -* ONLYOFFICE Document Server sends a POST request to the `callback` URL to inform Plone that a user is editing the document. -* When all users and client browsers are done with editing, they close the editing window. -* After 10 seconds of inactivity, ONLYOFFICE Document Server sends a POST to the `callback` URL letting Plone know that the clients have finished editing the document and closed it. -* Plone downloads the new version of the document, replacing the old one. - -## ONLYOFFICE Docs editions - -ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers. - -* Community Edition (`onlyoffice-documentserver` package) -* Enterprise Edition (`onlyoffice-documentserver-ie` package) - -The table below will help you make the right choice. - -| Pricing and licensing | Community Edition | Enterprise Edition | -| ------------- | ------------- | ------------- | -| | [Get it now](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone#docs-enterprise) | -| Cost | FREE | [Go to the pricing page](https://www.onlyoffice.com/docs-enterprise-prices.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone) | -| Simultaneous connections | up to 20 maximum | As in chosen pricing plan | -| Number of users | up to 20 recommended | As in chosen pricing plan | -| License | GNU AGPL v.3 | Proprietary | -| **Support** | **Community Edition** | **Enterprise Edition** | -| Documentation | [Help Center](https://helpcenter.onlyoffice.com/installation/docs-community-index.aspx) | [Help Center](https://helpcenter.onlyoffice.com/installation/docs-enterprise-index.aspx) | -| Standard support | [GitHub](https://github.com/ONLYOFFICE/DocumentServer/issues) or paid | One year support included | -| Premium support | [Contact us](mailto:sales@onlyoffice.com) | [Contact us](mailto:sales@onlyoffice.com) | -| **Services** | **Community Edition** | **Enterprise Edition** | -| Conversion Service | + | + | -| Document Builder Service | + | + | -| **Interface** | **Community Edition** | **Enterprise Edition** | -| Tabbed interface | + | + | -| Dark theme | + | + | -| 125%, 150%, 175%, 200% scaling | + | + | -| White Label | - | - | -| Integrated test example (node.js) | + | + | -| Mobile web editors | - | +* | -| **Plugins & Macros** | **Community Edition** | **Enterprise Edition** | -| Plugins | + | + | -| Macros | + | + | -| **Collaborative capabilities** | **Community Edition** | **Enterprise Edition** | -| Two co-editing modes | + | + | -| Comments | + | + | -| Built-in chat | + | + | -| Review and tracking changes | + | + | -| Display modes of tracking changes | + | + | -| Version history | + | + | -| **Document Editor features** | **Community Edition** | **Enterprise Edition** | -| Font and paragraph formatting | + | + | -| Object insertion | + | + | -| Adding Content control | + | + | -| Editing Content control | + | + | -| Layout tools | + | + | -| Table of contents | + | + | -| Navigation panel | + | + | -| Mail Merge | + | + | -| Comparing Documents | + | + | -| **Spreadsheet Editor features** | **Community Edition** | **Enterprise Edition** | -| Font and paragraph formatting | + | + | -| Object insertion | + | + | -| Functions, formulas, equations | + | + | -| Table templates | + | + | -| Pivot tables | + | + | -| Data validation | + | + | -| Conditional formatting | + | + | -| Sparklines | + | + | -| Sheet Views | + | + | -| **Presentation Editor features** | **Community Edition** | **Enterprise Edition** | -| Font and paragraph formatting | + | + | -| Object insertion | + | + | -| Transitions | + | + | -| Presenter mode | + | + | -| Notes | + | + | -| **Form creator features** | **Community Edition** | **Enterprise Edition** | -| Adding form fields | + | + | -| Form preview | + | + | -| Saving as PDF | + | + | -| | [Get it now](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone#docs-enterprise) | - -\* If supported by DMS. \ No newline at end of file +**Please note:** you have the previous plugin version installed (earlier plugin versions with the previous name onlyoffice.connector), please remove it before installing the new version. diff --git a/setup.py b/setup.py index ad53e24..57d8916 100644 --- a/setup.py +++ b/setup.py @@ -14,8 +14,8 @@ setup( name='onlyoffice.connector', - version='2.1.1', - description="Plone ONLYOFFICE integration plugin", + version='2.2.0', + description="Plone ONLYOFFICE integration plugin (deprecated). Moved to https://pypi.org/project/onlyoffice.plone/", long_description=long_description, long_description_content_type="text/markdown", # Get more from https://pypi.org/classifiers/ diff --git a/src/onlyoffice/connector/profiles/default/metadata.xml b/src/onlyoffice/connector/profiles/default/metadata.xml index 2c01a41..b9043a9 100644 --- a/src/onlyoffice/connector/profiles/default/metadata.xml +++ b/src/onlyoffice/connector/profiles/default/metadata.xml @@ -1,6 +1,6 @@ - 2110 + 2200