Skip to content

Commit

Permalink
temp: remark-lint-case-police lint
Browse files Browse the repository at this point in the history
  • Loading branch information
sshakndr committed Dec 20, 2024
1 parent b2ba356 commit b096db3
Show file tree
Hide file tree
Showing 135 changed files with 203 additions and 203 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Authentication in the ONLYOFFICE DocSpace API is managed via the HTTP authentica

## Making requests

To identify the request and response format, please make sure that both the **Content-Type** and **Accept** headers are set to *application/json*. Any API method can be called specifying the json format for the response.
To identify the request and response format, please make sure that both the **Content-Type** and **Accept** headers are set to *application/json*. Any API method can be called specifying the JSON format for the response.

## Responses

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
order: -3
---

Allows you to open the SDK as a document editor for editing by specifying the [id](../../Config/index.md#id) parameter for a file.
Allows you to open the SDK as a document editor for editing by specifying the [ID](../../Config/index.md#id) parameter for a file.

![Editor mode](/assets/images/docspace/editor-mode.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
order: -2
---

Allows you to open the SDK as a document editor for viewing by specifying the [id](../../Config/index.md#id) parameter for a file.
Allows you to open the SDK as a document editor for viewing by specifying the [ID](../../Config/index.md#id) parameter for a file.

![Viewer mode](/assets/images/docspace/viewer-mode.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ order: -5
- [manager](Manager/index.md) - displays a list of entities depending on the specified *rootPath*;
- [room-selector](Room%20Selector/index.md) - opens the room selector;
- [file-selector](File%20Selector/index.md) - opens the file selector;
- [editor](Editor/index.md) - allows you to open the SDK as a document editor for editing by specifying the *id* parameter for a file;
- [viewer](Viewer/index.md) - allows you to open the SDK as a document editor for viewing by specifying the *id* parameter for a file;
- [editor](Editor/index.md) - allows you to open the SDK as a document editor for editing by specifying the *ID* parameter for a file;
- [viewer](Viewer/index.md) - allows you to open the SDK as a document editor for viewing by specifying the *ID* parameter for a file;
- [system](System/index.md) - calls the system methods.

To simplify working with modes, the SDK has methods that do not require you to specify the appropriate mode:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function onAppReady() {
```

2. Create a configuration for the **Editor** mode. Go to the [editorCustomization](../../Config/index.md#editorcustomization) section and configure the editors as needed.
After that, copy the resulting config and paste it into the [customization](../../../../../Docs/Docs%20API/Usage%20API/Config/Editor/Customization/index.md) section, as shown below. In the config, pass the id of the file that will be opened in the editors:
After that, copy the resulting config and paste it into the [customization](../../../../../Docs/Docs%20API/Usage%20API/Config/Editor/Customization/index.md) section, as shown below. In the config, pass the ID of the file that will be opened in the editors:

``` ts
const config = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Presence: required

## Access scopes

Defines the capabilities of a third-party application in relation to Docspace API. Scopes are used to limit your app's access to all user-related data, and they'll let you specify exactly what kind of access you need. This parameter is required.
Defines the capabilities of a third-party application in relation to DocSpace API. Scopes are used to limit your app's access to all user-related data, and they'll let you specify exactly what kind of access you need. This parameter is required.

| Scope | Read | Write |
| --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
order: -3
---

You can upload your own plugins to your server. For the DocSpace Saas solution, only system plugins created by our developers are available.
You can upload your own plugins to your server. For the DocSpace SaaS solution, only system plugins created by our developers are available.

## Enabling system plugins

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ A container that lays out its contents in one direction. Box provides general CS

**Interface**: IBox.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-box--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-box--docs).

![Box](/assets/images/docspace/box.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ A component that is used for an action on a page.

**Interface**: IButton.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-button--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-button--docs).

![Button](/assets/images/docspace/button.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Custom checkbox input.

**Interface**: ICheckBox.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-checkbox--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-checkbox--docs).

![Checkbox](/assets/images/docspace/checkbox.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Custom combo box input.

**Interface**: IComboBox.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-combobox--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-combobox--docs).

![Combo box](/assets/images/docspace/combobox.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Input field for single-line strings.

**Interface**: IInput.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-textinput--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-textinput--docs).

![Input](/assets/images/docspace/input.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Field name in the form.

**Interface**: ILabel.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-label--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-label--docs).

![Label](/assets/images/docspace/label.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Modal dialog.

**Interface**: IModalDialog.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-modaldialog--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-modaldialog--docs).

![Modal dialog](/assets/images/docspace/modal-dialog.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Plain text.

**Interface**: IText.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-text--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-text--docs).

![Text](/assets/images/docspace/text.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Custom textarea.

**Interface**: ITextArea.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-textarea--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-textarea--docs).

![Textarea](/assets/images/docspace/textarea.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Toast.

**Interface**: IToast.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-toast--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-toast--docs).

![Toast](/assets/images/docspace/toast.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Custom toggle button input.

**Interface**: IToggleButton.

See the parameters of this component in [storybook](https://storybook.onlyoffice.io/?path=/docs/components-togglebutton--docs).
See the parameters of this component in [Storybook](https://storybook.onlyoffice.io/?path=/docs/components-togglebutton--docs).

![Toggle button](/assets/images/docspace/toggle-button.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Example: "convert-16.png"

## onClick

Defines a function that takes the file/folder/room id as an argument. This function can be asynchronous.
Defines a function that takes the file/folder/room ID as an argument. This function can be asynchronous.

Type: func

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Example: "Test"

### submenu.onClick

A function that takes the file/folder/room id as an argument. This function can be asynchronous. It will be executed when clicking on the tab.
A function that takes the file/folder/room ID as an argument. This function can be asynchronous. It will be executed when clicking on the tab.

Type: func

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Example: "drawio.png"

## onClick

Defines a function that takes the file/folder/room id as an argument. This function can be asynchronous.
Defines a function that takes the file/folder/room ID as an argument. This function can be asynchronous.

Type: func

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Example: "logo.png"

## onClick

Defines a function that takes the file/folder/room id as an argument. This function can be asynchronous.
Defines a function that takes the file/folder/room ID as an argument. This function can be asynchronous.

Type: func

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ Create the [assets](https://github.com/ONLYOFFICE/docspace-plugins/tree/master/s
![Convert to text](/assets/images/docspace/convert-to-text.png)
This icon can be also used for the main button icon. For example, in the **draw\.io** plugin, the same icon is used for the context and main button menu.
This icon can be also used for the main button icon. For example, in the **Draw\.io** plugin, the same icon is used for the context and main button menu.
![Main button icon](/assets/images/docspace/main-button-icon.png)
The **draw\.io** plugin also uses the specific file icon near the *.drawio* files, which are created with the file plugin type. The preferred icon size for the [table format](../../Coding%20Plugin/Plugin%20Items/FileItem/index.md#filerowicon) is 32x32 px.
The **Draw\.io** plugin also uses the specific file icon near the *.drawio* files, which are created with the file plugin type. The preferred icon size for the [table format](../../Coding%20Plugin/Plugin%20Items/FileItem/index.md#filerowicon) is 32x32 px.
![File icon](/assets/images/docspace/file-icon.png)
Expand All @@ -81,9 +81,9 @@ Create the [assets](https://github.com/ONLYOFFICE/docspace-plugins/tree/master/s
If necessary, define the plugin's UI elements. Consult our [Storybook](https://api.onlyoffice.com/docspace-storybook/) to develop your plugin's UI.
For example, the **draw\.io** plugin contains two main UI elements - the modal window and the diagram editor. Create the files for configuring each element. For your convenience, you can put these files into a separate *DrawIO* folder.
For example, the **Draw\.io** plugin contains two main UI elements - the modal window and the diagram editor. Create the files for configuring each element. For your convenience, you can put these files into a separate *Draw.io* folder.
- In the [Dialog.ts](https://github.com/ONLYOFFICE/docspace-plugins/blob/master/draw.io/src/DrawIO/Dialog.ts) file, configure the modal window settings. Specify the [IFrame](../../Coding%20Plugin/Plugin%20Components/IFrame/index.md) UI component that is used to embed the draw\.io website into a modal window:
- In the [Dialog.ts](https://github.com/ONLYOFFICE/docspace-plugins/blob/master/draw.io/src/DrawIO/Dialog.ts) file, configure the modal window settings. Specify the [IFrame](../../Coding%20Plugin/Plugin%20Components/IFrame/index.md) UI component that is used to embed the Draw\.io website into a modal window:
``` ts
export const frameProps: IFrame = {
Expand Down Expand Up @@ -182,7 +182,7 @@ export const contextMenuItem: IContextMenuItem = {
<img alt="Context menu item" src="/assets/images/docspace/context-menu-item.png" width="400px">
You can add more plugin types. For example, the **draw\.io** plugin can be accessed from the main button menu, so we need to specify the [main button item](../../Coding%20Plugin/Plugin%20Items/MainButtonItem/index.md):
You can add more plugin types. For example, the **Draw\.io** plugin can be accessed from the main button menu, so we need to specify the [main button item](../../Coding%20Plugin/Plugin%20Items/MainButtonItem/index.md):
``` ts
const mainButtonItem: IMainButtonItem = {
Expand Down Expand Up @@ -221,7 +221,7 @@ When the main button item is clicked, the modal window appears where you can typ
![Create diagram](/assets/images/docspace/create-diagram.png)
For the **draw\.io** plugin, you also need to configure the file plugin type which works when the user opens the specific *.drawio* file:
For the **Draw\.io** plugin, you also need to configure the file plugin type which works when the user opens the specific *.drawio* file:
1. Define the [file item](../../Coding%20Plugin/Plugin%20Items/FileItem/index.md) that is represented as a file with the specific extension (*.drawio*) and icon:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ order: -4
For example, in our plugin samples, we use:

- [AssemblyAI](https://www.assemblyai.com/) to convert speech from audio and video files into text;
- [ConvertAPI](https://www.convertapi.com/) to convert documents, spreadsheets, presentations, and forms into *pdf*;
- [ConvertAPI](https://www.convertapi.com/) to convert documents, spreadsheets, presentations, and forms into *PDF*;
- [Draw.io](https://www.drawio.com/) to create, edit, and insert professional-looking diagrams.
> Please make sure that the service documentation is available, check its license, availability of API methods, etc. For some services, the user must obtain an API key to start using the plugin.
Expand All @@ -38,12 +38,12 @@ order: -4
- [ISettingsPlugin](../../Coding%20Plugin/Plugin%20Types/SettingsPlugin/index.md) and [ISettings](https://github.com/ONLYOFFICE/docspace-plugin-sdk/blob/master/src/interfaces/settings/ISettings.ts). Used to add settings block for plugin's configuration. The users will access this block from **Settings -> Integration -> Plugins** to adjust the plugin's parameters.
- [IContextMenuPlugin](../../Coding%20Plugin/Plugin%20Types/ContextMenuPlugin/index.md) and [IContextMenuItem](../../Coding%20Plugin/Plugin%20Items/ContextMenuItem/index.md). Used to implement a context menu action. In the **speech-to-text** plugin, it will be available for video and audio files allowing users to convert content into text.

The list of interfaces may be longer. For example, in the **draw\.io** plugin:
The list of interfaces may be longer. For example, in the **Draw\.io** plugin:

- [IMainButtonPlugin](../../Coding%20Plugin/Plugin%20Types/MainButtonPlugin/index.md) and [IMainButtonItem](../../Coding%20Plugin/Plugin%20Items/MainButtonItem/index.md). Used to implement the main button action. In the **draw\.io** plugin, we use the **Action button -> More** menu elements in the **My documents** section or in the selected room to create draw\.io diagrams.
- [IMainButtonPlugin](../../Coding%20Plugin/Plugin%20Types/MainButtonPlugin/index.md) and [IMainButtonItem](../../Coding%20Plugin/Plugin%20Items/MainButtonItem/index.md). Used to implement the main button action. In the **Draw\.io** plugin, we use the **Action button -> More** menu elements in the **My documents** section or in the selected room to create Draw\.io diagrams.
- [IFilePlugin](../../Coding%20Plugin/Plugin%20Types/FilePlugin/index.md) and [IFileItem](../../Coding%20Plugin/Plugin%20Items/FileItem/index.md). Used to interact with the specified file types. In this case, with the *.drawio* files.

3. Come up with the plugin's structure. All the required files are described [here](../../Plugin%20Structure/index.md). Everything else can be organized as you wish. For example, in the **draw\.io** plugin, we put the code for each plugin type in separate folders, while in the **speech-to-text** plugin, this code is placed in the *src* folder.
3. Come up with the plugin's structure. All the required files are described [here](../../Plugin%20Structure/index.md). Everything else can be organized as you wish. For example, in the **Draw\.io** plugin, we put the code for each plugin type in separate folders, while in the **speech-to-text** plugin, this code is placed in the *src* folder.

![Speech plugin structure](/assets/images/docspace/speech-plugin-structure.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Each DocSpace plugin is a folder with files. It must contain the following files

```

- **tsconfig** - the *typescript* configuration file. This file can be edited.
- **tsconfig** - the *TypeScript* configuration file. This file can be edited.

- **package.json** - a file with the information about the plugin and dependencies. This file can be edited and the new dependencies can be added.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ app.post("/track", (req, res) => {

> *pathForSave* is the absolute path to your computer folder where the file will be saved including the file name.
On the [NodeJS example](../../Get%20Started/Language-specific%20examples/NodeJS%20example/index.md) page, you will learn how to integrate ONLYOFFICE Docs into your web application written on Node.js.
On the [Node.js example](../../Get%20Started/Language-specific%20examples/NodeJS%20example/index.md) page, you will learn how to integrate ONLYOFFICE Docs into your web application written on Node.js.

### PHP document save example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Example: true

## fillForms

Defines if the forms can be filled. Filling in forms will only be available for the document and pdf editors if the [mode](../../Editor/index.md#mode) parameter is set to **edit**. The default value coincides with the value of the [edit](#edit) or the [review](#review) parameter.
Defines if the forms can be filled. Filling in forms will only be available for the document and PDF editors if the [mode](../../Editor/index.md#mode) parameter is set to **edit**. The default value coincides with the value of the [edit](#edit) or the [review](#review) parameter.

Type: boolean

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Example: "docx"

## key

Defines the unique document identifier used by the service to recognize the document. In case the known key is sent, the document will be taken from the cache. Every time the document is edited and saved, the key must be generated anew. The document url can be used as the **key** but without the special characters and the length is limited to 128 symbols.
Defines the unique document identifier used by the service to recognize the document. In case the known key is sent, the document will be taken from the cache. Every time the document is edited and saved, the key must be generated anew. The document URL can be used as the **key** but without the special characters and the length is limited to 128 symbols.

Please note that the key must be unique for all independent services connected to the same document server. Otherwise, the service may open someone else's file from the editor cache. If multiple third-party integrators are connected to the same document server, they must also provide a unique key.

Expand Down
Loading

0 comments on commit b096db3

Please sign in to comment.