Skip to content

Commit

Permalink
[DOCS-7767] Update properties in Enterprise Viewer 4.0 (#1536)
Browse files Browse the repository at this point in the history
* [DOCS-7767] Update properties in Enterprise Viewer 4.0

* [DOCS-7767] Fix the descriptions
  • Loading branch information
mbujak-hyland authored Aug 22, 2024
1 parent 348e928 commit b9762f6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 27 deletions.
14 changes: 6 additions & 8 deletions enterprise-viewer/latest/config/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,12 @@ Default value:
```text
(t:Navigation),(prevPage,nextPage, zoomIn,zoomOut,--isSmallScreen),
(t:Mode),(t:PageEntry),d(checkinOfflineAnnotatedPdf,annotatedPdf,nativeContentDownload,extractPdfPages,offlineAnnotatedPdf,printAnnotatedPdf,
--dropdownLabel-Downloads,--dropdownIcon-save_alt),(t:AnnotationManipulation),
(t:Misc),d(t:Text,--dropdownLabel-Text Annotations,--dropdownIcon-font_download,--dropdownShowSelected),
d(drawLine,drawArrow,drawEllipse,drawRectangle,textbox,freeDraw,--dropdownLabel-Drawing Tools,--dropdownIcon-edit,--dropdownShowSelected),
d(approvedStamp,paidStamp,reviewedStamp,acceptStamp,rejectStamp,pageSizedCheckmarkStamp,--dropdownLabel-Stamps,--dropdownIcon-layers,--dropdownShowSelected),
d(t:Color,--dropdownLabel-Color Picker,--dropdownIcon-palette,--dropdownShowSelected),
printSectionsAction,--dropdownLabel-viewer.toolbar.downloadTools.tooltip,--dropdownIcon-save_alt),(t:AnnotationManipulation),
(t:Misc),d(t:Text,--dropdownLabel-viewer.toolbar.textSelect.tooltip,--dropdownIcon-font_download,--dropdownShowSelected),
d(drawLine,drawArrow,drawEllipse,drawRectangle,drawBox,textbox,freeDraw,--dropdownLabel-viewer.toolbar.drawingTools.tooltip,--dropdownIcon-edit,--dropdownShowSelected),
d(approvedStamp,paidStamp,reviewedStamp,acceptStamp,rejectStamp,pageSizedCheckmarkStamp,--dropdownLabel-viewer.toolbar.stamps.tooltip,--dropdownIcon-layers,--dropdownShowSelected),
d(t:Color,--dropdownLabel-viewer.toolbar.colorpicker.tooltip,--dropdownIcon-palette,--dropdownShowSelected),
d(t:ChangeBgColor,--dropdownLabel-viewer.toolbar.changeBgColor.tooltip,--dropdownIcon-format_paint,--dropdownShowSelected),
(save,--isSmallScreen),(printAnnotatedPdf,--isSmallScreen),(stickyNote,--isSmallScreen),(highlight,--isSmallScreen),(t:Help),(toggleChat,t:Summary,--sidebar)
```

Expand All @@ -146,9 +147,6 @@ Default value:
```text
(t:Navigation),(prevPage,nextPage,zoomIn,zoomOut,--isSmallScreen),
(t:Mode),(t:PageEntry),(save,--showAtAllSizes),(mouse),(drawRedaction,textRedaction,--showAtAllSizes),(t:Help),(t:Search,--sidebar)
enabledIndexerActions=(t:PageEntry),(t:Navigation),(mouse),(prevPage,nextPage,zoomIn,zoomOut,--isSmallScreen),(drawRectangle,--showAtAllSizes),(selectText),(t:Help)
enabledEditActions=(t:Navigation),(prevPage,nextPage,zoomIn,zoomOut,--isSmallScreen),
(t:Mode),(t:PageEntry),(save,--showAtAllSizes),(t:DocumentManipulation,--showAtAllSizes),(t:Help)
```

### enabledIndexerActions
Expand Down
26 changes: 7 additions & 19 deletions enterprise-viewer/latest/config/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,6 @@ The docbase the service account should login to.

Default value: `""`

### emailInviteUrl

This URL is used in the invitation to collaborate email. If the `[docId]` placeholder is specified, it is replaced by the `objectId` of the document being viewed when the invitation is sent.

Default value: `http://localhost:8080/OpenAnnotate/viewer.htm?docId=[docId]&presenterMode=true&mode=readOnly`

### ocRestEndpointAddress

This URL is the REST endpoint for the running instance of OpenContent. If Enterprise Viewer is being used in a load balancing setup and the instances of Enterprise Viewer and OpenContent are on the same server, this property should be the **non-load balanced url**, to ensure that the requests to OpenContent are always directed to the same OpenContent instance.
Expand Down Expand Up @@ -111,11 +105,11 @@ In order to have `allowExternalReviewers` set to `true`, a special license setti

Default value: `false`

### AllowMultipleOfflineReviewers
### annotation.AllowMultipleOfflineReviewers

When set to `false` offline annotations will be owned by the user that checked the annotations in. No matter which user is set on the offline annotation, the annotation will always be displayed as being added by the user who checked in the document.

Default value: `true`
Default value: `false`

### excludeEmbeddedAnnotations

Expand Down Expand Up @@ -191,7 +185,7 @@ Default value: `64`

This property controls the initial resolution and the number of steps in the progressive loading process. You can define how many intermediate loading steps the image should go through before reaching its full resolution. This helps in improving the initial load time and provides a smoother user experience, especially for large images or documents.

Default value: `1`
Default value: `0`

### pageZoom

Expand Down Expand Up @@ -243,7 +237,7 @@ See [Configure Enterprise Viewer actions and modes]({% link enterprise-viewer/la

A comma separated list of style buttons that are visible for styling annotation text. Currently, only `italic`, `bold`, and `underline` are supported.

Default value: `bold,italic`
Default value: `bold,italic,underline`

### leftSidebarModules

Expand Down Expand Up @@ -297,7 +291,7 @@ The list of the Collaboration mode notifications that are enabled and appear on
Default value:

```text
chat,userJoined,userLeft,serverConnection,checkInAnnotations,checkInAnnotationsFailed,burnInRedactionFailed,checkinAnnotationsFinished,pageSelectMode,welcomeBackPage,save,loadedAnnotations,saveFinished,copyPaste,copyPasteNotReady,tooLargeForThumbnails,closeSave,closeCopyPaste,pageRangeInvalid,logstashFailed,portfolioContainsNonPdf,docHasAnnotations,afterPageLoad,textLocationDataFailed,enterSectioningMode,sectionNameInvalid,displayDocumentListFailed
chat,reply,mention,userJoined,userLeft,participantFollowing,participantBeingFollowed,serverConnection,checkInAnnotations,checkInAnnotationsFailed,checkInAnnotationsFailedUsernames,burnInRedactionFailed,checkinAnnotationsFinished,pageSelectMode,welcomeBackPage,save,loadedAnnotations,saveFinished,copyPaste,copyPasteNotReady,tooLargeForThumbnails,closeSave,closeCopyPaste,pageRangeInvalid,logstashFailed,portfolioContainsNonPdf,docHasAnnotations,afterPageLoad,textLocationDataFailed,enterSectioningMode,sectionNameInvalid,foundWidgets,collectionOpened,fileAttachmentFailed,fileAttachmentProcessing,splitPdfSelectPageRange,pdfDownloadFailed,pdfExtractPagesFailed,pdfPrunePagesFail,documentCreationFailed,switchToEditMode,displayDocumentListFailed,annotationContentConvertedToPlaintext,annotationContentFailedToSave,errorDrawingTextAnnotation,errorParsingRows,licenseWarn,limitedFunctionailityLargeFile
```

### slideViewerTileDirectoryRoot
Expand Down Expand Up @@ -330,12 +324,6 @@ Set to `true` to send new requests to OC every time you zoom in or out on a page

Default value: `true`

### quickSearch

Set to `true` to allow the user to immediately search selected text when Ctrl+F is pressed, or `false` otherwise.

Default value: `false`

### numberOfPagesForLargeDocuments

The number of pages that are considered as a "large" document.
Expand All @@ -344,7 +332,7 @@ The number of pages that are considered as a "large" document.
* If a document has more pages than the value here, text search data isn't loaded initially, and thumbnails are disabled.
* Text search data can still be manually loaded by the user later, after answering `yes` to a modal dialog box informing them of the delay.

Default value: `99`
Default value: `90`

### sizeOfLargeFiles

Expand Down Expand Up @@ -473,7 +461,7 @@ Different annotation types:
Line,Oval,Rectangle,Highlight,Cross-Out,Inserted Text,Replacement Text,Reply,Sticky Note,Signature,Approved Stamp,Accept Stamp,Reject Stamp,Reviewed Stamp,PageSizedCheckmark Stamp,Status,Freetext,File Attachment,Free Draw,Redaction
```

Default value: `""`
Default value: `Sticky Note`

### thumbnailBatchSize

Expand Down

0 comments on commit b9762f6

Please sign in to comment.