[EDP-DDM-26091] Gathered navigation for user module, added improvemen…

…ts and fixes Change-Id: If51a690eac0c0e6cb3c885987c78292ed63f0290
epam · Sep 15, 2023 · d1f2153 · d1f2153
1 parent 8866a66
commit d1f2153
Show file tree

Hide file tree

Showing 43 changed files with 149 additions and 425 deletions.
diff --git a/docs/en/modules/registry-develop/pages/bp-modeling/index.adoc b/docs/en/modules/registry-develop/pages/bp-modeling/index.adoc
@@ -1,2 +1,3 @@
-//= Моделювальникам бізнес-процесів
-= Business process modelers guide
+= Business process modelers
+
+//TODO: hEREEEEEEEEEEEEEEEEEEEEEEEE
diff --git a/...ules/registry-develop/pages/registry-admin/admin-portal/error-non-critical.adoc b/...ules/registry-develop/pages/registry-admin/admin-portal/error-non-critical.adoc
@@ -1,15 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Зв'язок зі службою підтримки під час виникнення некритичних помилок
 = Contacting support for non-critical errors
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
+
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //При виникненні _некритичних помилок, тобто таких, що не впливають на рендеринг вебсторінок_, користувачам +++<b style="font-weight: 600">Кабінетів посадової особи</b>+++, +++<b style="font-weight: 600">отримувача послуг</b>+++ та +++<b style="font-weight: 600">адміністратора регламентів</b>+++ надається можливість швидко та просто звернутися до служби підтримки. Удосконалений механізм сповіщення про помилки автоматично забезпечує детальний опис проблеми у спливному вікні.
 In the event of _non-critical errors that do not impact the rendering of web pages_, users of the *Officer portals*, *Citizen portals*, and *regulations administrators* are provided with a quick and easy way to reach out to the support team. An enhanced error notification mechanism automatically provides a detailed description of the issue in a pop-up window.

diff --git a/docs/en/modules/registry-develop/partials/nav.adoc b/docs/en/modules/registry-develop/partials/nav.adoc
@@ -210,7 +210,7 @@
 ******* xref:registry-develop:bp-modeling/bp/element-templates/service-task-templates/define-bp-status.adoc[]
 ***** xref:registry-develop:bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc[]
 ****** xref:registry-develop:bp-modeling/bp/element-templates/call-activities/call-activity.adoc[]
-****** xref:bp-modeling/bp/element-templates/call-activities/check-excerpt-status.adoc[]
+****** xref:registry-develop:bp-modeling/bp/element-templates/call-activities/check-excerpt-status.adoc[]
 ***** xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[]
 ****** xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/start-bp-another-registry.adoc[]
 ****** xref:registry-develop:bp-modeling/bp/element-templates/rest-integration-registries/search-for-entities-another-registry.adoc[]

diff --git a/docs/en/modules/user/pages/alerting-popups.adoc b/docs/en/modules/user/pages/alerting-popups.adoc
@@ -1,15 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Системні попереджувальні вікна для підтвердження дій у Кабінетах користувачів
-= System warning windows for action confirmation in User portals
+= Alerting pop-up windows for action confirmation in User portals
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
+
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //У Кабінетах посадової особи та отримувача послуг було додано нову функціональність, що надійно запобігає втраті введених даних без їх збереження. Тепер, якщо користувач натискає кнопки, які не мають навігаційної функції, або переходить за посиланням на сторінці редагування форми, в разі наявності незбережених даних, з'являється спеціальне системнеfootnote:fff[Спливні вікна (_англ._ -- *pop-up windows*) можуть бути такі, що конфігуруються у регламенті на кнопках навігації у компоненті *Button* та системні. Системні налаштувати не можна.] попередження у вигляді вікна (поп-ап), яке запитує користувача про підтвердження дій.
 New functionality has been added to the Citizen and Officer portals, which reliably prevents the loss of entered data without saving. Now, when a user clicks on buttons that do not have a navigation function or follows a link on the form editing page, a special system warningfootnote:fff[Floating windows (pop-up windows) can be both configured in the regulation on the navigation buttons within the *Button* component and system-wide. However, system-wide windows are not adjustable.] in the form of a pop-up window appears if there is unsaved data, asking the user to confirm the action.

diff --git a/...pages/upload-multiple-files-p7s-asic.adoc → ...files/upload-multiple-files-p7s-asic.adoc b/...pages/upload-multiple-files-p7s-asic.adoc → ...files/upload-multiple-files-p7s-asic.adoc
@@ -1,18 +1,9 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Завантаження файлів формату p7s та asics у Кабінетах Користувачів
 = Uploading files in _.p7s_ and _.asics_ format in User portals
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//== Загальний опис
-== General overview
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
+
+== Overview
 
 //Платформа надає можливість завантажувати файли різних форматів до фабрики даних на формах Кабінетів користувачів. Користувачі можуть завантажити як одиничні файли, так і масив файлів визначених форматів.
 The Platform provides the capability to upload files of various formats to the data factory through user cabinet forms. Users can upload individual files or an array of files in specific formats.

diff --git a/docs/en/modules/user/pages/citizen-officer-portal-auth.adoc b/docs/en/modules/user/pages/citizen-officer-portal-auth.adoc
@@ -1,18 +1,9 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Автентифікація користувачів реєстру
 = Registry user authentication
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//== Загальний опис
-== General overview
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
+
+== Overview
 
 //Платформа реалізує складні механізми автентифікації кінцевих користувачів, які забезпечують належний захист даних та нівелюють можливість несанкціонованого доступу до інформації.
 The Platform implements sophisticated mechanisms for authenticating end-users, ensuring proper data protection, and mitigating unauthorized access to information.

diff --git a/docs/en/modules/user/pages/citizen/citizen-get-excerpts.adoc b/docs/en/modules/user/pages/citizen/citizen-get-excerpts.adoc
@@ -1,16 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
+= Generating excerpts in PDF format
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//= Формування витягів у Кабінеті отримувача послуг
-= Forming document excerpts in Citizen portal
-//TODO: Still not sure what is the best way to translate витяг. Is it excerpt, extract, or some other word?
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //Функціональністю Кабінету отримувача послуг передбачена можливість замовлення та отримання витягів на підставі даних реєстру. Процес включає декілька етапів: попереднє замовлення, завантаження та перегляд.
 The functionality of the Citizen portal includes the possibility to request and receive excerpt based on registry data. The process consists of several steps: pre-ordering, downloading, and viewing.

diff --git a/docs/en/modules/user/pages/citizen/citizen-portal-overview.adoc b/docs/en/modules/user/pages/citizen/citizen-portal-overview.adoc
@@ -1,13 +1,3 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
 = Citizen portal overview
 include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 

diff --git a/...user/pages/citizen/sorting-pagination/citizen-portal-bp-sorting-pagination.adoc b/...user/pages/citizen/sorting-pagination/citizen-portal-bp-sorting-pagination.adoc
@@ -1,17 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
+= Paginating and sorting services in the Citizen portal
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//= Пагінація та сортування послуг у Кабінеті отримувача послуг
-= Pagination and sorting of services in Citizen portal
-
-:sectanchors:
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //З метою розширення можливостей інтерфейсу Кабінету отримувача послуг, а також сприянню використовності, розроблено підтримку функціональності сортування та пагінаціїfootnote:[Пагінація -- це розбивка величезного масиву даних (зазвичай однотипного) на невеликі за обсягом сторінки, із відображенням нумерованої навігації.] послуг.
 To expand the interface capabilities of the Citizen portal and enhance its usability, support for paginationfootnote:[Pagination is the breakdown of a vast amount of data (usually of the same type) into small page-sized portions, accompanied by displaying numbered navigation.] and sorting functionality for services has been developed.

diff --git a/docs/en/modules/user/pages/citizen/user-notifications/email-otp.adoc b/docs/en/modules/user/pages/citizen/user-notifications/email-otp.adoc
@@ -1,15 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Підтвердження електронної адреси за допомогою OTP-коду у профілі користувача
 = Confirming email address with OTP code in user profile
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
+
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //Інструкція показує функціональність відправлення повідомлень з OTP-кодом на електронну пошту користувачам, а також підтвердження електронної пошти у профілі Кабінету отримувача послуг.
 This guide demonstrates the functionality of sending OTP codes to users' email addresses and confirming the email in the Citizen portal.

diff --git a/docs/en/modules/user/pages/citizen/user-notifications/inbox-notifications.adoc b/docs/en/modules/user/pages/citizen/user-notifications/inbox-notifications.adoc
@@ -1,15 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Відправлення inbox-повідомлень користувачам
 = Sending inbox messages to users
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
+
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //Інструкція показує можливості відправлення _inbox_-повідомлень користувачам у Кабінеті отримувача послуг. Для того, щоб налаштувати відправлення повідомлень, необхідно пройти один з доступних бізнес-процесів.
 This guidance demonstrate the capabilities of sending _inbox_ messages to users in the User portals for service recipients. To configure the sending of messages, it is necessary to go through one of the available business processes.

diff --git a/.../modules/user/pages/citizen/user-notifications/user-notifications-overview.adoc b/.../modules/user/pages/citizen/user-notifications/user-notifications-overview.adoc
@@ -1,16 +1,14 @@
-//= Відправлення повідомлень користувачам
+:sectlinks:
+:sectanchors:
 = Sending messages to users
 
-//Платформа дозволяє налаштовувати відправлення повідомлень у Кабінеті отримувача послуг через канали зв'язку `inbox`, `email` та `diia`.
-The platform allows configuring the sending of messages in the User portals through communication channels such as inbox and email.
-//TODO: didn't mention diia in the translation above since it is UA-specific.
+The platform allows configuring the sending of messages in the User portals through communication channels such as `inbox` and `email`.
 
-//== Огляд секції
 == Section overview
 
 * xref:citizen/user-notifications/inbox-notifications.adoc[]
 
-* xref:citizen/user-notifications/diia-push-otp.adoc[]
+//* xref:citizen/user-notifications/diia-push-otp.adoc[]
 
 * xref:citizen/user-notifications/email-otp.adoc[]
 
diff --git a/docs/en/modules/user/pages/error-email-support.adoc b/docs/en/modules/user/pages/error-email-support.adoc
@@ -1,15 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
+= Contacting support for critical errors
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//= Зв'язок зі службою підтримки під час виникнення критичних помилок
-= Contacting support in case of critical errors
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //При виконанні бізнес-процесів можуть виникати внутрішні помилки, які пов'язані з: життєздатністю компонентів платформи, інтеграцією із зовнішніми системами, помилками при моделюванні бізнес-процесу, налаштуваннями дозволів та ін.
 During the execution of business processes, internal errors may occur, which can be related to the platform's components' viability, integration with external systems, errors in business process modeling, or permission settings, among others.

diff --git a/docs/en/modules/user/pages/officer/overview.adoc b/docs/en/modules/user/pages/officer/overview.adoc
@@ -1,7 +1,7 @@
-//= Сортування та пагінація
+:sectanchors:
+:sectlinks:
 = Sorting and pagination
 
-//== Огляд секції
 == Section overview
 
 * xref:officer/sorting-pagination/officer-portal-task-sorting-pagination.adoc[]

diff --git a/docs/en/modules/user/pages/officer/reports/overview.adoc b/docs/en/modules/user/pages/officer/reports/overview.adoc
@@ -1,5 +1,9 @@
+:sectlinks:
+:sectanchors:
 = Generating excerpts
 
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
+
 == Section overview
 
 * xref:user:officer/reports/reports-docx.adoc[]

diff --git a/docs/en/modules/user/pages/officer/reports/reports-csv.adoc b/docs/en/modules/user/pages/officer/reports/reports-csv.adoc
@@ -1,16 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
+= Generating excerpts in CSV format
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//= Формування витягів-звітів у форматі CSV
-= Generating reports in CSV format
-//TODO: витягів-звітів іs reports, correct?
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //Функціональністю Кабінету посадової особи передбачена можливість формування та отримання витягів-звітів у форматі _.csv_ на підставі даних реєстру. Процес включає декілька етапів: попереднє замовлення, завантаження та перегляд.
 The functionality of the Officer portal includes the ability to generate and obtain reports excerpts in the _.csv_ format based on registry data. The process involves several stages: pre-ordering, downloading, and viewing.

diff --git a/docs/en/modules/user/pages/officer/reports/reports-docx.adoc b/docs/en/modules/user/pages/officer/reports/reports-docx.adoc
@@ -1,16 +1,7 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
+= Generating excerpts in DOCX format
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
 
-//= Формування проєктів наказів у форматі DOCX
-= Generating draft orders in DOCX format
-//TODO: проєктів наказів - draft orders, is that correct?
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //Функціональністю Кабінету посадової особи передбачена можливість формування та отримання проєктів наказів (витягів) у форматі _.docx_ на підставі даних реєстру. Процес включає декілька етапів: попереднє замовлення, завантаження та перегляд.
 The functionality of the Officer portal includes the ability to generate and obtain draft orders (excerpts) in _.docx_ format based on registry data. The process involves several stages: pre-ordering, downloading, and viewing.

diff --git a/.../user/pages/officer/sorting-pagination/officer-portal-bp-sorting-by-status.adoc b/.../user/pages/officer/sorting-pagination/officer-portal-bp-sorting-by-status.adoc
@@ -1,18 +1,10 @@
-:toc-title: On this page:
-:toc: auto
-:toclevels: 5
-:experimental:
-:sectnums:
-:sectnumlevels: 5
-:sectanchors:
-:sectlinks:
-:partnums:
-
-//= Сортування послуг за статусом виконання у Кабінеті посадової особи
-= Sorting of services by execution status in the Officer portal
+= Sorting services by execution status in the Officer portal
+include::platform:ROOT:partial$templates/document-attributes/default-set-en.adoc[]
+
+include::platform:ROOT:partial$admonitions/language-en.adoc[]
 
 //З метою розширення можливостей інтерфейсу Кабінету посадової особи, а також сприянню використовності, розроблено підтримку функціональності сортування власних послуг у виконанні за статусом.
-To expandi the capabilities of the Officer portal's interface and enhance usability, support for sorting functionality by execution status has been developed.
+To expand the capabilities of the Officer portal's interface and enhance usability, support for sorting functionality by execution status has been developed.
 
 //Функціональність надає можливість [.underline]#сортувати ініційовані посадовою особою бізнес-процеси у виконанні за їх статусом з прив'язкою до дати й чау їх старту#.
 This functionality allows [.underline]#sorting of business processes initiated by the officer in execution based on their status, with reference to the date and time of their start#.