PrizmDoc® v14.3 Release - Updated January 14, 2025
PrizmDoc / Developer Guide / PrizmDoc / Configure PrizmDoc / Configuration Options / Configure the Comments Panel
In This Topic
Configure the Comments Panel
In This Topic

Introduction

To better accommodate the Comments view for both small and large viewers, the Viewer automatically switches between displaying the full comments and displaying only a Comments icon. When you click the Comments icon, the full comment is expanded.

The commentsPanelMode options are:

  • full - The entire content of the comments are displayed in the sidebar of the document.
  • skinny - An icon is placed in the sidebar of the document, representing each comment thread. When the icon is clicked, the comment thread is expanded to show the full content.
  • auto - This mode will intelligently switch between the full and skinny mode, in order to optimize the space available for viewing the document. The default is "auto" when the option is not specified.

The examples below show the use of the commentsPanelMode configuration parameter.

Forcing the Viewer to always display skinny comments:

Example

var pluginOptions = {
    documentID: viewingSessionId,
    language: languageItems,
    template: htmlTemplates,
    commentsPanelMode: "skinny"
};
$(document).ready(function () {
    var viewerControl = $("#viewer1").pccViewer(pluginOptions).viewerControl;
});

Forcing the Viewer to always display full comments:

Example

var pluginOptions = {
    documentID: viewingSessionId,
    language: languageItems,
    template: htmlTemplates,
    commentsPanelMode: "full"
};
$(document).ready(function () {
    var viewerControl = $("#viewer1").pccViewer(pluginOptions).viewerControl;
});

Allowing the Viewer to choose between skinny and full comments, which is the default option:

Example

var pluginOptions = {
    documentID: viewingSessionId,
    language: languageItems,
    template: htmlTemplates,
    commentsPanelMode: "auto"
};
$(document).ready(function () {
    var viewerControl = $("#viewer1").pccViewer(pluginOptions).viewerControl;
});