diff --git a/Web/Controls/Help/ArticlesCompleteList/Desktop/100024_get_started/100024_get_started.ascx b/Web/Controls/Help/ArticlesCompleteList/Desktop/100024_get_started/100024_get_started.ascx index 72db2c80b..4636b3fdd 100644 --- a/Web/Controls/Help/ArticlesCompleteList/Desktop/100024_get_started/100024_get_started.ascx +++ b/Web/Controls/Help/ArticlesCompleteList/Desktop/100024_get_started/100024_get_started.ascx @@ -1,3 +1,3 @@ <%@ Control Language="C#" %> ">Getting started with  ONLYOFFICE Desktop Editors \ No newline at end of file + href="<%=VirtualPathUtility.ToAbsolute("~/installation/desktop-getting-started.aspx")%>">Getting started with ONLYOFFICE Desktop Editors \ No newline at end of file diff --git a/Web/Controls/Help/ArticlesCompleteList/ServerWindows/50031_add_plugins/50031_add_plugins.ascx b/Web/Controls/Help/ArticlesCompleteList/ServerWindows/50031_add_plugins/50031_add_plugins.ascx new file mode 100644 index 000000000..964c3c3b7 --- /dev/null +++ b/Web/Controls/Help/ArticlesCompleteList/ServerWindows/50031_add_plugins/50031_add_plugins.ascx @@ -0,0 +1,3 @@ +<%@ Control Language="C#" %> +">Adding new plugins to server editors \ No newline at end of file diff --git a/Web/Controls/Help/Desktop/Documents/Common/GettingStarted/GettingStarted.ascx b/Web/Controls/Help/Desktop/Documents/Common/GettingStarted/GettingStarted.ascx index c7ab19588..cf796d36e 100644 --- a/Web/Controls/Help/Desktop/Documents/Common/GettingStarted/GettingStarted.ascx +++ b/Web/Controls/Help/Desktop/Documents/Common/GettingStarted/GettingStarted.ascx @@ -144,23 +144,50 @@

Adding plugins to the ONLYOFFICE Desktop Editors

+

Plugins are designed to expand the capabilities and add new features to Desktop Editors.

ONLYOFFICE Desktop Editors include a number of the pre-installed plugins.

+ +

To extend the editors functionality, you can add your own plugins. It only takes a few minutes and can easily be done by following the instuctions below:

+
    +
  1. Go to App Directory page, where all compatible and ready-to-install plugins are located.
  2. +
  3. Select the suitable plugin from the list and make sure that it is compatible with the Desktop Editors.
  4. +
  5. Click the Install now button, or you can also manually find the repository of the latest available corresponding plugin on ONLYOFFICE Github page. +

    Here are some examples:

    +
      +
    • Telegram - chat with co-authors in real time using integrated Telegram client;
    • +
    • Words counter - count words, characters, and paragraphs in the selected part of your document;
    • +
    • Thesaurus - search for synonyms and antonyms of a word and replace it with the selected one.
    • +
    +

    All the currently existing open source plugin examples are available here.

    +
  6. +
  7. Download the repository files and, if you downloaded them in .zip format, unzip them.
  8. +
  9. Archive all the plugin files to .zip format and change the archive extension to .plugin. +
    + the archive must contain config.json, index.html and pluginCode.js files. +
    +
  10. +
  11. Open the ONLYOFFICE Editors app, switch to the Plugins tab of the top toolbar and click the Settings button. The Settings window will open. +
    + Plugins tab" /> + Plugins tab" /> +
    +
    +
  12. +
  13. Click the Add plugin button and specify the path to the plugin.
  14. +
+

The plugin will be added to the opened editors and all the editors you will open afterwords and displayed within the Plugins tab.

- Plugins tab" /> - Plugins tab" /> -
-
-

To extend the editors functionality, you can add your own plugins.

-

All the currently existing open source plugin examples are available here.

-

The plugin structure and the procedure of creating plugins is described in the Plugins and macros section of the https://api.onlyoffice.com web site.

-

To find out how to add your own plugin to the ONLYOFFICE Desktop Editors, refer to this page: Installing plugins to document editors.

+ Plugins tab" /> + Plugins tab" /> +
+
+

To remove the added plugin, click the remove plugin icon" /> icon.

To find out how to remove default plugins from the ONLYOFFICE Desktop Editors, refer to this page: ">Uninstall default plugins from the desktop editors.

-
+

The plugin structure and the procedure of creating plugins is described in the Plugins and macros section of the https://api.onlyoffice.com web site.

@@ -179,9 +206,9 @@

Make the necessary changes and click the Apply button.

- Application settings" /> - Application settings" /> -
+ Application settings" /> + Application settings" /> +
Security settings

To protect your documents, spreadsheets, or presentations, you can set a password, or sign a file using a digital signature. To learn more, you can refer to these instructions:

@@ -198,5 +225,5 @@
- + \ No newline at end of file diff --git a/Web/Controls/Help/Desktop/Documents/Common/UninstallPlugin/UninstallPlugin.ascx b/Web/Controls/Help/Desktop/Documents/Common/UninstallPlugin/UninstallPlugin.ascx index 411b2fb91..95375201c 100644 --- a/Web/Controls/Help/Desktop/Documents/Common/UninstallPlugin/UninstallPlugin.ascx +++ b/Web/Controls/Help/Desktop/Documents/Common/UninstallPlugin/UninstallPlugin.ascx @@ -94,7 +94,10 @@ {B509123E-6335-40BD-B965-91EB799346E3} - + +

+

To find out how to add your own plugins, refer to this article: ">Adding plugins to the ONLYOFFICE Desktop Editors.

+

diff --git a/Web/Controls/Help/Installation/Docs.ascx b/Web/Controls/Help/Installation/Docs.ascx index 37e2e66fc..a5781b3f9 100644 --- a/Web/Controls/Help/Installation/Docs.ascx +++ b/Web/Controls/Help/Installation/Docs.ascx @@ -46,6 +46,7 @@
  • <%--
  • --%>
  • +
  • System requirements
    diff --git a/Web/Controls/Help/Installation/DocsCommunity.ascx b/Web/Controls/Help/Installation/DocsCommunity.ascx index bd6a375f7..b3edc8b78 100644 --- a/Web/Controls/Help/Installation/DocsCommunity.ascx +++ b/Web/Controls/Help/Installation/DocsCommunity.ascx @@ -46,6 +46,7 @@
  • <%--
  • --%>
  • +
  • System requirements
    diff --git a/Web/Controls/Help/Server/Document/AddPlugins/AddPlugins.ascx b/Web/Controls/Help/Server/Document/AddPlugins/AddPlugins.ascx new file mode 100644 index 000000000..f0fb20781 --- /dev/null +++ b/Web/Controls/Help/Server/Document/AddPlugins/AddPlugins.ascx @@ -0,0 +1,63 @@ +<%@ Control Language="C#" Inherits="BaseContentUserControls"%> +<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %> + + + +
    +

    Adding new plugins to server editors

    + +
    +
      +
    • +
    • +
    • +
    +
    +
    +
    +
    +

    Extend the functionality and add new features to ONLYOFFICE Docs by adding new plugins.

    +
    + this guide is only for Self-hosted server versions of ONLYOFFICE Docs. To learn how to add plugins to the Cloud service, please, refer to this page. +
    +

    It only takes a few minutes and can easily be done by following the instuctions below:

    +
      +
    1. Go to App Directory page, where all compatible and ready-to-install plugins are located.
    2. +
    3. Select the suitable plugin from the list and make sure that it is compatible with the ONLYOFFICE Docs.
    4. +
    5. Click the Install now button, or you can also manually find the repository of the latest available corresponding plugin on ONLYOFFICE Github page. +

      Here are some examples:

      +
        +
      • Telegram - chat with co-authors in real time using integrated Telegram client;
      • +
      • Words counter - count words, characters, and paragraphs in the selected part of your document;
      • +
      • Thesaurus - search for synonyms and antonyms of a word and replace it with the selected one.
      • +
      +

      All the currently existing open source plugin examples are available here.

      +
    6. +
    7. Copy the URL-address of the plugin and download it using termimal: +
      git clone https://github.com/ONLYOFFICE/plugin-name 
      +

      Where plugin-name is the URL-address of the plugin (e.g. https://github.com/ONLYOFFICE/plugin-wordscounter to download Words counter plugin).

      +
    8. +
    9. Put the folder with the plugin code to the sdkjs-plugins folder, which is located in the ONLYOFFICE Docs directory. +

      For Linux:

      +
      mv plugin-folder /var/www/onlyoffice/documentserver/sdkjs-plugins/
      +

      For Windows:

      +
      move plugin-folder %ProgramFiles%\ONLYOFFICE\DocumentServer\sdkjs-plugins\
      +

      Where plugin-folder is an absolute path plugin directory.

      +
    10. +
    11. The plugins will be available to all the users of ONLYOFFICE Docs. In some cases service restart is required: +
      supervisorctl restart all
      +
    12. +
    +

    You can also add new plugins through the config.json file. To find out how to do this, visit our for developers page.

    +

    If you want to remove the added or a default plugin, refer to ">Uninstall default plugins from the server editors guide.

    +
    +
    +
    +
    \ No newline at end of file diff --git a/Web/Controls/Help/Server/Document/UninstallPlugins/UninstallPlugins.ascx b/Web/Controls/Help/Server/Document/UninstallPlugins/UninstallPlugins.ascx index 7314be1d6..dfb3acd2c 100644 --- a/Web/Controls/Help/Server/Document/UninstallPlugins/UninstallPlugins.ascx +++ b/Web/Controls/Help/Server/Document/UninstallPlugins/UninstallPlugins.ascx @@ -115,6 +115,7 @@ --%> +

    You can also add new plugins to ONLYOFFICE Docs. To find out information on how to do this, please, refer to ">Adding new plugins to server editors guide.

    diff --git a/Web/Controls/Help/Tags/document-server/document-server.ascx b/Web/Controls/Help/Tags/document-server/document-server.ascx index 9b1f4a272..568740a9d 100644 --- a/Web/Controls/Help/Tags/document-server/document-server.ascx +++ b/Web/Controls/Help/Tags/document-server/document-server.ascx @@ -16,6 +16,7 @@ \ No newline at end of file diff --git a/Web/images/Help/GettingStarted/Desktop/big/added_plugin.png b/Web/images/Help/GettingStarted/Desktop/big/added_plugin.png new file mode 100644 index 000000000..ac651f080 Binary files /dev/null and b/Web/images/Help/GettingStarted/Desktop/big/added_plugin.png differ diff --git a/Web/images/Help/GettingStarted/Desktop/small/added_plugin.png b/Web/images/Help/GettingStarted/Desktop/small/added_plugin.png new file mode 100644 index 000000000..ed4b1ec8c Binary files /dev/null and b/Web/images/Help/GettingStarted/Desktop/small/added_plugin.png differ diff --git a/Web/images/Help/GettingStarted/removeplugin.png b/Web/images/Help/GettingStarted/removeplugin.png new file mode 100644 index 000000000..31e8f9e62 Binary files /dev/null and b/Web/images/Help/GettingStarted/removeplugin.png differ diff --git a/Web/installation/desktop-uninstall-plugin.aspx b/Web/installation/desktop-uninstall-plugin.aspx index a1d309971..830cd02b6 100644 --- a/Web/installation/desktop-uninstall-plugin.aspx +++ b/Web/installation/desktop-uninstall-plugin.aspx @@ -16,5 +16,8 @@ +
    + +
    \ No newline at end of file diff --git a/Web/installation/docs-add-plugin.aspx b/Web/installation/docs-add-plugin.aspx new file mode 100644 index 000000000..1d3b54148 --- /dev/null +++ b/Web/installation/docs-add-plugin.aspx @@ -0,0 +1,22 @@ +<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationArticles.master" %> +<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %> + + + + + + + + + + +
    + + \ No newline at end of file diff --git a/Web/installation/docs-uninstall-plugin.aspx b/Web/installation/docs-uninstall-plugin.aspx index 642c36420..39881219a 100644 --- a/Web/installation/docs-uninstall-plugin.aspx +++ b/Web/installation/docs-uninstall-plugin.aspx @@ -13,7 +13,7 @@