Skip to content

Commit

Permalink
remark-lint-no-unicode lint fix
Browse files Browse the repository at this point in the history
Co-authored-by: ivan.uhalin@onlyoffice.com
  • Loading branch information
sshakndr authored and vanyauhalin committed Dec 6, 2024
1 parent fdc7c9c commit 853fad2
Show file tree
Hide file tree
Showing 31 changed files with 66 additions and 66 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This documentation describes:
Here are some examples of what you can do with ONLYOFFICE DocSpace plugins:

- connect third-party services, like [Draw.io](https://github.com/ONLYOFFICE/docspace-plugins/tree/master/draw-io), [Speech to Text Conversion](https://github.com/ONLYOFFICE/docspace-plugins/tree/master/speech-to-text), etc.;
- enhance the existing user experience and the editors functionality: [PDF-converter](https://github.com/ONLYOFFICE/docspace-plugins/tree/master/pdf-converter).
- enhance the existing user experience and the editors functionality: [PDF-converter](https://github.com/ONLYOFFICE/docspace-plugins/tree/master/pdf-converter).

Code samples are available at <https://github.com/ONLYOFFICE/docspace-plugins>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To build the **Encryption** plugin, you need to create three files:

More information about the plugin structure can be found [here](../../../../Plugin%20and%20Macros/Structure/Manifest/index.md).

Lets have a look at the config:
Let's have a look at the config:

``` json
{
Expand Down Expand Up @@ -84,9 +84,9 @@ As we can see from the code above, all files will be encrypted with one password
## Step 2. Creating the UI plugin for the app

The **Encryption** plugin has no interface and cant run by default. It works only within a document where it is opened (in one tab of the app). To work with all the documents opened or created in different tabs of the ONLYOFFICE desktop, the **UI** plugin for the app should be created. It helps to use the **Encryption** plugin when necessary for the whole app.
The **Encryption** plugin has no interface and can't run by default. It works only within a document where it is opened (in one tab of the app). To work with all the documents opened or created in different tabs of the ONLYOFFICE desktop, the **UI** plugin for the app should be created. It helps to use the **Encryption** plugin when necessary for the whole app.

This plugin cant access the editing features but has almost the same config:
This plugin can't access the editing features but has almost the same config:

``` json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ There are three ways for the desktop app to be recognized:

## How to open new windows in the desktop editors?

You cant open new windows in the desktop editors because it is blocked (for example, for *OAuth*).
You can't open new windows in the desktop editors because it is blocked (for example, for *OAuth*).

To open the document in a new window / tab correctly, you need to use the `window.open("http://url.to.document")` JavaScript command or the *open:document* command of the **execCommand** method. The details on how to open documents in the desktop editors can be found [in this section](../../Usage%20API/Adding%20a%20DMS%20provider/Opening%20documents/index.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Once your DMS is [added](../index.md) to the connection list, configure the DMS/
- change the interface [theme](../Changing%20a%20theme/index.md),
- enable end-to-end [encryption](../Encryption/index.md).

Before proceeding further, its highly recommended to adjust the DMS elements to be displayed when the document is opened in the desktop application.
Before proceeding further, it's highly recommended to adjust the DMS elements to be displayed when the document is opened in the desktop application.

Exclude the functionality which is not related to the document manager. Hide such sections like navigation, site header and footer, etc. Remove links to the third-party resources. Other pages will open in the default browser without interacting with the desktop editors.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ If you need to uninstall the default plugins, go to the *sdkjs-plugins* folder a
The table below contains default plugins guids to make it easier for you to find them:

## Default plugins guids
## Default plugins guid's

| | |
| -------------- | -------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ The reference figure and the steps below explain the process of setting a name t

1. Create an *html* file to [Open the document](../Opening%20file/index.md#how-this-can-be-done-in-practice).

2. If the anonymous users name is specified, it is displayed on the top toolbar.
2. If the anonymous user's name is specified, it is displayed on the top toolbar.

3. If the user name is not specified, it will be requested. The request can be turned off with the *"request"=false* value of the [editorConfig.customization.anonymous](../../../Usage%20API/Config/Editor/Customization/index.md#anonymous) parameter.

![Name request](/assets/images/editor/name-request.png)

4. After the anonymous users name is set, the postfix is added to it via the *label* field of the *editorConfig.customization.anonymous* parameter to distinguish guests during the coediting session. By default this postfix is *"Guest"*.
4. After the anonymous user's name is set, the postfix is added to it via the *label* field of the *editorConfig.customization.anonymous* parameter to distinguish guests during the coediting session. By default this postfix is *"Guest"*.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ In order to open a document for editing, the config initialization requires the
Therefore, it is important that users have the same key to open the document for co-editing. The **document editing service** identifies the key of another user (or another tab/editing session for [inline editors](../Inline%20editors/index.md)) who is trying to open the document, and if that key matches the key of the file, the user is allowed to open it. If the key is different, then a new file, which is not related to other files and file versions, is opened.

Once the request for saving the file is sent (the *status* value is equal to *2*) and the operation completion is successful (the response value is equal *{"error":0}*), this key cant be used to open the document for editing. The editor is loaded with an [error message](../../../More%20Information/Troubleshooting/index.md#key). However, it can be used for viewing the document from the cache if it exists.
Once the request for saving the file is sent (the *status* value is equal to *2*) and the operation completion is successful (the response value is equal *{"error":0}*), this key can't be used to open the document for editing. The editor is loaded with an [error message](../../../More%20Information/Troubleshooting/index.md#key). However, it can be used for viewing the document from the cache if it exists.

If the user saves the document before the editing is finished (the *status* value is equal to *6*), the key cant be changed. Otherwise, the co-editing stops. Please note that after the force saving procedure the key also cant be changed for the new users who are just entering the current editing session.
If the user saves the document before the editing is finished (the *status* value is equal to *6*), the key can't be changed. Otherwise, the co-editing stops. Please note that after the force saving procedure the key also can't be changed for the new users who are just entering the current editing session.

### Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ To start using ONLYOFFICE Docs with SharePoint, the following steps must be perf
9. Go back to **Web Application Management** and click the **Anonymous Policy** icon.
10. Under **Anonymous Access Restrictions**, select your **Zone**, set the **Permissions** to *None No policy* and click **Save**.
10. Under **Anonymous Access Restrictions**, select your **Zone**, set the **Permissions** to *None - No policy* and click **Save**.
## Configuring SharePoint ONLYOFFICE integration solution
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The token can be sent both in the request [header](../../../Additional%20API/Sig

## What's the difference between sending the token in header and in body?

Starting with version 5.2 of ONLYOFFICE Docs it is possible to send token both in the request header and body. The main difference between these two methods is in the length limitation: a HTTP header has length limitation and some servers (such as some NGINX versions) do not accept the requests with the header longer than 4 kilobytes, while other servers restrict the header length to 848 kilobytes. In case the header length exceeds these values, the server will return the *413 Entity Too Large* error.
Starting with version 5.2 of ONLYOFFICE Docs it is possible to send token both in the request header and body. The main difference between these two methods is in the length limitation: a HTTP header has length limitation and some servers (such as some NGINX versions) do not accept the requests with the header longer than 4 kilobytes, while other servers restrict the header length to 8-48 kilobytes. In case the header length exceeds these values, the server will return the *413 Entity Too Large* error.

To avoid this limitation, sending the token in the request body should be the preferred method of doing this. Starting from version 7.1, the incoming requests use the token in body if it exists. Otherwise, the header token is taken. The outgoing requests use both the token in body and token in header. They can be different. For example, the information about version history can be removed from the header token because of the size limit of the token in header.

Expand Down
10 changes: 5 additions & 5 deletions site/pages/Docs/Docs API/Usage API/Automation API/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The connector has the same interface as plugins. Below you can find methods that
- [attachEvent](#attachevent) - add an event listener.
- [callCommand](#callcommand) - send the data back to the editor.
- [connect](#connect) - connect the connector to the editor.
- [createWindow](#createwindow) - create the connector modal window to display the additional information inside the editor.
- [createWindow](#createwindow) - create the connector modal window to display the additional information inside the editor.
- [detachEvent](#detachevent) - remove an event listener.
- [disconnect](#disconnect) - disconnect the connector from the editor.
- [executeMethod](#executemethod) - execute certain editor methods using the connector.
Expand All @@ -45,7 +45,7 @@ Parameters:
| *text* | string | The item caption. |
| *data* | string | The item data (this data will be sent to the click event callback). |
| *disabled* | boolean | Specifies if the current item is disabled or not. |
| *icons* | string | The item icons (see the plugins [config](../../../Plugin%20and%20Macros/Structure/Manifest/index.md#icons) documentation). |
| *icons* | string | The item icons (see the plugins [config](../../../Plugin%20and%20Macros/Structure/Manifest/index.md#icons) documentation). |
| *onClick* | function | The click event callback. |
| *items* | Array.\<ContextMenuItem> | An array containing the context menu items for the current item. |

Expand Down Expand Up @@ -95,7 +95,7 @@ Parameters:
| *type* | [ToolbarMenuItemType](#toolbarmenuitemtype) | The item type. |
| *text* | string | The item caption. If this field is "", the toolbar button is displayed only with an icon, without a caption. |
| *hint* | string | The item hint. |
| *icons* | string | object | The item icons (see the plugins [config](../../../Plugin%20and%20Macros/Structure/Manifest/index.md#variationsicons) documentation). |
| *icons* | string | object | The item icons (see the plugins [config](../../../Plugin%20and%20Macros/Structure/Manifest/index.md#variationsicons) documentation). |
| *disabled* | boolean | Specifies whether the current item is locked. |
| *enableToggle* | boolean | Specifies whether the toolbar menu item (when *"split == false"*) or its top part (when *"split == true"*) can be toggled. |
| *lockInViewMode* | boolean | Specifies whether the toolbar menu item is automatically locked in the view modes (when previewing, viewing forms, disconnecting, etc.). |
Expand Down Expand Up @@ -204,7 +204,7 @@ connector.connect()

## createWindow

The function called to create the [connector modal window](#connector-window) to display the additional information inside the editor.
The function called to create the [connector modal window](#connector-window) to display the additional information inside the editor.

Example:

Expand Down Expand Up @@ -294,7 +294,7 @@ connector.updateContextMenuItem(items)

## Connector window

Connector window is a class that represents the connector window. To create it, use the [createWindow](#createwindow) method of the connector object.
Connector window is a class that represents the connector window. To create it, use the [createWindow](#createwindow) method of the connector object.

Below you can find methods that are available for this class.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`POST /wopi/files/(file_id)/contents`

Updates a files binary contents for the `HTTP://server/<...>/wopi*/files/<id>/contents` operation.
Updates a file's binary contents for the `HTTP://server/<...>/wopi*/files/<id>/contents` operation.

This operation works as follows:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ To use `configure.py`, specify the following options:

2. Test samples with `--test TEST`. Some available options:

- `--test all` generate projects for all samples;
- `--test cs` generate projects only for C# samples;
- `--test cs/creating_basic_form` generate only the project for the specified sample.
- `--test all` generate projects for all samples;
- `--test cs` generate projects only for C# samples;
- `--test cs/creating_basic_form` generate only the project for the specified sample.

Several test options are available at the same time. To see all available `TEST` options call `configure.py -l`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ To use `configure.py`, specify the following options:

2. Test samples with `--test TEST`. Some available options:

- `--test all` generate projects for all samples;
- `--test cpp` generate projects only for C++ samples;
- `--test cpp/creating_basic_form` generate only the project for the specified sample.
- `--test all` generate projects for all samples;
- `--test cpp` generate projects only for C++ samples;
- `--test cpp/creating_basic_form` generate only the project for the specified sample.

Several test options are available at the same time. To see all available `TEST` options call `configure.py -l`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ To use `configure.py`, specify the following options:

1. Test samples with `--test TEST`. Some available options:

- `--test all` generate projects for all samples;
- `--test python` generate projects only for Python samples;
- `--test python/creating_basic_form` generate only the project for the specified sample.
- `--test all` generate projects for all samples;
- `--test python` generate projects only for Python samples;
- `--test python/creating_basic_form` generate only the project for the specified sample.

Several test options are available at the same time. To see all available `TEST` options call `configure.py -l`.

Expand Down
2 changes: 1 addition & 1 deletion site/pages/Docs/Office API/Usage API/Form API/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
order: -2
---

A form document has exactly the same structure as a [text document](../Text%20Document%20API/index.md). The only difference is a new *forms* entity placed with other paragraph elements text runs, inline text content controls and hyperlinks. There are seven form types: *text field*, *combo box*, *dropdown list*, *checkbox*, *radio button*, *picture form*, and *complex field*.
A form document has exactly the same structure as a [text document](../Text%20Document%20API/index.md). The only difference is a new *forms* entity placed with other paragraph elements - text runs, inline text content controls and hyperlinks. There are seven form types: *text field*, *combo box*, *dropdown list*, *checkbox*, *radio button*, *picture form*, and *complex field*.

## Creating a new form document

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To process [buttons](../../Structure/Manifest/index.md#variationsbuttons) which

| Name | Type | Description |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *id* | number | Defines the button index in the [buttons](../../Structure/Manifest/index.md#variationsbuttons) array of the *config.json* file. If *id == -1*, then the plugin considers that the **Close** window cross button has been clicked or its operation has been somehow interrupted. |
| *id* | number | Defines the button index in the [buttons](../../Structure/Manifest/index.md#variationsbuttons) array of the *config.json* file. If *id == -1*, then the plugin considers that the **Close** window cross button has been clicked or its operation has been somehow interrupted. |
| *windowId* | number | Defines an index of the button from the modal window. |

## Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The plugin can be accessed via the context menu.
| *text* | string | The item caption. |
| *data* | string | The item data (this data will be sent to the click event callback). |
| *disabled* | boolean | Specifies whether the current item is disabled or not. |
| *icons* | string | The item icons (see the plugins [config](../../Structure/Manifest/index.md) documentation). |
| *icons* | string | The item icons (see the plugins [config](../../Structure/Manifest/index.md) documentation). |
| *items* | Array.\<ContextMenuItem> | An array containing the context menu items for the current item. |

Example:
Expand Down
Loading

0 comments on commit 853fad2

Please sign in to comment.