From 3c1122fa99a028c96e90ac590009d2a02d712ddc Mon Sep 17 00:00:00 2001 From: Valentin Mihai Date: Tue, 5 Sep 2023 17:35:33 +0300 Subject: [PATCH 1/6] DM-358 - WIP on implementing Help Mode-IDs for DocuMine --- .../base-screen/base-screen.component.html | 2 +- .../breadcrumbs/breadcrumbs.component.html | 22 ++++---- .../account-side-nav.component.html | 2 +- .../account-side-nav.component.ts | 5 ++ .../admin-side-nav.component.ts | 13 +++-- .../template-stats.component.html | 16 +++--- .../src/assets/help-mode/help-mode-keys.json | 55 ++++++++++++++----- 7 files changed, 75 insertions(+), 40 deletions(-) diff --git a/apps/red-ui/src/app/components/base-screen/base-screen.component.html b/apps/red-ui/src/app/components/base-screen/base-screen.component.html index 20eb64e45..0cc8595f3 100644 --- a/apps/red-ui/src/app/components/base-screen/base-screen.component.html +++ b/apps/red-ui/src/app/components/base-screen/base-screen.component.html @@ -21,7 +21,7 @@ diff --git a/apps/red-ui/src/app/components/breadcrumbs/breadcrumbs.component.html b/apps/red-ui/src/app/components/breadcrumbs/breadcrumbs.component.html index 25dae2bc4..0c2b76d41 100644 --- a/apps/red-ui/src/app/components/breadcrumbs/breadcrumbs.component.html +++ b/apps/red-ui/src/app/components/breadcrumbs/breadcrumbs.component.html @@ -1,4 +1,4 @@ -
+
{{ 'top-bar.navigation-items.back' | translate }} @@ -29,15 +29,17 @@ > - - {{ option.name$ | async }} - - + diff --git a/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.html b/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.html index b72fd75dd..1a97e0126 100644 --- a/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.html +++ b/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.html @@ -4,7 +4,7 @@ *ngIf="item.show" [routerLinkActiveOptions]="{ exact: false }" [routerLink]="'../' + item.screen" - [attr.help-mode-key]="'user_account'" + [attr.help-mode-key]="item.helpModeKey" class="item" routerLinkActive="active" > diff --git a/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.ts b/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.ts index c21b6346c..bebf6d1a1 100644 --- a/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.ts +++ b/apps/red-ui/src/app/modules/account/account-side-nav/account-side-nav.component.ts @@ -9,6 +9,7 @@ interface NavItem { readonly label: string; readonly screen: string; readonly show?: boolean; + readonly helpModeKey?: string; } @Component({ @@ -24,21 +25,25 @@ export class AccountSideNavComponent { screen: 'user-profile', label: _('user-profile'), show: true, + helpModeKey: 'my_profile', }, { screen: 'notifications', show: this.currentUser.isUser && this._permissionsService.has(Roles.notifications.write), label: _('notifications.label'), + helpModeKey: 'notification_preferences', }, { screen: 'preferences', label: _('preferences-screen.label'), show: this.currentUser.isUser, + helpModeKey: 'user_preferences', }, { screen: 'warnings-preferences', label: _('preferences-screen.warnings-label'), show: this.currentUser.isUser, + helpModeKey: 'prompts_and_dialogs', }, ]; diff --git a/apps/red-ui/src/app/modules/admin/shared/components/admin-side-nav/admin-side-nav.component.ts b/apps/red-ui/src/app/modules/admin/shared/components/admin-side-nav/admin-side-nav.component.ts index e313824b6..bda7582d2 100644 --- a/apps/red-ui/src/app/modules/admin/shared/components/admin-side-nav/admin-side-nav.component.ts +++ b/apps/red-ui/src/app/modules/admin/shared/components/admin-side-nav/admin-side-nav.component.ts @@ -86,13 +86,13 @@ export class AdminSideNavComponent implements OnInit { { screen: 'info', label: _('admin-side-nav.dossier-template-info'), - helpModeKey: 'dossier_templates_info', + helpModeKey: 'user_dossier_template_info', show: true, }, { screen: 'entities', label: _('admin-side-nav.entities'), - helpModeKey: 'entities', + helpModeKey: 'user_dossier_template_entities', show: true, }, { @@ -127,14 +127,14 @@ export class AdminSideNavComponent implements OnInit { { screen: 'dossier-states', label: _('admin-side-nav.dossier-states'), - helpModeKey: 'dossier_states', + helpModeKey: 'user_dossier_template_dossier_states', show: true, }, { screen: 'reports', label: _('admin-side-nav.reports'), show: this._permissionsService.has([Roles.reportTemplates.read]), - helpModeKey: 'reports', + helpModeKey: 'user_dossier_template_reports', }, { screen: 'justifications', @@ -170,7 +170,10 @@ export class AdminSideNavComponent implements OnInit { ], }; - constructor(private readonly _permissionsService: IqserPermissionsService, private readonly _route: ActivatedRoute) {} + constructor( + private readonly _permissionsService: IqserPermissionsService, + private readonly _route: ActivatedRoute, + ) {} @HostBinding('class.smaller') get isSmaller(): boolean { return [AdminSideNavTypes.dossierTemplates, AdminSideNavTypes.entities].includes(this.type); diff --git a/apps/red-ui/src/app/modules/dashboard/components/template-stats/template-stats.component.html b/apps/red-ui/src/app/modules/dashboard/components/template-stats/template-stats.component.html index ea1fd5a08..7c479b1dc 100644 --- a/apps/red-ui/src/app/modules/dashboard/components/template-stats/template-stats.component.html +++ b/apps/red-ui/src/app/modules/dashboard/components/template-stats/template-stats.component.html @@ -2,7 +2,7 @@ *ngIf="stats as dossierTemplate" [class.empty]="dossierTemplate.isEmpty" [routerLink]="dossierTemplate.isEmpty ? null : ['..', dossierTemplate.dossierTemplateId]" - [attr.help-mode-key]="!dossierTemplate.isEmpty ? 'dossier_overview' : null" + [attr.help-mode-key]="!dossierTemplate.isEmpty ? 'open_dossier_template' : null" class="dialog" > @@ -13,7 +13,7 @@
@@ -21,20 +21,18 @@
- +
@@ -44,7 +42,7 @@ [config]="translateChartService.translateDossierStates(dossierTemplate.dossiersChartConfig, dossierTemplate.id)" [radius]="63" [strokeWidth]="15" - [subtitles]="['dossier-template-stats.active-dossiers' | translate : { count: dossierTemplate.numberOfActiveDossiers }]" + [subtitles]="['dossier-template-stats.active-dossiers' | translate: { count: dossierTemplate.numberOfActiveDossiers }]" direction="row" totalType="sum" > @@ -76,7 +74,7 @@ *ngIf="permissionsService.canCreateDossier(dossierTemplate)" [label]="'dashboard.empty-template.new-dossier' | translate" [type]="iconButtonTypes.primary" - [attr.help-mode-key]="'new_dossier_button'" + [attr.help-mode-key]="'new_dossier'" icon="iqser:plus" > diff --git a/apps/red-ui/src/assets/help-mode/help-mode-keys.json b/apps/red-ui/src/assets/help-mode/help-mode-keys.json index e6765529b..27a5d1a00 100644 --- a/apps/red-ui/src/assets/help-mode/help-mode-keys.json +++ b/apps/red-ui/src/assets/help-mode/help-mode-keys.json @@ -27,14 +27,19 @@ "documentKey": "filter_dossier_list" }, { - "elementKey": "navigate_in_breadcrumbs", - "documentKey": "navigate_in_breadcrumbs" + "elementKey": "navigate_breadcrumbs", + "documentKey": "navigate_breadcrumbs" }, { "elementKey": "new_dossier_button", "documentKey": "new_dossier_button", "overlappingElements": ["USER_MENU"] }, + { + "elementKey": "new_dossier", + "documentKey": "new_dossier", + "overlappingElements": ["USER_MENU"] + }, { "elementKey": "open_notifications", "documentKey": "open_notifications" @@ -48,8 +53,8 @@ "documentKey": "views" }, { - "elementKey": "search_in_entire_application", - "documentKey": "search_in_entire_application" + "elementKey": "search_entire_application", + "documentKey": "search_entire_application" }, { "elementKey": "edit_dossier_in_dossier", @@ -155,8 +160,20 @@ "overlappingElements": ["USER_MENU", "DOCUMENT_INFO"] }, { - "elementKey": "user_account", - "documentKey": "user_account" + "elementKey": "my_profile", + "documentKey": "my_profile" + }, + { + "elementKey": "notification_preferences", + "documentKey": "notification_preferences" + }, + { + "elementKey": "user_preferences", + "documentKey": "user_preferences" + }, + { + "elementKey": "prompts_and_dialogs", + "documentKey": "prompts_and_dialogs" }, { "elementKey": "my_downloads", @@ -167,8 +184,8 @@ "documentKey": "trash" }, { - "elementKey": "dossier_overview", - "documentKey": "dossier_overview" + "elementKey": "open_dossier_template", + "documentKey": "open_dossier_template" }, { "elementKey": "home", @@ -189,7 +206,8 @@ { "elementKey": "dossier", "documentKey": "dossier", - "scrollableParentView": "VIRTUAL_SCROLL" + "scrollableParentView": "VIRTUAL_SCROLL", + "overlappingElements": ["BREADCRUMBS_MENU"] }, { "elementKey": "document_in_editor", @@ -198,7 +216,8 @@ }, { "elementKey": "dossier_list", - "documentKey": "dossier_list" + "documentKey": "dossier_list", + "overlappingElements": ["BREADCRUMBS_MENU"] }, { "elementKey": "dossier_templates", @@ -210,13 +229,17 @@ "overlappingElements": ["USER_MENU"] }, { - "elementKey": "dossier_templates_info", - "documentKey": "dossier_templates_info" + "elementKey": "user_dossier_template_info", + "documentKey": "user_dossier_template_info" }, { "elementKey": "entities", "documentKey": "entities" }, + { + "elementKey": "user_dossier_template_entities", + "documentKey": "user_dossier_template_entities" + }, { "elementKey": "edit_delete_entities", "documentKey": "edit_delete_entities", @@ -280,8 +303,8 @@ "overlappingElements": ["USER_MENU"] }, { - "elementKey": "dossier_states", - "documentKey": "dossier_states" + "elementKey": "user_dossier_template_dossier_states", + "documentKey": "user_dossier_template_dossier_states" }, { "elementKey": "create_new_dossier_state", @@ -296,6 +319,10 @@ "documentKey": "reports", "overlappingElements": ["USER_MENU"] }, + { + "elementKey": "user_dossier_template_reports", + "documentKey": "user_dossier_template_reports" + }, { "elementKey": "justifications", "documentKey": "justifications" From d7a89c393d80e8eab8a60bf890e44730694da62a Mon Sep 17 00:00:00 2001 From: Valentin Mihai Date: Wed, 6 Sep 2023 18:53:39 +0300 Subject: [PATCH 2/6] DM-358 - WIP on implementing Help Mode-IDs for DocuMine --- .../archive/services/config.service.ts | 4 +- ...sier-overview-screen-header.component.html | 6 +- .../dossier-overview/config.service.ts | 10 +- .../dossiers-listing/config.service.ts | 6 +- .../components/pages/pages.component.html | 2 +- .../user-management.component.html | 2 +- .../file-preview-screen.component.html | 5 +- .../dossiers-listing-actions.component.html | 2 +- .../file-actions/file-actions.component.html | 3 +- .../file-actions/file-actions.component.ts | 19 ++- .../dossiers-type-switch.component.html | 4 +- .../expandable-file-actions.component.html | 3 + .../expandable-file-actions.component.ts | 5 + .../src/assets/help-mode/help-mode-keys.json | 114 +++++++++++++++++- libs/common-ui | 2 +- 15 files changed, 160 insertions(+), 27 deletions(-) diff --git a/apps/red-ui/src/app/modules/archive/services/config.service.ts b/apps/red-ui/src/app/modules/archive/services/config.service.ts index 5655dbf0c..d1472e149 100644 --- a/apps/red-ui/src/app/modules/archive/services/config.service.ts +++ b/apps/red-ui/src/app/modules/archive/services/config.service.ts @@ -106,14 +106,14 @@ export class ConfigService { label: this._translateService.instant('dossier-listing.quick-filters.owner'), checker: dossierOwnerQuickChecker(userId), disabled: entities.filter(dossierOwnerQuickChecker(userId)).length === 0, - helpModeKey: 'filter_dossier_list', + helpModeKey: 'quick_filter_dossiers', }, { id: 'member', label: this._translateService.instant('dossier-listing.quick-filters.member'), checker: dossierMemberQuickChecker(userId), disabled: entities.filter(dossierMemberQuickChecker(userId)).length === 0, - helpModeKey: 'filter_dossier_list', + helpModeKey: 'quick_filter_dossiers', }, ].map(filter => new NestedFilter(filter)); } diff --git a/apps/red-ui/src/app/modules/dossier-overview/components/screen-header/dossier-overview-screen-header.component.html b/apps/red-ui/src/app/modules/dossier-overview/components/screen-header/dossier-overview-screen-header.component.html index 9db020284..1a46d08ff 100644 --- a/apps/red-ui/src/app/modules/dossier-overview/components/screen-header/dossier-overview-screen-header.component.html +++ b/apps/red-ui/src/app/modules/dossier-overview/components/screen-header/dossier-overview-screen-header.component.html @@ -7,7 +7,7 @@ > this.#openEditDossierDialog(dossierId), icon: 'iqser:edit', hide: !this.#currentUser.isManager && !this._iqserPermissionsService.has(Roles.dossiers.edit), - helpModeKey: 'edit_dossier_in_dossier', + helpModeKey: 'edit_dossier', disabled$, }, ]; @@ -446,28 +446,28 @@ export class ConfigService { required: true, checker: this._recentlyModifiedChecker, disabled: entities.filter(this._recentlyModifiedChecker).length === 0, - helpModeKey: 'filter_document_list', + helpModeKey: 'quick_filters_documents', }, { id: 'assigned-to-me', label: this._translateService.instant('dossier-overview.quick-filters.assigned-to-me'), checker: this._assignedToMeChecker, disabled: entities.filter(this._assignedToMeChecker).length === 0, - helpModeKey: 'filter_document_list', + helpModeKey: 'quick_filters_documents', }, { id: 'unassigned', label: this._translateService.instant('dossier-overview.quick-filters.unassigned'), checker: this._unassignedChecker, disabled: entities.filter(this._unassignedChecker).length === 0, - helpModeKey: 'filter_document_list', + helpModeKey: 'quick_filters_documents', }, { id: 'assigned-to-others', label: this._translateService.instant('dossier-overview.quick-filters.assigned-to-others'), checker: this._assignedToOthersChecker, disabled: entities.filter(this._assignedToOthersChecker).length === 0, - helpModeKey: 'filter_document_list', + helpModeKey: 'quick_filters_documents', }, ].map(filter => new NestedFilter(filter)); } diff --git a/apps/red-ui/src/app/modules/dossiers-listing/config.service.ts b/apps/red-ui/src/app/modules/dossiers-listing/config.service.ts index 5245afec3..5f6490ad0 100644 --- a/apps/red-ui/src/app/modules/dossiers-listing/config.service.ts +++ b/apps/red-ui/src/app/modules/dossiers-listing/config.service.ts @@ -69,7 +69,7 @@ export class ConfigService { hide: !this._permissionsService.canCreateDossier(dossierTemplate), icon: 'iqser:plus', type: 'primary', - helpModeKey: 'new_dossier_button', + helpModeKey: 'new_dossier', }, ]; } @@ -226,14 +226,14 @@ export class ConfigService { label: this._translateService.instant('dossier-listing.quick-filters.owner'), checker: dossierOwnerQuickChecker(userId), disabled: entities.filter(dossierOwnerQuickChecker(userId)).length === 0, - helpModeKey: 'filter_dossier_list', + helpModeKey: 'quick_filter_dossiers', }, { id: 'member', label: this._translateService.instant('dossier-listing.quick-filters.member'), checker: dossierMemberQuickChecker(userId), disabled: entities.filter(dossierMemberQuickChecker(userId)).length === 0, - helpModeKey: 'filter_dossier_list', + helpModeKey: 'quick_filter_dossiers', }, ].map(filter => new NestedFilter(filter)); } diff --git a/apps/red-ui/src/app/modules/file-preview/components/pages/pages.component.html b/apps/red-ui/src/app/modules/file-preview/components/pages/pages.component.html index 1b859c016..3927d5d70 100644 --- a/apps/red-ui/src/app/modules/file-preview/components/pages/pages.component.html +++ b/apps/red-ui/src/app/modules/file-preview/components/pages/pages.component.html @@ -1,4 +1,4 @@ -
+
@@ -73,6 +75,7 @@ [tooltip]="'common.close' | translate" class="ml-8" icon="iqser:close" + [attr.help-mode-key]="'editor_close'" >
diff --git a/apps/red-ui/src/app/modules/shared-dossiers/components/dossiers-listing-actions/dossiers-listing-actions.component.html b/apps/red-ui/src/app/modules/shared-dossiers/components/dossiers-listing-actions/dossiers-listing-actions.component.html index 7ca821014..47276c23b 100644 --- a/apps/red-ui/src/app/modules/shared-dossiers/components/dossiers-listing-actions/dossiers-listing-actions.component.html +++ b/apps/red-ui/src/app/modules/shared-dossiers/components/dossiers-listing-actions/dossiers-listing-actions.component.html @@ -2,7 +2,7 @@ -
+
diff --git a/apps/red-ui/src/app/modules/shared-dossiers/components/file-actions/file-actions.component.ts b/apps/red-ui/src/app/modules/shared-dossiers/components/file-actions/file-actions.component.ts index 9ddd0cbd2..6c9c62758 100644 --- a/apps/red-ui/src/app/modules/shared-dossiers/components/file-actions/file-actions.component.ts +++ b/apps/red-ui/src/app/modules/shared-dossiers/components/file-actions/file-actions.component.ts @@ -41,7 +41,7 @@ export class FileActionsComponent implements OnChanges { @Input({ required: true }) type: 'file-preview' | 'dossier-overview-list' | 'dossier-overview-workflow'; @Input() maxWidth: number; @Input() minWidth: number; - @Input() fileActionsHelpModeKey: 'document_features_in_dossier' | 'editor_document_features' = 'document_features_in_dossier'; + @Input() helpModeKeyPrefix: 'dossier' | 'editor' = 'dossier'; readonly currentUser = getCurrentUser(); toggleTooltip?: string; assignTooltip?: string; @@ -112,6 +112,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.delete.action'), icon: 'iqser:trash', show: this.showDelete, + helpModeKey: 'delete_file', }, { id: 'assign-btn', @@ -120,6 +121,7 @@ export class FileActionsComponent implements OnChanges { tooltip: this.assignTooltip, icon: 'red:assign', show: this.showAssign, + helpModeKey: 'assign_user', }, { id: 'assign-to-me-btn', @@ -128,6 +130,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.assign-me'), icon: 'red:assign-me', show: this.showAssignToSelf, + helpModeKey: 'assign_user', }, { id: 'open-import-redactions-dialog-btn', @@ -145,6 +148,7 @@ export class FileActionsComponent implements OnChanges { tooltipClass: 'small', show: this._permissionsService.canDownloadRedactedFile() && !!this.file.lastProcessed, disabled: this.file.processingStatus === ProcessingFileStatuses.ERROR, + helpModeKey: 'download', }, { id: 'toggle-document-info-btn', @@ -154,6 +158,7 @@ export class FileActionsComponent implements OnChanges { ariaExpanded: toObservable(this._documentInfoService?.shown, { injector: this._injector }), icon: 'red:status-info', show: !!this._documentInfoService, + helpModeKey: 'document_info', }, { id: 'toggle-exclude-pages-btn', @@ -172,6 +177,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.back-to-new'), icon: 'red:undo', show: this.showSetToNew, + helpModeKey: 'change_status', }, { id: 'set-file-under-approval-btn', @@ -180,6 +186,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.under-approval'), icon: 'red:ready-for-approval', show: this.showUnderApproval, + helpModeKey: 'change_status', }, { id: 'set-file-under-review-btn', @@ -188,6 +195,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.under-review'), icon: 'red:undo', show: this.showUnderReview, + helpModeKey: 'change_status', }, { id: 'set-file-approved-btn', @@ -197,6 +205,7 @@ export class FileActionsComponent implements OnChanges { icon: 'red:approved', disabled: !this.file.canBeApproved, show: this.showApprove, + helpModeKey: 'change_status', }, { id: 'toggle-automatic-analysis-btn', @@ -205,6 +214,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.stop-auto-analysis'), icon: 'red:disable-analysis', show: this.canDisableAutoAnalysis, + helpModeKey: 'stop_analysis', }, { id: 'reanalyse-file-preview-btn', @@ -215,6 +225,7 @@ export class FileActionsComponent implements OnChanges { icon: 'iqser:refresh', show: this.showReanalyseFilePreview, disabled: this.file.isProcessing, + helpModeKey: 'stop_analysis', }, { id: 'toggle-automatic-analysis-btn', @@ -224,6 +235,7 @@ export class FileActionsComponent implements OnChanges { buttonType: this.isFilePreview ? CircleButtonTypes.warn : CircleButtonTypes.default, icon: 'red:enable-analysis', show: this.canEnableAutoAnalysis, + helpModeKey: 'stop_analysis', }, { id: 'set-under-approval-btn', @@ -232,6 +244,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.under-approval'), icon: 'red:undo', show: this.showUndoApproval, + helpModeKey: 'change_status', }, { id: 'ocr-file-btn', @@ -248,6 +261,7 @@ export class FileActionsComponent implements OnChanges { tooltip: _('dossier-overview.reanalyse.action'), icon: 'iqser:refresh', show: this.showReanalyseDossierOverview, + helpModeKey: 'stop_analysis', }, { id: 'toggle-analysis-btn', @@ -258,9 +272,12 @@ export class FileActionsComponent implements OnChanges { class: { 'mr-24': this.isDossierOverviewList }, checked: !this.file.excluded, show: this.showToggleAnalysis, + helpModeKey: 'disable_redaction', }, ]; + console.log(actions.filter(btn => btn.show)); + return actions.filter(btn => btn.show); } diff --git a/apps/red-ui/src/app/modules/shared/components/dossiers-type-switch/dossiers-type-switch.component.html b/apps/red-ui/src/app/modules/shared/components/dossiers-type-switch/dossiers-type-switch.component.html index 47b264762..e261eb0a3 100644 --- a/apps/red-ui/src/app/modules/shared/components/dossiers-type-switch/dossiers-type-switch.component.html +++ b/apps/red-ui/src/app/modules/shared/components/dossiers-type-switch/dossiers-type-switch.component.html @@ -2,7 +2,7 @@