Manifest

The config.json file is plugin configuration file containing the information about the main plugin data needed to register the plugin in the editors.

baseUrl
group
- group.name
- group.rank
guid
help
minVersion
name
nameLocale
offered
variations
version
Example

baseUrl

Path to the plugin. All other paths are calculated relative to this path. If baseUrl == "", the path to the plugin in the default sdkjs-plugins folder will be used.

Type: string

Example: ""

Plugin group that is separated from other plugins in the Plugins tab. The first group usually includes the Plugin Manager and Background plugins, if they exist. Other plugins are placed after them in the second group. You can add as many groups as you need. If this parameter is omitted, the plugin will be added to the last group.

Type: object

Example:

{
  "name": "group name",
  "rank": 2
}

group.name

The group name.

Type: string

Example: "group name"

group.rank

The group rank in the Plugins tab, an integer starting from 1.

Type: number

Example: 2

Plugin groups

guid

Plugin identifier. It must be of the asc.{UUID} type.

Type: string

Example: "asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}"

help

Path to the plugin help page. If the parameter is specified, the help button is displayed in the plugin window. When the user clicks the button, he follows the link to the plugin help page.

Type: string

Example: "url_to_help_page"

Plugin help

minVersion

The minimum editor version which supports the current plugin.

Type: string

Example: "6.3.0"

name

Plugin name which will be visible at the plugin toolbar.

Type: string

Example: "plugin name"

nameLocale

Translations for the name field. The object keys are the two letter language codes (ru, de, it, etc.) and the values are the plugin name translation for each language.

Type: localeTranslate

Example: { "fr": "french plugin name" }

offered

Plugin author who proposed the plugin for publication.

Type: string

Example: "John Smith"

variations

Plugin variations, or subplugins, that are created inside the origin plugin. More information you can find here.

Type: array of objects

Example:

[
  {
    "buttons": [
      { 
        "text": "Cancel",
        "primary": false,
        "isviewer": false,
        "textLocale": {
          "fr": "Annuler",
          "es": "Cancelar"
        }
      }
    ],
    "cryptoDisabledForExternalCloud": "true",
    "cryptoDisabledForInternalCloud": "true",
    "cryptoDisabledOnStart": "true",
    "cryptoMode": "1",
    "description": "plugin description",
    "descriptionLocale": {
      "fr": "french plugin description",
      "es": "spanish plugin description"
    },
    "EditorsSupport": ["word", "cell", "slide", "pdf"],
    "events": ["onClick"],
    "icons": "url_to_icon",
    "initData": "",
    "initDataType": "ole",
    "initOnSelectionChanged": true,
    "isCustomWindow": true,
    "isDisplayedInViewer": true,
    "isUpdateOleOnResize": true,
    "isViewer": true,
    "size": [600, 700],
    "store": {
      "background": {
        "light": "#F5F5F5",
        "dark": "#444444"
      },
      "categories": ["specAbilities", "work"],
      "icons": {
        "light": "resources/store/icons",
        "dark": "resources/store/icons"
      },
      "screenshots": ["resources/store/screenshots/screen_1.png"]
    },
    "type": "background",
    "url": "index.html"
  }
]

variations.buttons

The list of skinnable plugin buttons used in the plugin interface. This parameter is used only for plugin windows and panels, i.e. when the type parameter is window, panel, or panelRight.

Type: array of Button

Example:

[
  {
    "text": "Cancel",
    "primary": false,
    "isviewer": false,
    "textLocale": {
      "fr": "Annuler",
      "es": "Cancelar"
    }
  }
]

Plugin buttons

variations.cryptoDisabledForExternalCloud

Specifies whether the encryption for the third-party clouds is disabled.

Type: string

Example: "true"

variations.cryptoDisabledForInternalCloud

Specifies whether the encryption for the local files is disabled.

Type: string

Example: "true"

variations.cryptoDisabledOnStart

Specifies whether the encryption is disabled upon startup.

Type: string

Example: "true"

Encryption disabled

variations.cryptoMode

The encryption mode. The available values:

0 - none (encryption is disabled);
1 - simple;
2 - advanced.

Type: string

Example: "1"

variations.description

The description, i.e. what describes your plugin the best way. It will be displayed in the ONLYOFFICE Plugin Marketplace.

Type: string

Example: "plugin description"

Plugin description

variations.descriptionLocale

Translations for the description field. The object keys are the two letter language codes (fr, de, it, etc.) and the values are the plugin description translation for each language.

Type: localeTranslate

Example: { "fr": "french plugin description" }

variations.EditorsSupport

The editors which the plugin is available for (word, cell, slide, or pdf).

Type: array of editorType

Example: ["word"]

variations.events

Plugin events which are used in the current plugin code. Find out how to subscribe to events here.

Type: array of EventType

Example: ["onClick"]

variations.icons

URL to the plugin icon image file. This URL allows setting your own rules for theme (name, type), styles (normal, hover, active), and scaling. More information can be found here.

Type: string

Example: "url_to_icon"

variations.icons2

Deprecated. Scalable icons for plugin extensions. More information can be found here.

Type: array of objects

Example: [ { "100%": { "normal": "icon.png" } } ]

variations.initData

The data which is sent from the editor to the plugin at the plugin start. This parameter is usually equal to "". If initDataType == "text", the plugin will receive the selected text upon launch. It may also be equal to encryption in the encryption plugins.

Type: string

Example: "text"

Init data

Example:

{
  "background": {
    "light": "#F5F5F5",
    "dark": "#444444"
  },
  "categories": ["specAbilities", "work"],
  "icons": {
    "light": "resources/store/icons",
    "dark": "resources/store/icons"
  },
  "screenshots": ["resources/store/screenshots/screen_1.png"]
}

variations.store.background

Background colors used for plugin icons in ONLYOFFICE Plugin Marketplace.

Type: object

Example:

{
  "light": "#F5F5F5",
  "dark": "#444444"
}

variations.store.background.light

The background color used for the light theme plugin icon.

Type: string

Example: "#F5F5F5"

Light icon

variations.store.background.dark

The background color used for the dark theme plugin icon.

Type: string

Example: "#444444"

Dark icon

variations.store.categories

Plugin categories in ONLYOFFICE Plugin Marketplace:

"all" - All,
"recommended" - Recommended,
"devTools" - Developer tools,
"work" - Work,
"entertainment" - Entertainment,
"communication" - Communication,
"specAbilities" - Special abilities.

Type: array of strings

Example: ["specAbilities", "work"]

Plugin categories

variations.store.icons

Paths to the plugin icon image files used in the ONLYOFFICE Plugin Marketplace.

Type: object

Example:

{
  "light": "resources/store/icons",
  "dark": "resources/store/icons"
}

variations.store.icons.light

The path to the scalable plugin icons for the light theme. Name the icon files of different scales in the following way:

100% - icon.png
125% - icon@1.25.png
150% - icon@1.5x.png
175% - icon@1.75.png
200% - icon@2x.png

Type: string

Example: "resources/store/icons"

variations.store.icons.dark

The path to the scalable plugin icons for the dark theme. Name the icon files of different scales in the following way:

100% - icon.png
125% - icon@1.25.png
150% - icon@1.5x.png
175% - icon@1.75.png
200% - icon@2x.png

Type: string

Example: "resources/store/icons"

variations.store.screenshots

Images that are used for the plugin description in the ONLYOFFICE Plugin Marketplace.

Type: array of strings

Example: ["resources/store/screenshots/screen_1.png"]

Plugin screenshots

variations.type

Plugin type. The following values are available:

"system". The system plugin is not displayed in the editor interface and is started in the background with the server (or desktop editors start) not interfering with other plugins, so that they can work simultaneously. Such a plugin cannot be disabled in the editor window.
"background". The background plugin runs continuously once started. Its state (enabled / disabled) persists between sessions. To access background plugins, click the Background Plugins button on the top toolbar.
"window". A plugin that operates as a standalone window upon launch.
"panel". A plugin that opens in the left-side panel.
"panelRight". A plugin that opens in the right-side panel.
"unvisible". A plugin that is invisible upon launch.

Please note that a plugin of any type can create windows and tabs during its work.

Type: string

Example: "background"

variations.url

Plugin entry point, i.e. an HTML file which connects the plugin.js file (the base file needed for work with plugins) and launches the plugin code. See the index.html section for the detailed information.

Type: string

Example: "index.html"

version

The plugin version.

Type: string

Example: "1.0"

Example

{
  "baseUrl": "",
  "group": {
    "name": "group name",
    "rank": 2
  },
  "guid": "asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
  "help": "url_to_help_page",
  "minVersion": "6.3.0",
  "name": "plugin name",
  "nameLocale": {
    "fr": "french plugin name",
    "es": "spanish plugin name"
  },
  "offered": "John Smith",
  "variations": [
    {
      "buttons": [
        { 
          "text": "Cancel",
          "primary": false,
          "isviewer": false,
          "textLocale": {
            "fr": "Annuler",
            "es": "Cancelar"
          }
        }
      ],
      "cryptoDisabledForExternalCloud": "true",
      "cryptoDisabledForInternalCloud": "true",
      "cryptoDisabledOnStart": "true",
      "cryptoMode": "1",
      "description": "plugin description",
      "descriptionLocale": {
        "fr": "french plugin description",
        "es": "spanish plugin description"
      },
      "EditorsSupport": ["word", "cell", "slide", "pdf"],
      "events": ["onClick"],
      "icons": "url_to_icon",
      "initData": "",
      "initDataType": "ole",
      "initOnSelectionChanged": true,
      "isCustomWindow": true,
      "isDisplayedInViewer": true,
      "isUpdateOleOnResize": true,
      "isViewer": true,
      "size": [600, 700],
      "store": {
        "background": {
          "light": "#F5F5F5",
          "dark": "#444444"
        },
        "categories": ["specAbilities", "work"],
        "icons": {
          "light": "resources/store/icons",
          "dark": "resources/store/icons"
        },
        "screenshots": ["resources/store/screenshots/screen_1.png"]
      },
      "type": "background",
      "url": "index.html"
    }
  ],
  "version": "1.0"
}

Get Help

If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).

Manifest

Results

Get Help