Опция «Комментарий» позволяет оставлять комментарии к определенным словам, фразам, предложениям и другим частям документа, редактировать и удалять эти комментарии. Все комментарии будут сохранены и показаны другим пользователям документа.

Чтобы включить параметр комментария, для параметра комментария в разделе разрешений инициализации документа должно быть установлено значение true. Боковая панель документа будет содержать пункт меню «Комментарий».

Если для параметра редактирования установлено значение true, а для параметра комментария также установлено значение true, пользователь сможет редактировать документ и комментарий.

Если для параметра редактирования установлено значение false, а для параметра комментария установлено значение true, документ будет доступен только для комментирования.

var docEditor = new DocsAPI.DocEditor("placeholder", {
    "document": {
        "permissions": {
            "edit": false,
            "comment": true
            ...
        },
        ...
    },
    ...
});
Обратите внимание, что комментирование документа будет доступно для редактора документа только в том случае, если параметр режима установлен на редактирование.
  1. Если вы хотите разрешить редактирование комментариев только их авторам, установите для параметра editCommentAuthorOnly в разделе разрешений инициализации редактора значение true.
    var docEditor = new DocsAPI.DocEditor("placeholder", {
        "document": {
            "permissions": {
                "editCommentAuthorOnly": true
                ...
            },
            ...
        },
        ...
    });
    
  2.  Если вы хотите разрешить удаление комментариев только их авторам, установите для параметра deleteCommentAuthorOnly в разделе разрешений инициализации редактора значение true.
    var docEditor = new DocsAPI.DocEditor("placeholder", {
        "document": {
            "permissions": {
                "deleteCommentAuthorOnly": true
                ...
            },
            ...
        },
        ...
    });
    
  1.  Укажите группу (или несколько групп, разделенных запятыми), к которой принадлежит пользователь, добавив поле group в userparameter в разделе editorConfig.
    var docEditor = new DocsAPI.DocEditor("placeholder", {
        "editorConfig": {
            "user": {
                "id": "78e1e841",
                "name": "John Smith",
                "group": "Group1"
            }
        },
        ...
    });
    
    var docEditor = new DocsAPI.DocEditor("placeholder", {
        "editorConfig": {
            "user": {
                "id": "F89d8069ba2b",
                "name": "Kate Cage",
                "group": "Group2"
            }
        },
        ...
    });
    

    2. Укажите права доступа с помощью параметра commentGroups в разделе разрешений инициализации редактора.

    Если в конфигурации редактора указан параметр commentGroups, права доступа на просмотр, редактирование и/или удаление всех комментариев отключены. В противном случае, если текущий пользователь не принадлежит ни к одной из групп, он может редактировать, удалять и/или просматривать комментарии всех групп.

    var docEditor = new DocsAPI.DocEditor("placeholder", {
        "document": {
            "permissions": {
                "commentGroups": {
                    "edit": ["Group2", ""],
                    "remove": [""],
                    "view": ""
                },
                ...
            }
            ...
        },
        ...
    });
    
    • «edit»: [«Group2», «»] означает, что пользователь может редактировать комментарии, сделанные пользователями из группы 2 и пользователями, не принадлежащими ни к одной из групп (например, документ, который комментируется в сторонних редакторах).
    • «remove»: [«»] означает, что пользователь может удалить комментарии, сделанные кем-то, кто не принадлежит ни к одной из этих групп (например, документ, который прокомментирован в сторонних редакторах).
    • «view»: «» означает, что пользователь может просматривать комментарии, сделанные любым пользователем.

Для корректного отображения комментариев к электронным таблицам Р7 в других редакторах, все комментарии сохраняются в двух форматах — исходном и threaded:

  1. Исходный формат комментария выглядит следующим образом:
${author1}:
comment
${author2}:
reply1
${author2}:
reply2

2. To convert the original comments format into the threaded comments, the «${author}:\n» string is deleted if the comment starts with it. Чтобы сконвертировать исходный формат комментариев в цепочку комментариев, строка «${author}:\n» удаляется, если с нее начинается комментарий.

Файл в редакторах открывается следующим образом:

  • Если в файле есть ветки комментариев, они используются при открытии.
  • Если есть комментарии только в исходном формате Р7, они преобразуются в цепочку комментариев.