Вопросы по кастомизации

Часто задаваемые вопросы сервиса документа:
Вопросы по кастомизации

Как сделать White label сервера документа Р7?
Приведенные ниже параметры можно отредактировать, чтобы пометить вашу версию Сервера документов, изменив информацию, которая будет отображаться на странице «О программе» и видна всем пользователям редактора.

Обратите внимание, что изменение этих параметров доступно только пользователям Р7 Developer Edition.
  • Опции editorConfig.customization.customer:
    •  editorConfig.customization.customer.address используется для указания почтового адреса компании или лица;
    • editorConfig.customization.customer.info используется для предоставления дополнительной информации о компании или человеке;
    • editorConfig.customization.customer.logo is used to specify the path to the image logo; editorConfig.customization.customer.logo используется для указания пути к изображению логотипа;
    • editorConfig.customization.customer.logoDark используется для указания пути к изображению логотипа для тёмной темы оформления;
    • editorConfig.customization.customer.mail используется для указания адреса электронной почты компании или лица;
    • editorConfig.customization.customer.name используется для указания названия компании или лица, дающего доступ к редакторам или авторам редакторов;
    • editorConfig.customization.customer.www используется для указания адреса домашнего веб-сайта компании или человека.
  • Опции editorConfig.customization.logo:
    • editorConfig.customization.logo.image используется для указания пути к файлу изображения, используемого для показа в обычном режиме работы (т.е. в режимах просмотра и редактирования для всех редакторов) или во встроенном режиме;
    • editorConfig.customization.logo.imageDark используется для указания пути к файлу изображения, используемого для темной темы;
    • editorConfig.customization.logo.url используется для указания абсолютного URL, который будет использоваться при нажатии на изображение логотипа (вы можете оставить пустую строку или null, чтобы сделать логотип некликабельным).

После заполнения всех вышеуказанных полей конфигурация кастомизации будет выглядеть следующим образом:

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "customization": {
            "customer": {
                "address": "My City, 123a-45",
                "info": "Some additional information",
                "logo": "https://example.com/logo-big.png",
                "logoDark": "https://example.com/dark-logo-big.png",
                "mail": "john@example.com",
                "name": "John Smith and Co.",
                "www": "example.com"
            },
            "logo": {
                "image": "https://example.com/logo.png",
                "imageDark": "https://example.com/dark-logo.png",
                "url": "https://www.Р7.com"
            },
            ...
        },
        ...
    },
    ...
});

Дополнительную информацию о настройке можно найти на этой странице.

Как изменить язык по умолчанию интерфейса сервера документов?
Если язык интерфейса присутствует в списке доступных языков сервера документа, вы можете просто использовать свойство editorConfig.lang в файле конфигурации, чтобы установить его на нужную локаль, как показано ниже:

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "lang": "de",
        ...
    },
    ...
});

Если язык недоступен, и вы хотите перевести его или уже перевели его на свой собственный язык, обратитесь к этой статье, чтобы узнать, как установить его на ваш сервер документов.

Дополнительную информацию о языковых настройках можно найти на этой странице.

Как включить или отключить чат и/или панель комментариев в редакторах?
Чат и комментарии включены по умолчанию. Чтобы отключить их, используйте параметры document.permissions.comment и document.permissions.chat со значениями, установленными в false в файле конфигурации соответственно:

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "document": {
        "permissions": {
            "chat": false,
            "comment": false,
            ...
        },
        ...
    },
    ...
});

Это отключит кнопки «Чат» и «Комментарии» и их функции.

Дополнительную информацию о кастомизации можно найти на этой странице.

Как кастомизировать интерфейс редакторов, например. настроить вид верхней панели инструментов?
Вы можете отображать либо полную верхнюю панель инструментов, либо ее компактную версию. Для управления этим используется параметр editorConfig.customization.compactToolbar. При значении по умолчанию false верхняя панель инструментов будет иметь свой обычный вид. Если вы хотите отображать ее компактный вариант, конфигурация должна выглядеть следующим образом:

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "customization": {
            "compactToolbar": true,
            ...
        },
        ...
    },
    ...
});

Дополнительную информацию о настройке можно найти на этой странице.

Как просмотреть и изменить дополнительные параметры документа, например, его владельца или дату загрузки?
На владельца документа и дату загрузки влияют параметры document.info.owner и document.info.uploaded соответственно. Вы можете передать эти настройки из какой-нибудь своей базы данных в конфигурационный файл документа следующим образом:

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "document": {
        "info": {
            "owner": "John Smith",
            "uploaded": "2010-07-07 3:46 PM",
        },
        ...
    },
    ...
});

Эти значения будут отображаться в пункте меню Файл > Информация о документе….

Дополнительную информацию об этих настройках можно найти на этой странице.

Как оптимизировать внешний вид редакторов для стационарного компьютера, или для мобильного устройства, или для встраивания в веб-страницу?
Существует три основных вида редакторов, оптимизированных для различного использования:

  • desktop, который оптимизирован для отображения в браузерах настольных компьютеров:
    var docEditor = new DocsAPI.DocEditor("placeholder", {
    "type": "desktop",
    ...
});
  • mobile, который оптимизирован для отображения в браузерах мобильных устройств:
    var docEditor = new DocsAPI.DocEditor("placeholder", {
    "type": "mobile",
    ...
});
  • embedded, который оптимизирован для встраивания документов в страницу веб-сайта:
    var docEditor = new DocsAPI.DocEditor("placeholder", {
    "type": "embedded",
    ...
});

Вы можете использовать любой внешний вид для мобильных устройств или встроить документ на свою веб-страницу, но логичнее использовать определенный тип отображения.

Дополнительную информацию о типе дисплея можно найти на этой странице.

Как подключить плагины к Серверу документов, чтобы они стали видны всем пользователям редактора?
Чтобы включить плагины для всех пользователей Document Server, необходимо следующее:

  • Получите плагины.
  • Поместите плагины в папку, доступную редактору документов.
  • Измените конфигурационный файл следующим образом:
var docEditor = new DocsAPI.DocEditor("placeholder", {
    "editorConfig": {
        "plugins": {
             "autostart": [
                 "asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
                 "asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
                 ...
             ],
             "pluginsData": [
                 "https://example.com/plugin1/config.json",
                 "https://example.com/plugin2/config.json",
                 ...
             ]
        },
        ...
    },
    ...
});

Где editorConfig.plugins.autostart — это массив GUID для плагинов, которые вы хотите запускать автоматически при запуске Document Server (как определено в файле config.json плагина), а editorConfig.plugins.pluginsData — это массив config.json файлов конфигурации для всех плагинов, которые вы хотите, чтобы были доступны пользователям Document Server.

Дополнительную информацию о включении подключаемых модулей для Сервера документов можно найти на этой странице.