Metadata-Version: 2.1
Name: onlyoffice.connector
Version: 1.0.0
Summary: Plone ONLYOFFICE integration plugin
Home-page: https://github.com/ONLYOFFICE/onlyoffice-plone
Author: Ascensio System SIA
Author-email: integration@onlyoffice.com
License: AGPL version 3
Project-URL: PyPI, https://pypi.python.org/pypi/onlyoffice.connector
Project-URL: Source, https://github.com/ONLYOFFICE/onlyoffice-plone
Project-URL: Tracker, https://github.com/ONLYOFFICE/onlyoffice-plone/issues
Description: # Plone ONLYOFFICE integration plugin
        
        This plugin allows users to edit office documents within [Plone](https://plone.org/) using ONLYOFFICE Document Server - [Community or Integration Edition](#onlyoffice-document-server-editions).
        
        ## 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.
        * For viewing only: PDF, ODT, ODS, ODP, DOC, XLS, PPT.
        
        ## Installing ONLYOFFICE Document Server
        
        You will need an instance of ONLYOFFICE 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 Document Server or scalable enterprise-level Integration Edition.
        
        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 Integration Edition, follow instructions [here](https://helpcenter.onlyoffice.com/server/integration-edition/index.aspx).
        
        Community Edition vs Integration Edition comparison can be found [here](#onlyoffice-document-server-editions).
        
        ## Installing Plone ONLYOFFICE integration plugin
        
        Install plugin by adding it to your `buildout.cfg`:
        
        ```
        [buildout]
        
        ...
        
        eggs =
            onlyoffice.connector
        ```
        
        and then running `bin/buildout`
        
        To enable plugin, go to `Site Setup` -> `Add-ons`and press the `Install` button.
        
        ## 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.
        
        ## 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.
        
        ## Developing Plone ONLYOFFICE plugin
        
        - Clone repository and change directory
        
        ```
        git clone --branch deploy git@github.com:ONLYOFFICE/onlyoffice-plone.git
        cd onlyoffice-plone
        ```
        
         - Create a virtualenv in the package
         - Install requirements with pip
         - Run buildout
        
        ```
        virtualenv --clear .
        ./bin/pip install -r requirements.txt
        ./bin/buildout
        ```
        
         - Start Plone in foreground
        
        ```
        ./bin/instance fg
        ```
        
        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 <username>` line to `./parts/instance/etc/zope.conf`.
        
        ## ONLYOFFICE Document Server editions
        
        ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.
        
        **ONLYOFFICE Document Server:**
        
        * Community Edition (`onlyoffice-documentserver` package)
        * Integration Edition (`onlyoffice-documentserver-ie` package)
        
        The table below will help you make the right choice.
        
        | Pricing and licensing | Community Edition | Integration Edition |
        | ------------- | ------------- | ------------- |
        | | [Get it now](https://www.onlyoffice.com/download.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone)  | [Start Free Trial](https://www.onlyoffice.com/connectors-request.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone)  |
        | Cost  | FREE  | [Go to the pricing page](https://www.onlyoffice.com/integration-edition-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** | **Integration Edition** | 
        | Documentation | [Help Center](https://helpcenter.onlyoffice.com/server/docker/opensource/index.aspx) | [Help Center](https://helpcenter.onlyoffice.com/server/integration-edition/index.aspx) |
        | Standard support | [GitHub](https://github.com/ONLYOFFICE/DocumentServer/issues) or paid | One year support included |
        | Premium support | [Buy Now](https://www.onlyoffice.com/support.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone) | [Buy Now](https://www.onlyoffice.com/support.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone) |
        | **Services** | **Community Edition** | **Integration Edition** | 
        | Conversion Service                | + | + | 
        | Document Builder Service          | + | + | 
        | **Interface** | **Community Edition** | **Integration Edition** |
        | Tabbed interface                       | + | + |
        | White Label                            | - | - |
        | Integrated test example (node.js)     | - | + |
        | **Plugins & Macros** | **Community Edition** | **Integration Edition** |
        | Plugins                           | + | + |
        | Macros                            | + | + |
        | **Collaborative capabilities** | **Community Edition** | **Integration 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** | **Integration Edition** |
        | Font and paragraph formatting   | + | + |
        | Object insertion                | + | + |
        | Adding Content control          | - | + | 
        | Editing Content control         | + | + | 
        | Layout tools                    | + | + |
        | Table of contents               | + | + |
        | Navigation panel                | + | + |
        | Comparing Documents             | - | +* |
        | **Spreadsheet Editor features** | **Community Edition** | **Integration Edition** |
        | Font and paragraph formatting   | + | + |
        | Object insertion                | + | + |
        | Functions, formulas, equations  | + | + |
        | Table templates                 | + | + |
        | Pivot tables                    | +** | +** |
        | **Presentation Editor features** | **Community Edition** | **Integration Edition** |
        | Font and paragraph formatting   | + | + |
        | Object insertion                | + | + |
        | Animations                      | + | + |
        | Presenter mode                  | + | + |
        | Notes                           | + | + |
        | | [Get it now](https://www.onlyoffice.com/download.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone)  | [Start Free Trial](https://www.onlyoffice.com/connectors-request.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubPlone)  |
        
        \* It's possible to add documents for comparison from your local drive and from URL. Adding files for comparison from storage is not available yet.
        
        \** Changing style and deleting (Full support coming soon)
        
        
        # Authors
        
        * Ascensio System SIA: <integration@onlyoffice.com>
        
        
        
        # Change Log
        
        ## 1.0.0
        ## Added
         - Edit option for DOCX, XLSX, PPTX.
         - View template for documents
         - Configuration page
         - Translations for BR, CZ, DE, EN, ES, FR, IT, JP, NL, RU, ZH
Keywords: Python Plone
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 5.1
Classifier: Framework :: Plone :: 5.2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: test
