From 214e0c44048263fc3be63059d09261638cbaab5a Mon Sep 17 00:00:00 2001 From: trovier Date: Fri, 29 Mar 2024 13:24:55 +0100 Subject: [PATCH] Initial commit --- .../Common/BaseHeader/BaseHeader.ascx | 1 + .../GettingStartedDrupalDocspace.ascx | 224 ++++++++++++++++++ Web/Controls/Help/HelpCenter.ascx | 1 + .../Help/Integration/DrupalDocspace.ascx | 50 ++++ .../Help/Integration/Integration.ascx | 22 ++ .../SideMenu/Integration/IntegrationMenu.ascx | 1 + Web/Integration/drupal-docspace.aspx | 19 ++ .../gettingstarted-drupal-docspace.aspx | 21 ++ Web/css/help.less | 2 +- .../DrupalDS/big/configuration.png | Bin 0 -> 19831 bytes .../Integration/DrupalDS/small/checkmark.png | Bin 0 -> 168 bytes .../DrupalDS/small/configuration.png | Bin 0 -> 15333 bytes .../Integration/DrupalDS/small/hourglass.png | Bin 0 -> 199 bytes 13 files changed, 340 insertions(+), 1 deletion(-) create mode 100644 Web/Controls/Help/GettingStarted/Integration/DrupalDocspace/GettingStartedDrupalDocspace.ascx create mode 100644 Web/Controls/Help/Integration/DrupalDocspace.ascx create mode 100644 Web/Integration/drupal-docspace.aspx create mode 100644 Web/Integration/gettingstarted-drupal-docspace.aspx create mode 100644 Web/images/Help/GettingStarted/Integration/DrupalDS/big/configuration.png create mode 100644 Web/images/Help/GettingStarted/Integration/DrupalDS/small/checkmark.png create mode 100644 Web/images/Help/GettingStarted/Integration/DrupalDS/small/configuration.png create mode 100644 Web/images/Help/GettingStarted/Integration/DrupalDS/small/hourglass.png diff --git a/Web/Controls/Common/BaseHeader/BaseHeader.ascx b/Web/Controls/Common/BaseHeader/BaseHeader.ascx index e72d5536e..3bf37dd60 100644 --- a/Web/Controls/Common/BaseHeader/BaseHeader.ascx +++ b/Web/Controls/Common/BaseHeader/BaseHeader.ascx @@ -118,6 +118,7 @@ + diff --git a/Web/Controls/Help/GettingStarted/Integration/DrupalDocspace/GettingStartedDrupalDocspace.ascx b/Web/Controls/Help/GettingStarted/Integration/DrupalDocspace/GettingStartedDrupalDocspace.ascx new file mode 100644 index 000000000..d63c0fb7e --- /dev/null +++ b/Web/Controls/Help/GettingStarted/Integration/DrupalDocspace/GettingStartedDrupalDocspace.ascx @@ -0,0 +1,224 @@ +<%@ Control Language="C#" Inherits="BaseContentUserControls"%> +<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %> +<%@ Register TagPrefix="cc" TagName="LinuxVersionTag" Src="~/Controls/Help/Tags/linux-version/linux-version.ascx" %> + + + +
+ +
+
    +
    • +
    • +
    • +
    • +
    • +
    • +
    • +
+
+ + +
+

ONLYOFFICE DocSpace module for Drupal

+
+

Drupal is an open-source content manager system used for building APIs. This module enables users to access ONLYOFFICE DocSpace, a room-based collaborative environment, from Drupal, as well as add DocSpace rooms and files to the Drupal pages. The module is distributed under the GNU General Public License v.2.0.

+
+ +
+

Main features

+

+
    +
  • Creating and editing documents, spreadsheets, presentations, and forms within WordPress.
    • +
  • Adding a DocSpace room or file to the Drupal page.
    • +
  • Viewing and editing documents within the Drupal page without the necessity to download documents.
    • +
  • Creating DocSpace rooms within Drupal.
    • +
+
+ +
+

Supported formats

+

+
    +
  • For editing: DOCX, XLSX, PPTX.
    • +
  • For viewing only: DJVU, DOC, DOCM, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTML, MHT, ODT, OTT, OXPS, PDF, RTF, TXT, XPS, XML, CSV, FODS, ODS, OTS, XLS, XLSM, XLT, XLTM, XLTX, FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM.
    • +
+
+ + <%--
+

What's new in version 1.1.2

+

Added

+
    +
  • Security filtering
    • +
  • Viewing option for DOCX, XLSX, PPTX formats
    • +
  • JWT support
    • +
+

Changed

+
    +
  • Minor documentation style changes
    • +
  • Minor code style changes
    • +
+

The full change log is available here.

+
+
+
--%> + +
+

Connecting ONLYOFFICE DocSpace to Drupal

+ +
+

Requirements

+
    +
  • Drupal core module.
    • +
  • ONLYOFFICE DocSpace SaaS or server version.
    • +
  • ONLYOFFICE DocSpace plugin for Drupal.
    • +
+
+ +
+

Plugin installation and configuration

+
+
    +
  1. Switch to the Extend section in the admin settings and click the Add new module menu item.
    2. +
  2. Upload the ONLYOFFICE module and click Continue.
    3. +
  3. When the uploaded module appears in the list, select it by checking and click the Install button.
    4. +
  4. + Once ready, go to the module settings via Configuration –> MEDIA –> ONLYOFFICE DocSpace Connector settings and specify the following parameters: +
      +
    • DocSpace Service Address
      • +
    • DocSpace Admin Login and Password
      • +
    +
    5. +
  5. Click the Save button.
    6. +
+

A user with the Room admin role will be created in ONLYOFFICE DocSpace, with the same data as the current Drupal user. A public user (Drupal Viewer) will be also added to DocSpace with the View Only access.

+
+ Installing the ONLYOFFICE DocSpace connector for Drupal" /> + Installing the ONLYOFFICE DocSpace connector for Drupal" /> +
+
+
+
+ + +
+

Exporting users to DocSpace

+

To export users from your Drupal to ONLYOFFICE DocSpace,

+
    +
  1. Click the Export Now button on the module settings page. A page with the list which contains Drupal users will open.
    2. +
  2. To add a user or several users to DocSpace: +
      +
    • check the required users in the list;
      • +
    • select Invite to DocSpace from the drop-down list;
      • +
    • click the Apply to selected items button.
      • +
    +
+

In the DocSpace User Status column of this list, you can track whether a Drupal user has been added to DocSpace or not:

+
    +
  • Green checkmark" /> Green checkmark: a Drupal user with the specified email has been added to DocSpace. Synchronization was successful.
    • +
  • Empty value: there is no Drupal user with the specified email in DocSpace. You can invite them.
    • +
  • Hourglass" /> Hourglass: there is a user in DocSpace with the specified email, but there was a synchronization issue. When logging into the DocSpace plugin for the first time, the user will need to provide a DocSpace login and password to complete synchronization.
    • +
+
+ +
+ +
+

Start using ONLYOFFICE DocSpace within Drupal

+ +
+

Working in ONLYOFFICE DocSpace within Drupal

+
+

After setting up the module, DocSpace will become available for users with the Administer ONLYOFFICE DocSpace connector permission: People –> Permissions -> ONLYOFFICE DocSpace Connector.

+

These users are able to access ONLYOFFICE DocSpace where it's possible to create Collaboration and Custom rooms, invite users, and collaborate on documents within the rooms.

+

For more details on working with ONLYOFFICE DocSpace, please refer to ">our guides.

+
+
+ +
+

Adding DocSpace rooms and files to the Drupal pages

+

Before you can add a DocSpace room or file to the Drupal page, you need to make changes to the table structure.

+
    +
  1. Go to Structure -> Content types.
    2. +
  2. Click the Manage fields button next to the needed element.
    3. +
  3. On the opened page, click the Create a new field button.
    4. +
  4. In the drop-down list, select ONLYOFFICE DocSpace and specify the name.
    5. +
+

If you would like to change the size of the DocSpace element on the published page:

+
    +
  1. Go to Structure -> Content types for the desired element.
    2. +
  2. Click the Manage display button.
    3. +
  3. In the previously created DocSpace field, click the gear icon and specify the desired sizes.
    4. +
  4. Once ready, click the Save button.
    5. +
+

When you are done with the preparatory steps:

+
    +
  1. Go to the Content tab.
    2. +
  2. Click the Add Content button.
    3. +
  3. Select the content type to which you have added the ONLYOFFICE DocSpace element.
    4. +
+

To add a room:

+
    +
  1. Go to the Content tab.
    2. +
  2. Click the Select room button.
    3. +
  3. Select the available room from the list and press the Select button.
    4. +
+

To add a file:

+
    +
  1. Click the Select file button.
    2. +
  2. Select the desired file from the room and press the Save button.
    3. +
+

When publishing content, all rooms and files are shared with a public user (Drupal Viewer), if an anonymous user can view the content (View published content setting).

+

Access rights to the DocSpace rooms and files on the published Drupal pages are determined depending on the availability of the DocSpace account:

+
    +
  • If user has a DocSpace account: the access rights set for the user are used. For example, if a user was invited to the room in advance with the Room admin rights, they will see the Drupal page with the published room available for editing.
    • +
  • If user does not have a DocSpace account: a Drupal Viewer account is used to access the room/file for viewing if an anonymous users can view the content.
    • +
+

Please note the following specifics for DocSpace rooms published on Drupal pages:

+
    +
  • DocSpace left menu is not avaiable;
    • +
  • Navigation is possible within the added room only;
    • +
  • If users have the Room admin or Power user role, they can create new files.
    • +
+
+ +
+ + + + \ No newline at end of file diff --git a/Web/Controls/Help/HelpCenter.ascx b/Web/Controls/Help/HelpCenter.ascx index 14d694755..21c796bb3 100644 --- a/Web/Controls/Help/HelpCenter.ascx +++ b/Web/Controls/Help/HelpCenter.ascx @@ -168,6 +168,7 @@

">Confluence

">Dropbox

">Drupal

+

">Drupal for DocSpace

">HumHub

">Jira

">Liferay

diff --git a/Web/Controls/Help/Integration/DrupalDocspace.ascx b/Web/Controls/Help/Integration/DrupalDocspace.ascx new file mode 100644 index 000000000..c6dcc8c39 --- /dev/null +++ b/Web/Controls/Help/Integration/DrupalDocspace.ascx @@ -0,0 +1,50 @@ +<%@ Control Language="C#" Inherits="BaseContentUserControls" %> +<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %> + + + +
+

Integration Guides

+ + +
\ No newline at end of file diff --git a/Web/Controls/Help/Integration/Integration.ascx b/Web/Controls/Help/Integration/Integration.ascx index 98c5e1985..05c215476 100644 --- a/Web/Controls/Help/Integration/Integration.ascx +++ b/Web/Controls/Help/Integration/Integration.ascx @@ -188,6 +188,28 @@ + +