1. Project Overview & Quickstart (ONLYOFFICE/sdkjs-plugins)
File: README.md
Overview
In this folder, you will find the simplest plugins to be used as an examples while creating your own ones.
List of available examples
Inserting content
- helloworld shows how to insert text into the document.
- templates - shows how to insert content generated using DocBuilder script into your doc.
- example_autocomplete - an example of an input assistant/non-standard keyboard. It has its own window that appears and disappears when you type the text. Its location is tied to the cursor.
Search and replace
- example_search_replace - an example of search & replace feature with settings.
- searchAndReplaceOnStart shows how to automatically replace content when you start the editor. In this case, text “ONLYOFFICE” will be replaced with the text "ONLYOFFICE is cool".
Work with comments
- example_extended_comments shows how to add, edit, remove comments and replies (with user data) to your doc using plugins.
- example_add_comment_in_cell shows how to add comment to the active cell of your spreadsheet.
Work with content controls
- example_work_with_content_controls shows how to add, edit, and delete content controls using plugins.
- example_work_with_content_controls_content shows how to get the list of content controls, selects content with id determined in the plugin and creates a variable with the selected content which later can be inserted anywhere you want.
- example_work_with_content_controls_navigation shows how to get the list of content controls, selects content, move cursor to the beginning of the specific content control.
Third-party services integration
- chrome_extension_example shows how to turn your plugin into a Chrome extension to add its functionality to the cloud version of ONLYOFFICE.
- externallistener shows how to manipulate the editor from an external panel of a 3rd party service.
Other
- settings shows how to protect a document using a watermark.
Documentation
ONLYOFFICE API - https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
User feedback and support
If you have any problems or question about ONLYOFFICE plugins, use the issues section here, in this repository.
File: chrome_extension_example/README.md
Overview
This plugin shows how to turn your plugin into a Chrome extension to add its functionality to the cloud version of ONLYOFFICE.
It isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
For example:
- Add folder chess
- Wrap folder to extension
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: clippy/README.md
Overview
This plugin shows how to add clippy assintant in document editor.
The plugin uses the [clippy.js] is a full Javascript implementation of Microsoft Agent (AKA Clippy and friends), ready to be embedded in any website. (https://www.smore.com/clippy-js).
It is called Clippy in the interface and isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
- Find the plugin in the Plugins tab.
- Select any assistant.
- Click on assistan to start random animation.
File: context_menu_example/README.md
Overview
This simple plugin is designed to show the basic functionality of ONLYOFFICE Document Editor plugins. It shows how to add items into a context menu throught plugin.
It is without interface plugin and isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
- Open the Plugins tab and press "Context menu example".
- Select a some content or just press the right mouse button into the document to open a context menu options.
- Choose one of added context menu items and se what will happen into the document.
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: converterToOform/README.md
Overview
The goal of this plugin is to help with convertation regular documents to oforms
How to use
- Find the plugin in the Plugins tab.
- Open settings page and set up the start and end tokens. All content between such tokens will be convertet to text form.
- Select any text into a document and click Convert button. You may click Convert button without selection, in that case the entire document will be converted
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: example_add_buttons_content_controls/README.md
Overview
This plugin shows how to add, content controls using plugins.
It is called "Add buttons to content controls" in the interface and isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: example_add_content_controls/README.md
Overview
This plugin shows how to add, content controls using plugins.
It is called "Example add content controls" in the interface and isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
- Open the Plugins tab and press "Example add content controls".
- In each field you can edit settings of content controls. After that press the "Insert".
- In the first field - plain text or rich text, in the second field - check box, in the third field - picture, in the fourth field - combo box or drop-down list, in the fifth field - date.
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: example_add_rich_text_content_control/README.md
Overview
This simple plugin is designed to show the basic functionality of ONLYOFFICE Document Editor plugins. It inserts the 'Rich text content control' when you press the button.
It is without interface plugin and isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
- Open the Plugins tab and press "Add rich text CC".
- Select the content wich you want to add into content control.
- Press "Add rich text CC".
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: example_autocomplete/README.md
Overview
This plugin is an example of an input assistant/non-standard keyboard. It has its own window that appears and disappears when you type the text. Its location is tied to the cursor.
It isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
- Start typing any word. If plugin find some words in dictionary, then you will see input helper window with found words.
- Select an option and press the "Enter" button to complete the word.
This is system plugin (in config has flag "isSystem": true,) and you don't need stat it. It starts automatically.
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
File: example_custom_fields_add_2/README.md
Overview
Insert into document custom fields.
It is called "Example add custom fields 2" in the interface and isn't installed by default in cloud, self-hosted and desktop version of ONLYOFFICE editors.
How to use
- Open the Plugins tab and press "Example add custom fields 2".
- Add textQ or listQ in the corresponding tabs (type necessary text, check necessary options and press the "Save" button).
- If you nee you can copy necessary field in the corresponding tab.
- You can insert option into document in "Insert Option" tab (choose an option and press the "Insert" button).
If you need more information about how to use or write your own plugin, please see this https://api.onlyoffice.com/docs/plugin-and-macros/get-started/
2. Official Technical Reference & Guides (ONLYOFFICE/ONLYOFFICE.github.io)
Overview
Welcome to the onlyoffice.github.io repository! This repository contains the necessary files and resources to set up and manage plugins for ONLYOFFICE.
Repository Structure
- sdkjs-plugins: This directory contains the stylesheets and CSS files used for plugin customization and styling. Also it contains the code and resourses of all plugins in store.
- store: This directory contains the code and resources for the Plugins Manager. It includes the necessary scripts and configurations to manage plugins within ONLYOFFICE.
Contributing
If you would like to contribute to the ONLYOFFICE Plugin Marketplace, we welcome your contributions. To contribute, please follow these guidelines. We appreciate your contributions and will review them as soon as possible.
License
onlyoffice.github.io is licensed under the GNU Affero General Public License v3.0. See LICENSE.txt for more information.
User Feedback and Support
If you have any problems with or questions about ONLYOFFICE Plugins and Plugin Marketplace, please visit our official forum to find answers to your questions: forum.onlyoffice.com or you can ask and answer ONLYOFFICE development questions on Stack Overflow.
If you encounter any issues or have any questions regarding the ONLYOFFICE Plugins and Plugin Marketplace, please open an issue in the repository. We'll be glad to assist you.
Acknowledgments
We would like to thank all the contributors and developers who have worked on the ONLYOFFICE Plugin Marketplace.