From 83bf42ed570fe836c9c9283e8b849d9b27ae139d Mon Sep 17 00:00:00 2001
From: IRBorisov <8611739+IRBorisov@users.noreply.github.com>
Date: Tue, 12 Mar 2024 13:47:19 +0300
Subject: [PATCH] Add Versioning help

---
 .vscode/settings.json                         |  1 +
 .../src/components/Help/HelpVersions.tsx      | 13 ++++++
 .../frontend/src/components/InfoTopic.tsx     |  2 +
 ...ePartialUpdate.tsx => usePartialUpdate.ts} |  0
 .../frontend/src/models/miscellaneous.ts      |  1 +
 .../RSFormPage/EditorRSForm/FormRSForm.tsx    | 41 +++++++++++--------
 rsconcept/frontend/src/utils/labels.ts        |  2 +
 7 files changed, 42 insertions(+), 18 deletions(-)
 create mode 100644 rsconcept/frontend/src/components/Help/HelpVersions.tsx
 rename rsconcept/frontend/src/hooks/{usePartialUpdate.tsx => usePartialUpdate.ts} (100%)

diff --git a/.vscode/settings.json b/.vscode/settings.json
index 12e2cfcf..4d20f1e9 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -127,6 +127,7 @@
     "Wordforms",
     "Булеан",
     "Бурбаки",
+    "Версионирование",
     "Десинглетон",
     "компаратив",
     "конституент",
diff --git a/rsconcept/frontend/src/components/Help/HelpVersions.tsx b/rsconcept/frontend/src/components/Help/HelpVersions.tsx
new file mode 100644
index 00000000..4cf27634
--- /dev/null
+++ b/rsconcept/frontend/src/components/Help/HelpVersions.tsx
@@ -0,0 +1,13 @@
+function HelpVersions() {
+  // prettier-ignore
+  return (
+  <div>
+    <h1>Версионирование схем</h1>
+    <p>Версионирование позволяет сохранить текущее состояние схемы под определенным именем (версией) и использовать ссылку на него для совместной работы. После создания версии ее содержание изменить нельзя</p>
+    <p><b>Владелец</b> обладает правом редактирования названий и создания новых версий</p>
+    <p>Управление версиями происходит в Карточке схемы</p>
+    <p>Для получения ссылки на конкретную версию необходимо выбрать ее в карточке и воспользоваться кнопкой Поделиться</p>
+  </div>);
+}
+
+export default HelpVersions;
diff --git a/rsconcept/frontend/src/components/InfoTopic.tsx b/rsconcept/frontend/src/components/InfoTopic.tsx
index 8bfc360c..1e47fa51 100644
--- a/rsconcept/frontend/src/components/InfoTopic.tsx
+++ b/rsconcept/frontend/src/components/InfoTopic.tsx
@@ -12,6 +12,7 @@ import HelpRSLang from './Help/HelpRSLang';
 import HelpRSTemplates from './Help/HelpRSTemplates';
 import HelpTermGraph from './Help/HelpTermGraph';
 import HelpTerminologyControl from './Help/HelpTerminologyControl';
+import HelpVersions from './Help/HelpVersions';
 
 interface InfoTopicProps {
   topic: HelpTopic;
@@ -27,6 +28,7 @@ function InfoTopic({ topic }: InfoTopicProps) {
   if (topic === HelpTopic.RSTEMPLATES) return <HelpRSTemplates />;
   if (topic === HelpTopic.RSLANG) return <HelpRSLang />;
   if (topic === HelpTopic.TERM_CONTROL) return <HelpTerminologyControl />;
+  if (topic === HelpTopic.VERSIONS) return <HelpVersions />;
   if (topic === HelpTopic.EXTEOR) return <HelpExteor />;
   if (topic === HelpTopic.API) return <HelpAPI />;
   if (topic === HelpTopic.PRIVACY) return <HelpPrivacy />;
diff --git a/rsconcept/frontend/src/hooks/usePartialUpdate.tsx b/rsconcept/frontend/src/hooks/usePartialUpdate.ts
similarity index 100%
rename from rsconcept/frontend/src/hooks/usePartialUpdate.tsx
rename to rsconcept/frontend/src/hooks/usePartialUpdate.ts
diff --git a/rsconcept/frontend/src/models/miscellaneous.ts b/rsconcept/frontend/src/models/miscellaneous.ts
index 9f2df84e..faa09877 100644
--- a/rsconcept/frontend/src/models/miscellaneous.ts
+++ b/rsconcept/frontend/src/models/miscellaneous.ts
@@ -41,6 +41,7 @@ export enum HelpTopic {
   RSTEMPLATES = 'rstemplates',
   RSLANG = 'rslang',
   TERM_CONTROL = 'terminology-control',
+  VERSIONS = 'versions',
   EXTEOR = 'exteor',
   API = 'api',
   PRIVACY = 'privacy'
diff --git a/rsconcept/frontend/src/pages/RSFormPage/EditorRSForm/FormRSForm.tsx b/rsconcept/frontend/src/pages/RSFormPage/EditorRSForm/FormRSForm.tsx
index 387b3723..d8f01e64 100644
--- a/rsconcept/frontend/src/pages/RSFormPage/EditorRSForm/FormRSForm.tsx
+++ b/rsconcept/frontend/src/pages/RSFormPage/EditorRSForm/FormRSForm.tsx
@@ -6,6 +6,7 @@ import { FiSave } from 'react-icons/fi';
 import { LuGitBranchPlus, LuPencilLine } from 'react-icons/lu';
 import { toast } from 'react-toastify';
 
+import HelpButton from '@/components/Help/HelpButton';
 import Checkbox from '@/components/ui/Checkbox';
 import Label from '@/components/ui/Label';
 import MiniButton from '@/components/ui/MiniButton';
@@ -17,6 +18,7 @@ import VersionSelector from '@/components/VersionSelector';
 import { useAuth } from '@/context/AuthContext';
 import { useRSForm } from '@/context/RSFormContext';
 import { LibraryItemType } from '@/models/library';
+import { HelpTopic } from '@/models/miscellaneous';
 import { IRSFormCreateData } from '@/models/rsform';
 import { classnames, limits, patterns } from '@/utils/constants';
 
@@ -117,24 +119,27 @@ function FormRSForm({ id, isModified, setIsModified }: FormRSFormProps) {
           onChange={event => setAlias(event.target.value)}
         />
         <div className='flex flex-col'>
-          {controller.isMutable || controller.isProcessing ? (
-            <Overlay position='top-[-0.25rem] right-[-0.25rem] flex'>
-              <MiniButton
-                noHover
-                title={controller.isContentEditable ? 'Создать версию' : 'Переключитесь на актуальную версию'}
-                disabled={!controller.isContentEditable}
-                onClick={controller.createVersion}
-                icon={<LuGitBranchPlus size='1.25rem' className='icon-green' />}
-              />
-              <MiniButton
-                noHover
-                title='Редактировать версии'
-                disabled={!schema || schema?.versions.length === 0}
-                onClick={controller.editVersions}
-                icon={<LuPencilLine size='1.25rem' className='icon-primary' />}
-              />
-            </Overlay>
-          ) : null}
+          <Overlay position='top-[-0.25rem] right-[-0.25rem] flex'>
+            {controller.isMutable || controller.isProcessing ? (
+              <>
+                <MiniButton
+                  noHover
+                  title={controller.isContentEditable ? 'Создать версию' : 'Переключитесь на актуальную версию'}
+                  disabled={!controller.isContentEditable}
+                  onClick={controller.createVersion}
+                  icon={<LuGitBranchPlus size='1.25rem' className='icon-green' />}
+                />
+                <MiniButton
+                  noHover
+                  title='Редактировать версии'
+                  disabled={!schema || schema?.versions.length === 0}
+                  onClick={controller.editVersions}
+                  icon={<LuPencilLine size='1.25rem' className='icon-primary' />}
+                />
+              </>
+            ) : null}
+            <HelpButton topic={HelpTopic.VERSIONS} className='max-w-[30rem]' offset={4} />
+          </Overlay>
           <Label text='Версия' className='mb-2' />
           <VersionSelector
             value={schema?.version} // prettier: split lines
diff --git a/rsconcept/frontend/src/utils/labels.ts b/rsconcept/frontend/src/utils/labels.ts
index ff5b4ff6..03f472a3 100644
--- a/rsconcept/frontend/src/utils/labels.ts
+++ b/rsconcept/frontend/src/utils/labels.ts
@@ -345,6 +345,7 @@ export function labelHelpTopic(topic: HelpTopic): string {
     case HelpTopic.RSTEMPLATES:   return '- Банк выражений';
     case HelpTopic.RSLANG:        return 'Экспликация';
     case HelpTopic.TERM_CONTROL:  return 'Терминологизация';
+    case HelpTopic.VERSIONS:      return 'Версионирование';
     case HelpTopic.EXTEOR:        return 'Экстеор';
     case HelpTopic.API:           return 'REST API';
     case HelpTopic.PRIVACY:       return 'Конфиденциальность';
@@ -366,6 +367,7 @@ export function describeHelpTopic(topic: HelpTopic): string {
     case HelpTopic.RSTEMPLATES:   return 'Описание работы с Банком выражений>';
     case HelpTopic.RSLANG:        return 'Справка по языку родов структур и экспликации';
     case HelpTopic.TERM_CONTROL:  return 'Справка по контролю терминов и текстовым отсылкам';
+    case HelpTopic.VERSIONS:      return 'Справка по управлению версиями схем';
     case HelpTopic.EXTEOR:        return 'Справка по программе для экспликации "Экстеор" для Windows';
     case HelpTopic.API:           return 'Описание интерфейса для разработчиков';
     case HelpTopic.PRIVACY:       return 'Политика обработки персональных данных';